SCAYT parameters for CKEditor 4
Here you can find a list of all available SCAYT parameters for CKEditor 4.0+ that can be used for the SCAYT configuration. For more details, refer to CKEDITOR configuration documentation.
scayt_autoStartup (boolean)
Turns SCAYT on/off automatically after the editor loads.
Values: true, false
Default: true
Example:
config.scayt_autoStartup = true;grayt_autoStartup (boolean)
Automatically turns Grammar As You Type (GRAYT) on/off once SCAYT has started.
Values: true, false
Default: true
Example:
config.grayt_autoStartup = false;grayt_autoStartup
Description:
grayt_autoStartup parameter turns Grammar As You Type (GRAYT) on/off automatically once SCAYT has started.
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
Example:
config.grayt_autoStartup = false;scayt_inlineModeImmediateMarkup
Description:
scayt_inlineModeImmediateMarkup parameter turns the SCAYT initiation on/off when Inline CKEditor is not focused. The SCAYT markup is taken place (SCAYT instance is not destroyed) in both Inline CKEditor's states, focused and unfocused.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Example:
scayt_maxSuggestions
Description:
scayt_maxSuggestions parameter defines the number of SCAYT suggestions to show in the main context menu.
Parameter type:
Number
Default value:
3
Possible values:
0 (zero) – No suggestions are shown in the main context menu. All suggestions will be shown in the “More Suggestions” sub-menu.
positive number – The max number of suggestions to show in the main context menu. Other entries will be listed in “More Suggestions”.
negative number
Example:
scayt_minWordLength
Description:
scayt_minWordLength parameter defines the minimum length of the words that will be collected from editor's text for spell checking.
Parameter type:
Number
Default value:
3
Possible values:
any positive number
Example:
scayt_customerId
Description:
scayt_customerId parameter sets a customer ID for Cloud SCAYT. It is required for migration from free, ad-supported version to paid, ad-free version.
scayt_customerId is intended for use only with the Cloud version of SCAYT.
Parameter type:
String
Default value:
The free version of SCAYT plugin is shipped with already predefined service ID value.
Possible values:
your-service-id
Example:
scayt_ignoreAllCapsWords
Description:
scayt_ignoreAllCapsWords parameter regulates whether all capitalized words should be ignored.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Example:
scayt_ignoreDomainNames
Description:
scayt_ignoreDomainNames parameter regulates whether domain names and web addresses should be ignored.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Example:
scayt_ignoreWordsWithMixedCases
Description:
scayt_ignoreWordsWithMixedCases parameter regulates whether words with mixed case letters should be ignored.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Example:
scayt_ignoreWordsWithNumbers
Description:
scayt_ignoreWordsWithNumbers parameter regulates whether words containing numbers should be ignored.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Example:
scayt_disableOptionsStorage
Description:
scayt_disableOptionsStorage parameter defines whether SCAYT options storing should be disabled. It is allowed to pass an array of options.
Parameter type:
Array
Default value:
' '
Possible values:
' '
scayt_ignoreAllCapsWords
scayt_ignoreDomainNames
scayt_ignoreWordsWithMixedCases
scayt_ignoreWordsWithNumbers
lang
Example:
scayt_moreSuggestions
Description:
scayt_moreSuggestions parameter enables/disables the “More Suggestions” sub-menu in the context menu.
Parameter type:
String
Default value:
on
Possible values:
on, off
Example:
scayt_contextCommands
Description:
scayt_contextCommands parameter manages and customizes the SCAYT context menu commands: Add Word, Ignore All, Options, Languages, Dictionaries and About. It is allowed to pass more than one value separating each value with a vertical bar.
Options, Languages and Dictionaries items can be added to the SCAYT context menu only if these items are present on the SCAYT settings dialog. The visibility of these items are regulated by the scayt_uiTabs parameter.
Parameter type:
Array
Default value:
ignore|ignoreall|add
Possible values:
ignoreall
Example:
scayt_sLang
Description:
scayt_sLang parameter sets a language short code of the default language that will be used for spell checking.
Parameter type:
String
Default value:
en_US (American English)
Possible values:
Example:
scayt_uiTabs
Description:
scayt_uiTabs parameter customizes the SCAYT settings dialog and manages visibility of particular tabs there such as Options, Languages, and Dictionaries.
By default, SCAYT settings dialog contains four tabs, namely Options, Languages, Dictionaries, and About. The About tab is used to provide the information about the SCAYT version and copyrights. Unlike Options, Languages, Dictionaries tabs, it can't be removed.
Parameter type:
Array
Default value:
1,1,1
Possible values:
0,0,0 – Hide all customizable tabs: Options, Languages, and Dictionaries.
0,1,0 – Hide the Options and Dictionaries tabs.
0,0,1 – Hide the Options and Languages tabs.
1,1,0 – Hide the Dictionaries tab.
1,0,1 – Hide the Language tab.
1,1,1 – Show all tabs: Options, Languages, and Dictionaries.
Example:
scayt_serviceProtocol
Description:
scayt_serviceProtocol parameter specifies a protocol to access the SCAYT service. If this parameter is not specified, the protocol will be automatically defined based on the script location.
This is the parameter that intended for us with the Server version only.
Parameter type:
String
Default value:
https
Possible values:
http
https
Example:
scayt_serviceHost
Description:
scayt_serviceHost parameter specifies a service host name to access the SCAYT service. If this parameter is not specified clearly, the service host will be automatically defined based on the script location.
The SCAYT plugin which is shipped with the default CKEditor packages is pointed to the WebSpellChecker Cloud services. scayt_serviceHost is already predefined in the plugin configuration.
If you are using the Server version, you need to specify the host name that you used during the installation of WebSpellChecker.
Parameter type:
String
Default value:
Possible values:
svc.webspellchecker.net – The default WebSpellChecker service host name. It is used for the WebSpellChecker Cloud services subscriptions.
your_host_name
Example:
scayt_servicePort
Description:
scayt_servicePort parameter specifies a service port that will be used to access the SCAYT service.
This is the parameter that intended for us with the Server version only.
Parameter type:
String
Default value:
80
Possible values:
Any available port.
2880 – default port that listens WebSpellChecker AppServer. Use this port if your are using the Server version.
Example:
scayt_servicePath
Description:
scayt_servicePath parameter specifies a path that will be used to access the SCAYT service.
Parameter type:
String
Default value:
/virtual_directory/script/ssrv.fcgi
Possible values:
Path to the ssrv.fcgi script. Use this if you are using the older versions of WebSpellChecker v4.x and the connection between your app and AppServer is confogured via FastCGI protocol (using SSRV.cgi component).
Use '/' if you are using the newer versions of WebSpellChecker v5.x. and you configured the direct connetion with AppServer. In this case also use config.scayt_servicePort ='2880';.
Example:
Or
scayt_srcUrl
Description:
scayt_srcUrl parameter specifies a URL to the SCAYT core.
scayt_srcUrl is intended for use only with the Server version of SCAYT.
Parameter type:
String
Default value:
http(s)://your_host_name/virtual_directory/wscbundle/wscbundle.js
Possible values:
http(s)://your_host_name/virtual_directory/wscbundle/wscbundle.js
http(s)://your_host_name/virtual_directory/lf/scayt3/ckscayt/ckscayt.js
Example:
scayt_customDictionaryIds
Description:
scayt_customDictionaryIds parameter specifies a custom dictionary ID that will be linked with SCAYT.
Parameter type:
String
Default value:
None
Possible values:
IDs of custom dictionaries.
Example:
scayt_userDictionaryName
Description:
scayt_userDictionaryName parameter predefines a specific user dictionary that will be used with SCAYT.
Parameter type:
String
Default value:
None
Possible values:
Any name of a user dictionary.
Example:
scayt_contextMenuItemsOrder
Description:
scayt_contextMenuItemsOrder parameter defines the order of SCAYT context menu items by groups. This must be a string with one or more of the following words separated by a pipe character ('|').
Parameter type:
String
Default value:
suggest|moresuggest|control
Possible values:
suggest – main suggestion word list;
moresuggest – more suggestions word list;
control – SCAYT commands, such as “Ignore” and “Add Word”.
Example:
scayt_elementsToIgnore
Description:
scayt_elementsToIgnore parameter defines HTML tags that will be ignored during check spelling.
Parameter type:
String
Default value:
'style'
Possible values:
Any HTML tag
Example:
scayt_multiLanguageMode
DEPRECATED | WSC 5.3.2
Description:
scayt_multiLanguageMode parameter turns on/off a special multi-language support mode.
scayt_multiLanguageMode parameter was specifically designed to work with a certain language plugin for CKEditor. Before using this parameter, CKEditor Language plugin must be added.
Parameter type:
Boolean
Default value:
false
Possible values:
true – multi-language support turns on after the editor loading.
false
Example:
scayt_multiLanguageStyles
DEPRECATED | WSC 5.3.2
Description:
scayt_multiLanguageStyles parameter allows defining additional styles for misspelled words specific for a particular language.
scayt_multiLanguageStyles can be used only if the scayt_multiLanguageMode parameter is set to “true”.
Parameter type:
Object
Default value:
None
Possible values:
{ 'Language_short_code': 'background-image: none; color: #cc22cc', 'el': 'background-image: none; color: blue', 'nl': 'background-image: none; color: red', 'fi': 'background-image: none; color: indigo', 'fr': 'background-image: none; color: orange', 'de': 'background-image: none; color: green' };
All short codes should be presented according ISO 639-1:2002 codes.
Example:
Last updated
Was this helpful?