Versions Compared

Key

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

Anchor
top_scayt_parameters_ckeditor
top_scayt_parameters_ckeditor
Here you can find a list of all available SCAYT parameters for CKEditor 4.0+ that can be used for the SCAYT configuration. Also, you may visit CKEDITOR configuration documentation.

Expand
titleClick here to explore a full list of parameters...

Table of Contents
maxLevel3
minLevel3

scayt_autoStartup

Description:

scayt_autoStartup parameter turns SCAYT on/off automatically after the editor loading.

Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_autoStartup = true;

Back to the top...

grayt_autoStartup

Description:grayt_autoStartup parameter turns Grammar As You Type (GRAYT) on/off automatically once SCAYT has started.Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.grayt_autoStartup = true;

Back to the top...

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:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_inlineModeImmediateMarkup = true;

Back to the top...

scayt_maxSuggestions

Description:scayt_maxSuggestions parameter defines the number of SCAYT suggestions to show in the main context menu.Parameter type:NumberDefault 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:

Code Block
languagejs
themeEmacs
config.scayt_maxSuggestions = 3;

Back to the top...

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:NumberDefault value:

3

Possible values:

any positive number

Example:

Code Block
languagejs
themeEmacs
config.scayt_minWordLength = 2;

Back to the top...

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. 

Note

scayt_customerId is intended for use only with the Cloud version of SCAYT.

Parameter type:StringDefault value:

The free version of SCAYT plugin is shipped with already predefined encrypted customer ID value.

Possible values:

encrypted-customer-id

Example:

Code Block
languagejs
themeEmacs
config.scayt_customerId = 'encrypted-customer-id';

Back to the top...

scayt_ignoreAllCapsWords

Description:

scayt_ignoreAllCapsWords parameter regulates whether all capitalized words should be ignored.

Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_ignoreAllCapsWords = true;

Back to the top...

scayt_ignoreDomainNames

Description:

scayt_ignoreDomainNames parameter regulates whether domain names and web addresses should be ignored.

Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_ignoreDomainNames = true;

Back to the top...

scayt_ignoreWordsWithMixedCases

Description:

scayt_ignoreWordsWithMixedCases parameter regulates whether words with mixed case letters should be ignored.

Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_ignoreWordsWithMixedCases = true;

Back to the top...

scayt_ignoreWordsWithNumbers

Description:

scayt_ignoreWordsWithNumbers parameter regulates whether words containing numbers should be ignored.

Parameter type:BooleanDefault value:

false

Possible values:
  • true
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_ignoreWordsWithNumbers = true;

Back to the top...

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:ArrayDefault value:

' '

Possible values:
  • ' '
  • scayt_ignoreAllCapsWords
  • scayt_ignoreDomainNames
  • scayt_ignoreWordsWithMixedCases
  • scayt_ignoreWordsWithNumbers
  • lang

Example: 

Code Block
languagejs
themeEmacs
config.scayt_disableOptionsStorage = ['lang', 'ignore-all-caps-words', 'ignore-words-with-mixed-cases']]

Back to the top...

scayt_moreSuggestions

Description:

scayt_moreSuggestions parameter enables/disables the “More Suggestions” sub-menu in the context menu. 

Parameter type:StringDefault value:

on

Possible values:on, off

Example: 

Code Block
languagejs
themeEmacs
config.scayt_moreSuggestions = 'off';

Back to the top...

scayt_contextCommands


Excerpt Include
IN:_include_scayt_parameters_for_ckeditor4
IN:_include_scayt_parameters_for_ckeditor4
nopaneltrue

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.

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.

Parameter type:ArrayDefault value:

ignore|ignoreall|add

Possible values:
  • 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
languagejs
themeEmacs
//Show only the Add Word and Ignore All commands in the context menu.
config.scayt_contextCommands = 'add|ignoreall';

Back to the top...

scayt_sLang

Description:

scayt_sLang parameter sets a language short code of the default language that will be used for spell checking. 

Parameter type:StringDefault value:

en_US (American English)

