WebSpellChecker.net Wiki

The SCAYT parameters for CKEditor 4


# Parameter Description Initialization example
1 scayt_autoStartup The parameter turns SpellCheckAsYouType (SCAYT) on/off on the autostartup. If 'true', it turns on SCAYT automatically after loading the editor.
Default value : [scayt_autoStartup=false]
config.scayt_autoStartup = true;
2 grayt_autoStartup The parameter turns Grammar As You Type (GRAYT) on/off on the SCAYT startup. If 'true', it turns on GRAYT automatically once SCAYT has started.
Default value : [grayt_autoStartup=false]
config.grayt_autoStartup = true;
3 scayt_inlineModeImmediateMarkup The parameter turns 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.
Default value : [scayt_inlineModeImmediateMarkup=false]
config.scayt_inlineModeImmediateMarkup = true;
4 scayt_maxSuggestions The parameter defines the number of SCAYT suggestions to show in the main context menu. Possible values are: '0' (zero) – No suggestions are shown in the main context menu. All entries will be listed in the “More Suggestions” sub-menu. A positive number – The maximum number of suggestions to show in the context menu. Other entries will be shown in the “More Suggestions” sub-menu. A negative number – 5 suggestions are shown in the main context menu. All other entries will be listed in the “More Suggestions” sub-menu.
Default value : [scayt_maxSuggestions=5]
Do not show the suggestions directly: [config.scayt_maxSuggestions = 0;]
config.scayt_maxSuggestions = 3;
5 scayt_minWordLength The parameter defines the minimum length of the words that will be collected from editor's text for spell checking. Possible value is any positive number.
Default value : [scayt_minWordLength=4]
config.scayt_minWordLength = 5;
6 scayt_customerId The parameter sets the customer ID for SCAYT. Required for migration from free, ad-supported version to paid, ad-free version.
Default value:
[scayt_customerId='1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2'].
config.scayt_customerId = 'your-long-encrypted-customer-id';
7 scayt_ignoreAllCapsWords The parameter sets the ignore-domain-names option to SCAYT. If 'true' it sets ignore-all-caps-words automatically on scayt init. It may be necessary to disableOptionStorage for this parameter, because optionStorage has higher priority.
Default value : [scayt_ignoreAllCapsWords=false]
Turn on ignore-all-caps-words by default.
config.scayt_ignoreAllCapsWords = true;
8 scayt_ignoreDomainNames The parameter sets the ignore-domain-names option to SCAYT. If 'true' it sets ignore-domain-names automatically on scayt init. It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.
Default value : [scayt_ignoreDomainNames=false]
config.scayt_ignoreDomainNames = true;
9 scayt_ignoreWordsWithMixedCases The parameter sets the ignore-domain-names option to SCAYT. If 'true' it sets ignore-words-with-mixed-cases automatically on scayt init. It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.
Default value : [scayt_ignoreWordsWithMixedCases=false]
config.scayt_ignoreWordsWithMixedCases = true;
10 scayt_ignoreWordsWithNumbers The parameter sets the ignore-domain-names option to SCAYT. If 'true' it sets ignore-words-with-numbers automatically on scayt init. It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.
Default value : [scayt_ignoreWordsWithNumbers=false]
config.scayt_ignoreWordsWithNumbers = true;
11 scayt_disableOptionsStorage Disable SCAYT Options storing.
Default value : [scayt_disableOptionsStorage = ' ']
To disable several options. Array for several parameters transfer:

config.scayt_disableOptionsStorage = ['lang', 'ignore-all-caps-words', 'ignore-words-with-mixed-cases']]
12 scayt_moreSuggestions The parameter enables/disables the “More Suggestions” sub-menu in the context menu. Possible values are 'on' and 'off'.
Default value : [scayt_moreSuggestions='on']
config.scayt_moreSuggestions = 'off';
13 scayt_contextCommands The parameter customizes the SCAYT context menu commands (“Add Word”, “Ignore”, “Ignore All”, “Options”, “Languages”, “Dictionaries” and “About”). Possible values: 'off', 'all' or with one or more of the following words separated by a pipe character ('|'):
'ignore|ignoreall|add|option|language|dictionary|about'.
'off' – disables all options;
'all' – enables all options;
'ignoreall' – enables the “Ignore All” option;
'add' – enables the “Add Word” option;
'option' – enables 'Options' menu item;
'language' – enables 'Languages' menu item;
'dictionary' – enables 'Dictionaries' menu item;
'about' – enables 'About' menu item.
Note that the availability of 'Options', 'Languages' and 'Dictionaries' items depends on the scayt_uiTabs option also.
Default value : [scayt_contextCommands='ignore|ignoreall|add']
Show only “Add Word” and “Ignore All” in the context menu.
config.scayt_contextCommands = 'add|ignoreall';
14 scayt_sLang The parameter sets the default spell checking language for SCAYT.
Default value : config.scayt_sLang = 'en_US';
Sets language to German:
config.scayt_sLang = 'de_DE';
15 scayt_uiTabs The parameter customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs/items.
Default value : [scayt_uiTabs='1,1,1']
Hides the “Languages” tab.
config.scayt_uiTabs = '1,0,1';
16 scayt_serviceProtocol Allows user to specify protocol for WSC service (ssrv.cgi) full path. Makes sense only when you open your page from file system. Otherwise SCAYT will try to automatically define protocol based on script location.
Default value : [scayt_serviceProtocol='http'].
config.scayt_serviceProtocol='https';
17 scayt_serviceHost Allows user to specify host for WSC service (ssrv.cgi) full path. Makes sense only when you open your page from file system. Otherwise SCAYT will try to automatically define host based on script location. config.scayt_serviceHost='my-host';
18 scayt_servicePort Allows user to specify the default port for WSC service (ssrv.cgi) full path. If SCAYT won't define the port based on script location then this value would be taken. config.scayt_servicePort='2330';
19 scayt_servicePath Allows user to specify path for WSC service (ssrv.cgi) full path. Makes sense only when you open your page from file system. Otherwise SCAYT will try to automatically define the path based on script location. config.scayt_servicePath='my-path/ssrv.cgi'
20 scayt_srcUrl The parameter sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT application. Further details available here config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt3/ckscayt/ckscayt.js";
21 scayt_customDictionaryIds The parameter links SCAYT to custom dictionaries. This is a string containing dictionary IDs separated by commas (','). Further details are available here
Default value : [scayt_customDictionaryIds=' ']
config.scayt_customDictionaryIds = '3021,3456,3478';
22 scayt_userDictionaryName The parameter activates a User Dictionary in SCAYT. The user dictionary name must be used.
Default value : [scayt_userDictionaryName=null]
config.scayt_userDictionaryName = 'MyDictionary';
23 scayt_contextMenuItemsOrder The 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' – main suggestion word list;
'moresuggest' – more suggestions word list;
'control' – SCAYT commands, such as “Ignore” and “Add Word”.
Default value :
[scayt_contextMenuItemsOrder='suggest|moresuggest|control']
config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';
24 scayt_elementsToIgnore Specifies the names of tags that will be skipped while spell checking. It is a string containing tag names separated by commas (','). Please note that 'style' tag would be added to specified tags list. config.scayt_elementsToIgnore = 'del,pre';
25 scayt_multiLanguageMode The parameter turns multi language support on/off in SCAYT. If 'true', turns on SCAYT multi language support after loading the editor.
Default value : [scayt_multiLanguageMode=false]
scayt_multiLanguageMode=true;
26 scayt_multiLanguageStyles Defines additional styles for misspellings for specified languages. Styles will be applied only if 'scayt_multiLanguageMode' parameter is set to 'true' and 'language' plugin is included and loaded into editor.
All misspellings will be still underlined with red waveline by default.
Display misspellings in French language with green color and underlined with a red waveline by default. config.scayt_multiLanguageStyles = {
'fr': 'color: green'
};
Display misspellings in Italian language in green color and underlined with red waveline and German misspellings in red color only. config.scayt_multiLanguageStyles = {
'it': 'color: green',
'de': 'background-image: none; color: red'
};