Page History
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
scayt_autoStartup
Description: | scayt_autoStartup parameter turns SCAYT on/off automatically after the editor loading. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_autoStartup = true; |
grayt_autoStartup
Description: | grayt_autoStartup parameter turns Grammar As You Type (GRAYT) on/off automatically once SCAYT has started. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.grayt_autoStartup = true; |
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: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_inlineModeImmediateMarkup = true; |
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: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_maxSuggestions = 3; |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_minWordLength = 2; |
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.
| ||
Parameter type: | String | ||
Default value: | The free version of SCAYT plugin is shipped with already predefined encrypted customer ID value. | ||
Possible values: | encrypted-customer-id |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_customerId = 'encrypted-customer-id'; |
scayt_ignoreAllCapsWords
Description: | scayt_ignoreAllCapsWords parameter regulates whether all capitalized words should be ignored. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreAllCapsWords = true; |
scayt_ignoreDomainNames
Description: | scayt_ignoreDomainNames parameter regulates whether domain names and web addresses should be ignored. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreDomainNames = true; |
scayt_ignoreWordsWithMixedCases
Description: | scayt_ignoreWordsWithMixedCases parameter regulates whether words with mixed case letters should be ignored. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreWordsWithMixedCases = true; |
scayt_ignoreWordsWithNumbers
Description: | scayt_ignoreWordsWithNumbers parameter regulates whether words containing numbers should be ignored. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_ignoreWordsWithNumbers = true; |
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: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_disableOptionsStorage = ['lang', 'ignore-all-caps-words', 'ignore-words-with-mixed-cases']] |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_moreSuggestions = 'off'; |
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.
| ||
Parameter type: | Array | ||
Default value: | ignore|ignoreall|add | ||
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
//Show only the Add Word and Ignore All commands in the context menu. config.scayt_contextCommands = 'add|ignoreall'; |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
//Set the default language to German (de_DE). config.scayt_sLang = 'de_DE' |
Anchorscayt_uiTabs scayt_uiTabs
scayt_uiTabs
scayt_uiTabs | |
scayt_uiTabs |
Description: | scayt_uiTabs parameter customizes the SCAYT settings dialog and manages visibility of particular tabs there such as Options, Languages, and Dictionaries.
| ||
Parameter type: | Array | ||
Default value: | 1,1,1 | ||
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
//Hide the Languages tab. config.scayt_uiTabs = '1,0,1'; |
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. |
Parameter type: | String |
Default value: | https |
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_serviceProtocol='https'; |
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.
| ||
Parameter type: | String | ||
Default value: | |||
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_serviceHost='your_host_name'; |
scayt_servicePort
Description: | scayt_servicePort parameter specifies a service port that will be used to access the SCAYT service. |
Parameter type: | String |
Default value: | 80 |
Possible values: | Any available port. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_servicePort ='2330'; |
scayt_servicePath
Description: | scayt_servicePath parameter specifies a path that will be used to access the SCAYT service. |
Parameter type: | String |
Default value: | /spellcheck31/script/ssrv.fcgi |
Possible values: | Path to the ssrv.fcgi script. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_servicePath ='spellcheck31/script/ssrv.fcgi'; |
scayt_srcUrl
Description: | scayt_srcUrl parameter specifies a URL to the SCAYT core.
| ||
Parameter type: | String | ||
Default value: | http://svc.webspellchecker.net/spellcheck31/lf/scayt3/ckscayt/ckscayt.js | ||
Possible values: | TBD |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_srcUrl ='http(s)://your_host_name/spellcheck31/lf/scayt3/ckscayt/ckscayt.js"'; |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_customDictionaryIds='3021,3456,3478'; |
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:
Excerpt | |||||||
---|---|---|---|---|---|---|---|
|
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: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest'; |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_elementsToIgnore='del,pre''; |
Anchorscayt_multiLanguageMode scayt_multiLanguageMode
scayt_multiLanguageMode
scayt_multiLanguageMode | |
scayt_multiLanguageMode |
Description: | scayt_multiLanguageMode parameter turns on/off a special multi-language support mode.
| ||
Parameter type: | Boolean | ||
Default value: | false | ||
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_multiLanguageMode='true'; |
scayt_multiLanguageStyles
Description: | scayt_multiLanguageStyles parameter allows defining additional styles for misspelled words specific for a particular language.
| ||
Parameter type: | Object | ||
Default value: | None | ||
Possible values: |
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
config.scayt_multiLanguageStyles= {'fr': 'color: green'}; |