Possible values:

Example: 

Code Block
languagejs
themeEmacs
//Set the default language to German (de_DE).
config.scayt_sLang = 'de_DE'

Back to the top...

Anchorscayt_uiTabsscayt_uiTabsscayt_uiTabsDescription:

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.

Parameter type:ArrayDefault 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:

Code Block
languagejs
themeEmacs
//Hide the Languages tab.
config.scayt_uiTabs = '1,0,1';

Back to the top...

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:StringDefault value:

https

Possible values:
  • http
  • https

Example:

Code Block
languagejs
themeEmacs
config.scayt_serviceProtocol='https';

Back to the top...

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.

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

Parameter type:StringDefault value:

svc.webspellchecker.net

Possible values:
  • svc.webspellchecker.net – The default WebSpellChecker service host name. It is used for the WebSpellChecker Cloud services subscriptions.
  • your_host_name

Example:

Code Block
languagejs
themeEmacs
config.scayt_serviceHost='your_host_name';

Back to the top...

scayt_servicePort

Description:

scayt_servicePort parameter specifies a service port that will be used to access the SCAYT service. 

Parameter type:StringDefault value:

80

Possible values:Any available port.

Example:

Code Block
languagejs
themeEmacs
config.scayt_servicePort ='2330';

Back to the top...

scayt_servicePath

Description:

scayt_servicePath parameter specifies a path that will be used to access the SCAYT service. 

Parameter type:StringDefault value:

/spellcheck31/script/ssrv.fcgi

Possible values:Path to the ssrv.fcgi script.

Example:

Code Block
languagejs
themeEmacs
config.scayt_servicePath ='spellcheck31/script/ssrv.fcgi';

Back to the top...

scayt_srcUrl

Description:

scayt_srcUrl parameter specifies a URL to the SCAYT core.

Note

scayt_srcUrl is intended for use only with the Server version of SCAYT.

Parameter type:StringDefault value:

http://svc.webspellchecker.net/spellcheck31/lf/scayt3/ckscayt/ckscayt.js

Possible values:TBD

Example:

Code Block
languagejs
themeEmacs
config.scayt_srcUrl ='http(s)://your_host_name/spellcheck31/lf/scayt3/ckscayt/ckscayt.js"';

Back to the top...

scayt_customDictionaryIds

Description:

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.

Parameter type:String Default value:

None

Possible values:IDs of custom dictionaries.

Example:

Code Block
languagejs
themeEmacs
config.scayt_customDictionaryIds='3021,3456,3478';

Back to the top...

scayt_userDictionaryName

Description:

scayt_userDictionaryName parameter predefines a specific user dictionary that will be used with SCAYT.

Parameter type:StringDefault value:

None

Possible values:Any name of a user dictionary.

Example:

Excerpt
Code Block
languagejs
themeEmacs
config.scayt_userDictionaryName='user_dictionary_name';

Back to the top...

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:StringDefault 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:

Code Block
languagejs
themeEmacs
config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';

Back to the top...

scayt_elementsToIgnore

Description:

scayt_elementsToIgnore parameter defines HTML tags that will be ignored during check spelling.

Parameter type:StringDefault value:

'style'

Possible values:Any HTML tag

Example:

Code Block
languagejs
themeEmacs
config.scayt_elementsToIgnore='del,pre'';

Back to the top...

Anchorscayt_multiLanguageModescayt_multiLanguageModescayt_multiLanguageModeDescription:

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.

Parameter type:BooleanDefault value:

false

Possible values:
  • true – multi-language support turns on after the editor loading.
  • false

Example:

Code Block
languagejs
themeEmacs
config.scayt_multiLanguageMode='true';

Back to the top...

scayt_multiLanguageStyles

Description:

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”.  

Parameter type:ObjectDefault 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'
};

Note

All short codes should be presented according ISO 639-1:2002 codes.

Example:

Code Block
languagejs
themeEmacs
config.scayt_multiLanguageStyles= {'fr': 'color: green'};
Back to the top...