Page History
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
scayt_autoStartup
Description:
scayt_autoStartup parameter turns SCAYT on/off automatically after the editor loading.
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_autoStartup = true; |
grayt_autoStartup
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.grayt_autoStartup = true; |
scayt_inlineModeImmediateMarkup
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_inlineModeImmediateMarkup = true; |
scayt_maxSuggestions
3
- 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:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_maxSuggestions = 3; |
scayt_minWordLength
3
any positive number
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_minWordLength = 2; |
scayt_customerId
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.
Note |
---|
scayt_customerId is intended for use only with the Cloud version of SCAYT. |
The free version of SCAYT plugin is shipped with already predefined encrypted customer ID value.
encrypted-customer-id
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_customerId = 'encrypted-customer-id';
|
scayt_ignoreAllCapsWords
scayt_ignoreAllCapsWords parameter regulates whether all capitalized words should be ignored.
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreAllCapsWords = true;
|
scayt_ignoreDomainNames
scayt_ignoreDomainNames parameter regulates whether domain names and web addresses should be ignored.
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreDomainNames = true;
|
scayt_ignoreWordsWithMixedCases
scayt_ignoreWordsWithMixedCases parameter regulates whether words with mixed case letters should be ignored.
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreWordsWithMixedCases = true;
|
scayt_ignoreWordsWithNumbers
scayt_ignoreWordsWithNumbers parameter regulates whether words containing numbers should be ignored.
false
- true
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreWordsWithNumbers = true;
|
scayt_disableOptionsStorage
scayt_disableOptionsStorage parameter defines whether SCAYT options storing should be disabled. It is allowed to pass an array of options.
' '
- ' '
- scayt_ignoreAllCapsWords
- scayt_ignoreDomainNames
- scayt_ignoreWordsWithMixedCases
- scayt_ignoreWordsWithNumbers
- lang
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_disableOptionsStorage = ['lang', 'ignore-all-caps-words', 'ignore-words-with-mixed-cases']]
|
scayt_moreSuggestions
scayt_moreSuggestions parameter enables/disables the “More Suggestions” sub-menu in the context menu.
on
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_moreSuggestions = 'off';
|
scayt_contextCommands
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
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.
Note |
---|
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. |
ignore|ignoreall|add
- ignoreall|add|option|language|dictionary|about – Show in the SCAYT context menu Ignore All, Add Word, Options, Languages, Dictionaries and About options.
- off – Do not show any additional commands in the context menu except a list of main suggestions and the More Suggestions sub-menu.
- all – Enable all available commands in the context menu.
- ignoreall – Add the Ignore All command to the context menu.
- add – Add only the Add Word command to the context menu.
- option – Add the Options item to the context menu.
- language – Add the Languages item to the context menu. It opens the Languages tab of the SCAYT settings dialog. The Languages contains the list of the available languages for spell checking and is used for setting the default spell checking language.
- dictionary – Add the Dictionaries item to the context menu. It opens the Dictionary tab of the SCAYT settings dialog. The Dictionaries tab is used for the personal user dictionary management. It allows users to create personal dictionaries with custom words (complex words, acronyms, proper names etc.) and use them while working with the system.
- about – Enable the About menu item.
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
//Show only the Add Word and Ignore All commands in the context menu.
config.scayt_contextCommands = 'add|ignoreall';
|
scayt_sLang
scayt_sLang parameter sets a language short code of the default language that will be used for spell checking.
en_US (American English)
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
//Set the default language to German (de_DE).
config.scayt_sLang = 'de_DE'
|
scayt_uiTabs parameter customizes the SCAYT settings dialog and manages visibility of particular tabs there such as Options, Languages, and Dictionaries.
Note |
---|
By default the SCAYT settings dialog contains four tabs: Options, Languages, Dictionaries and About. The About tab is used to provide the information about the SCAYT version and copyrights. Unlike Options, Languages, Dictionaries, it can't be removed. |
1,1,1
- 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:
Code Block | ||||
---|---|---|---|---|
| ||||
//Hide the Languages tab.
config.scayt_uiTabs = '1,0,1';
|
scayt_serviceProtocol
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.
https
- http
- https
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_serviceProtocol='https';
|
scayt_serviceHost
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.
Note |
---|
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. However, the server version of the WebSpellChecker application |
- svc.webspellchecker.net – The default WebSpellChecker service host name. It is used for the WebSpellChecker Cloud services subscriptions.
- your_host_name
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_serviceHost='your_host_name';
|
scayt_servicePort
scayt_servicePort parameter specifies a service port that will be used to access the SCAYT service.
80
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_servicePort ='2330';
|
scayt_servicePath
scayt_servicePath parameter specifies a path that will be used to access the SCAYT service.
/spellcheck31/script/ssrv.fcgi
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_servicePath ='spellcheck31/script/ssrv.fcgi';
|
scayt_srcUrl
scayt_srcUrl parameter specifies a URL to the SCAYT core.
Note |
---|
scayt_srcUrl is intended for use only with the Server version of SCAYT. |
http://svc.webspellchecker.net/spellcheck31/lf/scayt3/ckscayt/ckscayt.js
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_srcUrl ='http(s)://your_host_name/spellcheck31/lf/scayt3/ckscayt/ckscayt.js"';
|
scayt_customDictionaryIds
scayt_customDictionaryIds parameter specifies a custom dictionary ID that will be linked with SCAYT.
Note |
---|
scayt_customDictionaryIds parameters is intended for use only with the Server version of SCAYT. |
None
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_customDictionaryIds='3021,3456,3478';
|
scayt_userDictionaryName
scayt_userDictionaryName parameter predefines a specific user dictionary that will be used with SCAYT.
None
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_userDictionaryName='user_dictionary_name';
|
scayt_contextMenuItemsOrder
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 ('|').
suggest|moresuggest|control
- suggest – main suggestion word list;
- moresuggest – more suggestions word list;
- control – SCAYT commands, such as “Ignore” and “Add Word”.
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';
|
scayt_elementsToIgnore
scayt_elementsToIgnore parameter defines HTML tags that will be ignored during check spelling.
'style'
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_elementsToIgnore='del,pre'';
|
scayt_multiLanguageMode parameter turns on/off a special multi-language support mode.
Note |
---|
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. |
false
- true – multi-language support turns on after the editor loading.
- false
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_multiLanguageMode='true';
|
scayt_multiLanguageStyles
scayt_multiLanguageStyles parameter allows defining additional styles for misspelled words specific for a particular language.
Note |
---|
scayt_multiLanguageStyles can be used only if the scayt_multiLanguageMode parameter is set to “true”. |
None
{
'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'
};
Note |
---|
All short codes should be presented according ISO 639-1:2002 codes. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_multiLanguageStyles= {'fr': 'color: green'};
|