X-Git-Url: https://scm.cri.minesparis.psl.eu/git/ckeditor.git/blobdiff_plain/256592bf803e851aa7fc953e08a6e9e58d970f8c..871bad8291b6dbc29d489d95d185458caab25158:/skins/ckeditor/_source/plugins/scayt/plugin.js diff --git a/skins/ckeditor/_source/plugins/scayt/plugin.js b/skins/ckeditor/_source/plugins/scayt/plugin.js new file mode 100644 index 0000000..1395d6d --- /dev/null +++ b/skins/ckeditor/_source/plugins/scayt/plugin.js @@ -0,0 +1,964 @@ +/* +Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved. +For licensing, see LICENSE.html or http://ckeditor.com/license +*/ + +/** + * @fileOverview Spell Check As You Type (SCAYT). + * Button name : Scayt. + */ + +(function() +{ + var commandName = 'scaytcheck', + openPage = ''; + + // Checks if a value exists in an array + function in_array( needle, haystack ) + { + var found = 0, + key; + for ( key in haystack ) + { + if ( haystack[ key ] == needle ) + { + found = 1; + break; + } + } + return found; + } + + var onEngineLoad = function() + { + var editor = this; + + var createInstance = function() // Create new instance every time Document is created. + { + var config = editor.config; + // Initialise Scayt instance. + var oParams = {}; + // Get the iframe. + oParams.srcNodeRef = editor.document.getWindow().$.frameElement; + // syntax : AppName.AppVersion@AppRevision + oParams.assocApp = 'CKEDITOR.' + CKEDITOR.version + '@' + CKEDITOR.revision; + oParams.customerid = config.scayt_customerid || '1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2'; + oParams.customDictionaryIds = config.scayt_customDictionaryIds || ''; + oParams.userDictionaryName = config.scayt_userDictionaryName || ''; + oParams.sLang = config.scayt_sLang || 'en_US'; + + // Introduce SCAYT onLoad callback. (#5632) + oParams.onLoad = function() + { + // Draw down word marker to avoid being covered by background-color style.(#5466) + if ( !( CKEDITOR.env.ie && CKEDITOR.env.version < 8 ) ) + this.addStyle( this.selectorCss(), 'padding-bottom: 2px !important;' ); + + // Call scayt_control.focus when SCAYT loaded + // and only if editor has focus and scayt control creates at first time (#5720) + if ( editor.focusManager.hasFocus && !plugin.isControlRestored( editor ) ) + this.focus(); + + }; + + oParams.onBeforeChange = function() + { + if ( plugin.getScayt( editor ) && !editor.checkDirty() ) + setTimeout( function(){ editor.resetDirty(); }, 0 ); + }; + + var scayt_custom_params = window.scayt_custom_params; + if ( typeof scayt_custom_params == 'object' ) + { + for ( var k in scayt_custom_params ) + oParams[ k ] = scayt_custom_params[ k ]; + } + // needs for restoring a specific scayt control settings + if ( plugin.getControlId( editor ) ) + oParams.id = plugin.getControlId( editor ); + + var scayt_control = new window.scayt( oParams ); + + scayt_control.afterMarkupRemove.push( function( node ) + { + ( new CKEDITOR.dom.element( node, scayt_control.document ) ).mergeSiblings(); + } ); + + // Copy config. + var lastInstance = plugin.instances[ editor.name ]; + if ( lastInstance ) + { + scayt_control.sLang = lastInstance.sLang; + scayt_control.option( lastInstance.option() ); + scayt_control.paused = lastInstance.paused; + } + + plugin.instances[ editor.name ] = scayt_control; + + try { + scayt_control.setDisabled( plugin.isPaused( editor ) === false ); + } catch (e) {} + + editor.fire( 'showScaytState' ); + }; + + editor.on( 'contentDom', createInstance ); + editor.on( 'contentDomUnload', function() + { + // Remove scripts. + var scripts = CKEDITOR.document.getElementsByTag( 'script' ), + scaytIdRegex = /^dojoIoScript(\d+)$/i, + scaytSrcRegex = /^https?:\/\/svc\.spellchecker\.net\/spellcheck\/script\/ssrv\.cgi/i; + + for ( var i=0; i < scripts.count(); i++ ) + { + var script = scripts.getItem( i ), + id = script.getId(), + src = script.getAttribute( 'src' ); + + if ( id && src && id.match( scaytIdRegex ) && src.match( scaytSrcRegex )) + script.remove(); + } + }); + + editor.on( 'beforeCommandExec', function( ev ) // Disable SCAYT before Source command execution. + { + if ( ( ev.data.name == 'source' || ev.data.name == 'newpage' ) && editor.mode == 'wysiwyg' ) + { + var scayt_instance = plugin.getScayt( editor ); + if ( scayt_instance ) + { + plugin.setPaused( editor, !scayt_instance.disabled ); + // store a control id for restore a specific scayt control settings + plugin.setControlId( editor, scayt_instance.id ); + scayt_instance.destroy( true ); + delete plugin.instances[ editor.name ]; + } + } + // Catch on source mode switch off (#5720) + else if ( ev.data.name == 'source' && editor.mode == 'source' ) + plugin.markControlRestore( editor ); + }); + + editor.on( 'afterCommandExec', function( ev ) + { + if ( !plugin.isScaytEnabled( editor ) ) + return; + + if ( editor.mode == 'wysiwyg' && ( ev.data.name == 'undo' || ev.data.name == 'redo' ) ) + window.setTimeout( function() { plugin.getScayt( editor ).refresh(); }, 10 ); + }); + + editor.on( 'destroy', function( ev ) + { + var editor = ev.editor, + scayt_instance = plugin.getScayt( editor ); + + // SCAYT instance might already get destroyed by mode switch (#5744). + if ( !scayt_instance ) + return; + + delete plugin.instances[ editor.name ]; + // store a control id for restore a specific scayt control settings + plugin.setControlId( editor, scayt_instance.id ); + scayt_instance.destroy( true ); + }); + + // Listen to data manipulation to reflect scayt markup. + editor.on( 'afterSetData', function() + { + if ( plugin.isScaytEnabled( editor ) ) { + window.setTimeout( function() + { + var instance = plugin.getScayt( editor ); + instance && instance.refresh(); + }, 10 ); + } + }); + + // Reload spell-checking for current word after insertion completed. + editor.on( 'insertElement', function() + { + var scayt_instance = plugin.getScayt( editor ); + if ( plugin.isScaytEnabled( editor ) ) + { + // Unlock the selection before reload, SCAYT will take + // care selection update. + if ( CKEDITOR.env.ie ) + editor.getSelection().unlock( true ); + + // Return focus to the editor and refresh SCAYT markup (#5573). + window.setTimeout( function() + { + scayt_instance.focus(); + scayt_instance.refresh(); + }, 10 ); + } + }, this, null, 50 ); + + editor.on( 'insertHtml', function() + { + var scayt_instance = plugin.getScayt( editor ); + if ( plugin.isScaytEnabled( editor ) ) + { + // Unlock the selection before reload, SCAYT will take + // care selection update. + if ( CKEDITOR.env.ie ) + editor.getSelection().unlock( true ); + + // Return focus to the editor (#5573) + // Refresh SCAYT markup + window.setTimeout( function() + { + scayt_instance.focus(); + scayt_instance.refresh(); + }, 10 ); + } + }, this, null, 50 ); + + editor.on( 'scaytDialog', function( ev ) // Communication with dialog. + { + ev.data.djConfig = window.djConfig; + ev.data.scayt_control = plugin.getScayt( editor ); + ev.data.tab = openPage; + ev.data.scayt = window.scayt; + }); + + var dataProcessor = editor.dataProcessor, + htmlFilter = dataProcessor && dataProcessor.htmlFilter; + + if ( htmlFilter ) + { + htmlFilter.addRules( + { + elements : + { + span : function( element ) + { + if ( element.attributes[ 'data-scayt_word' ] + && element.attributes[ 'data-scaytid' ] ) + { + delete element.name; // Write children, but don't write this node. + return element; + } + } + } + } + ); + } + + // Override Image.equals method avoid CK snapshot module to add SCAYT markup to snapshots. (#5546) + var undoImagePrototype = CKEDITOR.plugins.undo.Image.prototype; + undoImagePrototype.equals = CKEDITOR.tools.override( undoImagePrototype.equals, function( org ) + { + return function( otherImage ) + { + var thisContents = this.contents, + otherContents = otherImage.contents; + var scayt_instance = plugin.getScayt( this.editor ); + // Making the comparison based on content without SCAYT word markers. + if ( scayt_instance && plugin.isScaytReady( this.editor ) ) + { + // scayt::reset might return value undefined. (#5742) + this.contents = scayt_instance.reset( thisContents ) || ''; + otherImage.contents = scayt_instance.reset( otherContents ) || ''; + } + + var retval = org.apply( this, arguments ); + + this.contents = thisContents; + otherImage.contents = otherContents; + return retval; + }; + }); + + if ( editor.document ) + createInstance(); + }; + +CKEDITOR.plugins.scayt = + { + engineLoaded : false, + instances : {}, + // Data storage for SCAYT control, based on editor instances + controlInfo : {}, + setControlInfo : function( editor, o ) + { + if ( editor && editor.name && typeof ( this.controlInfo[ editor.name ] ) != 'object' ) + this.controlInfo[ editor.name ] = {}; + + for ( var infoOpt in o ) + this.controlInfo[ editor.name ][ infoOpt ] = o[ infoOpt ]; + }, + isControlRestored : function( editor ) + { + if ( editor && + editor.name && + this.controlInfo[ editor.name ] ) + { + return this.controlInfo[ editor.name ].restored ; + } + return false; + }, + markControlRestore : function( editor ) + { + this.setControlInfo( editor, { restored:true } ); + }, + setControlId: function( editor, id ) + { + this.setControlInfo( editor, { id:id } ); + }, + getControlId: function( editor ) + { + if ( editor && + editor.name && + this.controlInfo[ editor.name ] && + this.controlInfo[ editor.name ].id ) + { + return this.controlInfo[ editor.name ].id; + } + return null; + }, + setPaused: function( editor , bool ) + { + this.setControlInfo( editor, { paused:bool } ); + }, + isPaused: function( editor ) + { + if ( editor && + editor.name && + this.controlInfo[editor.name] ) + { + return this.controlInfo[editor.name].paused; + } + return undefined; + }, + getScayt : function( editor ) + { + return this.instances[ editor.name ]; + }, + isScaytReady : function( editor ) + { + return this.engineLoaded === true && + 'undefined' !== typeof window.scayt && this.getScayt( editor ); + }, + isScaytEnabled : function( editor ) + { + var scayt_instance = this.getScayt( editor ); + return ( scayt_instance ) ? scayt_instance.disabled === false : false; + }, + getUiTabs : function( editor ) + { + var uiTabs = []; + + // read UI tabs value from config + var configUiTabs = editor.config.scayt_uiTabs || "1,1,1"; + + // convert string to array + configUiTabs = configUiTabs.split( ',' ); + + // "About us" should be always shown for standard config + configUiTabs[3] = "1"; + + for ( var i = 0; i < 4; i++ ) { + uiTabs[i] = (typeof window.scayt != "undefined" && typeof window.scayt.uiTags != "undefined") + ? (parseInt(configUiTabs[i],10) && window.scayt.uiTags[i]) + : parseInt(configUiTabs[i],10); + } + return uiTabs; + }, + loadEngine : function( editor ) + { + // SCAYT doesn't work with Firefox2, Opera and AIR. + if ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 || CKEDITOR.env.opera || CKEDITOR.env.air ) + return editor.fire( 'showScaytState' ); + + if ( this.engineLoaded === true ) + return onEngineLoad.apply( editor ); // Add new instance. + else if ( this.engineLoaded == -1 ) // We are waiting. + return CKEDITOR.on( 'scaytReady', function(){ onEngineLoad.apply( editor ); } ); // Use function(){} to avoid rejection as duplicate. + + CKEDITOR.on( 'scaytReady', onEngineLoad, editor ); + CKEDITOR.on( 'scaytReady', function() + { + this.engineLoaded = true; + }, + this, + null, + 0 + ); // First to run. + + this.engineLoaded = -1; // Loading in progress. + + // compose scayt url + var protocol = document.location.protocol; + // Default to 'http' for unknown. + protocol = protocol.search( /https?:/) != -1? protocol : 'http:'; + var baseUrl = 'svc.spellchecker.net/scayt26/loader__base.js'; + + var scaytUrl = editor.config.scayt_srcUrl || ( protocol + '//' + baseUrl ); + var scaytConfigBaseUrl = plugin.parseUrl( scaytUrl ).path + '/'; + + if( window.scayt == undefined ) + { + CKEDITOR._djScaytConfig = + { + baseUrl: scaytConfigBaseUrl, + addOnLoad: + [ + function() + { + CKEDITOR.fireOnce( 'scaytReady' ); + } + ], + isDebug: false + }; + // Append javascript code. + CKEDITOR.document.getHead().append( + CKEDITOR.document.createElement( 'script', + { + attributes : + { + type : 'text/javascript', + async : 'true', + src : scaytUrl + } + }) + ); + } + else + CKEDITOR.fireOnce( 'scaytReady' ); + + return null; + }, + parseUrl : function ( data ) + { + var match; + if ( data.match && ( match = data.match(/(.*)[\/\\](.*?\.\w+)$/) ) ) + return { path: match[1], file: match[2] }; + else + return data; + } + }; + + var plugin = CKEDITOR.plugins.scayt; + + // Context menu constructing. + var addButtonCommand = function( editor, buttonName, buttonLabel, commandName, command, menugroup, menuOrder ) + { + editor.addCommand( commandName, command ); + + // If the "menu" plugin is loaded, register the menu item. + editor.addMenuItem( commandName, + { + label : buttonLabel, + command : commandName, + group : menugroup, + order : menuOrder + }); + }; + + var commandDefinition = + { + preserveState : true, + editorFocus : false, + canUndo : false, + + exec: function( editor ) + { + if ( plugin.isScaytReady( editor ) ) + { + var isEnabled = plugin.isScaytEnabled( editor ); + + this.setState( isEnabled ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_ON ); + + var scayt_control = plugin.getScayt( editor ); + // the place where the status of editor focus should be restored + // after there will be ability to store its state before SCAYT button click + // if (storedFocusState is focused ) + // scayt_control.focus(); + // + // now focus is set certainly + scayt_control.focus(); + scayt_control.setDisabled( isEnabled ); + } + else if ( !editor.config.scayt_autoStartup && plugin.engineLoaded >= 0 ) // Load first time + { + this.setState( CKEDITOR.TRISTATE_DISABLED ); + plugin.loadEngine( editor ); + } + } + }; + + // Add scayt plugin. + CKEDITOR.plugins.add( 'scayt', + { + requires : [ 'menubutton' ], + + beforeInit : function( editor ) + { + var items_order = editor.config.scayt_contextMenuItemsOrder + || 'suggest|moresuggest|control', + items_order_str = ""; + + items_order = items_order.split( '|' ); + + if ( items_order && items_order.length ) + { + for ( var pos = 0 ; pos < items_order.length ; pos++ ) + items_order_str += 'scayt_' + items_order[ pos ] + ( items_order.length != parseInt( pos, 10 ) + 1 ? ',' : '' ); + } + + // Put it on top of all context menu items (#5717) + editor.config.menu_groups = items_order_str + ',' + editor.config.menu_groups; + }, + + init : function( editor ) + { + // Delete span[data-scaytid] when text pasting in editor (#6921) + var dataFilter = editor.dataProcessor && editor.dataProcessor.dataFilter; + var dataFilterRules = + { + elements : + { + span : function( element ) + { + var attrs = element.attributes; + if ( attrs && attrs[ 'data-scaytid' ] ) + delete element.name; + } + } + }; + dataFilter && dataFilter.addRules( dataFilterRules ); + + var moreSuggestions = {}, + mainSuggestions = {}; + + // Scayt command. + var command = editor.addCommand( commandName, commandDefinition ); + + // Add Options dialog. + CKEDITOR.dialog.add( commandName, CKEDITOR.getUrl( this.path + 'dialogs/options.js' ) ); + + var uiTabs = plugin.getUiTabs( editor ); + + var menuGroup = 'scaytButton'; + editor.addMenuGroup( menuGroup ); + // combine menu items to render + var uiMenuItems = {}; + + var lang = editor.lang.scayt; + + // always added + uiMenuItems.scaytToggle = + { + label : lang.enable, + command : commandName, + group : menuGroup + }; + + if ( uiTabs[0] == 1 ) + uiMenuItems.scaytOptions = + { + label : lang.options, + group : menuGroup, + onClick : function() + { + openPage = 'options'; + editor.openDialog( commandName ); + } + }; + + if ( uiTabs[1] == 1 ) + uiMenuItems.scaytLangs = + { + label : lang.langs, + group : menuGroup, + onClick : function() + { + openPage = 'langs'; + editor.openDialog( commandName ); + } + }; + if ( uiTabs[2] == 1 ) + uiMenuItems.scaytDict = + { + label : lang.dictionariesTab, + group : menuGroup, + onClick : function() + { + openPage = 'dictionaries'; + editor.openDialog( commandName ); + } + }; + // always added + uiMenuItems.scaytAbout = + { + label : editor.lang.scayt.about, + group : menuGroup, + onClick : function() + { + openPage = 'about'; + editor.openDialog( commandName ); + } + }; + + editor.addMenuItems( uiMenuItems ); + + editor.ui.add( 'Scayt', CKEDITOR.UI_MENUBUTTON, + { + label : lang.title, + title : CKEDITOR.env.opera ? lang.opera_title : lang.title, + className : 'cke_button_scayt', + modes : { wysiwyg : 1 }, + onRender: function() + { + command.on( 'state', function() + { + this.setState( command.state ); + }, + this); + }, + onMenu : function() + { + var isEnabled = plugin.isScaytEnabled( editor ); + + editor.getMenuItem( 'scaytToggle' ).label = lang[ isEnabled ? 'disable' : 'enable' ]; + + var uiTabs = plugin.getUiTabs( editor ); + + return { + scaytToggle : CKEDITOR.TRISTATE_OFF, + scaytOptions : isEnabled && uiTabs[0] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED, + scaytLangs : isEnabled && uiTabs[1] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED, + scaytDict : isEnabled && uiTabs[2] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED, + scaytAbout : isEnabled && uiTabs[3] ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED + }; + } + }); + + // If the "contextmenu" plugin is loaded, register the listeners. + if ( editor.contextMenu && editor.addMenuItems ) + { + editor.contextMenu.addListener( function( element, selection ) + { + if ( !plugin.isScaytEnabled( editor ) + || selection.getRanges()[ 0 ].checkReadOnly() ) + return null; + + var scayt_control = plugin.getScayt( editor ), + node = scayt_control.getScaytNode(); + + if ( !node ) + return null; + + var word = scayt_control.getWord( node ); + + if ( !word ) + return null; + + var sLang = scayt_control.getLang(), + _r = {}, + items_suggestion = window.scayt.getSuggestion( word, sLang ); + if ( !items_suggestion || !items_suggestion.length ) + return null; + // Remove unused commands and menuitems + for ( var m in moreSuggestions ) + { + delete editor._.menuItems[ m ]; + delete editor._.commands[ m ]; + } + for ( m in mainSuggestions ) + { + delete editor._.menuItems[ m ]; + delete editor._.commands[ m ]; + } + moreSuggestions = {}; // Reset items. + mainSuggestions = {}; + + var moreSuggestionsUnable = editor.config.scayt_moreSuggestions || 'on'; + var moreSuggestionsUnableAdded = false; + + var maxSuggestions = editor.config.scayt_maxSuggestions; + ( typeof maxSuggestions != 'number' ) && ( maxSuggestions = 5 ); + !maxSuggestions && ( maxSuggestions = items_suggestion.length ); + + var contextCommands = editor.config.scayt_contextCommands || 'all'; + contextCommands = contextCommands.split( '|' ); + + for ( var i = 0, l = items_suggestion.length; i < l; i += 1 ) + { + var commandName = 'scayt_suggestion_' + items_suggestion[i].replace( ' ', '_' ); + var exec = ( function( el, s ) + { + return { + exec: function() + { + scayt_control.replace( el, s ); + } + }; + })( node, items_suggestion[i] ); + + if ( i < maxSuggestions ) + { + addButtonCommand( editor, 'button_' + commandName, items_suggestion[i], + commandName, exec, 'scayt_suggest', i + 1 ); + _r[ commandName ] = CKEDITOR.TRISTATE_OFF; + mainSuggestions[ commandName ] = CKEDITOR.TRISTATE_OFF; + } + else if ( moreSuggestionsUnable == 'on' ) + { + addButtonCommand( editor, 'button_' + commandName, items_suggestion[i], + commandName, exec, 'scayt_moresuggest', i + 1 ); + moreSuggestions[ commandName ] = CKEDITOR.TRISTATE_OFF; + moreSuggestionsUnableAdded = true; + } + } + + if ( moreSuggestionsUnableAdded ) + { + // Register the More suggestions group; + editor.addMenuItem( 'scayt_moresuggest', + { + label : lang.moreSuggestions, + group : 'scayt_moresuggest', + order : 10, + getItems : function() + { + return moreSuggestions; + } + }); + mainSuggestions[ 'scayt_moresuggest' ] = CKEDITOR.TRISTATE_OFF; + } + + if ( in_array( 'all', contextCommands ) || in_array( 'ignore', contextCommands) ) + { + var ignore_command = { + exec: function(){ + scayt_control.ignore( node ); + } + }; + addButtonCommand( editor, 'ignore', lang.ignore, 'scayt_ignore', ignore_command, 'scayt_control', 1 ); + mainSuggestions[ 'scayt_ignore' ] = CKEDITOR.TRISTATE_OFF; + } + + if ( in_array( 'all', contextCommands ) || in_array( 'ignoreall', contextCommands ) ) + { + var ignore_all_command = { + exec: function(){ + scayt_control.ignoreAll( node ); + } + }; + addButtonCommand(editor, 'ignore_all', lang.ignoreAll, 'scayt_ignore_all', ignore_all_command, 'scayt_control', 2); + mainSuggestions['scayt_ignore_all'] = CKEDITOR.TRISTATE_OFF; + } + + if ( in_array( 'all', contextCommands ) || in_array( 'add', contextCommands ) ) + { + var addword_command = { + exec: function(){ + window.scayt.addWordToUserDictionary( node ); + } + }; + addButtonCommand(editor, 'add_word', lang.addWord, 'scayt_add_word', addword_command, 'scayt_control', 3); + mainSuggestions['scayt_add_word'] = CKEDITOR.TRISTATE_OFF; + } + + if ( scayt_control.fireOnContextMenu ) + scayt_control.fireOnContextMenu( editor ); + + return mainSuggestions; + }); + } + + var showInitialState = function() + { + editor.removeListener( 'showScaytState', showInitialState ); + + if ( !CKEDITOR.env.opera && !CKEDITOR.env.air ) + command.setState( plugin.isScaytEnabled( editor ) ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF ); + else + command.setState( CKEDITOR.TRISTATE_DISABLED ); + }; + + editor.on( 'showScaytState', showInitialState ); + + if ( CKEDITOR.env.opera || CKEDITOR.env.air ) + { + editor.on( 'instanceReady', function() + { + showInitialState(); + }); + } + + // Start plugin + if ( editor.config.scayt_autoStartup ) + { + editor.on( 'instanceReady', function() + { + plugin.loadEngine( editor ); + }); + } + }, + + afterInit : function( editor ) + { + // Prevent word marker line from displaying in elements path and been removed when cleaning format. (#3570) (#4125) + var elementsPathFilters, + scaytFilter = function( element ) + { + if ( element.hasAttribute( 'data-scaytid' ) ) + return false; + }; + + if ( editor._.elementsPath && ( elementsPathFilters = editor._.elementsPath.filters ) ) + elementsPathFilters.push( scaytFilter ); + + editor.addRemoveFormatFilter && editor.addRemoveFormatFilter( scaytFilter ); + + } + }); +})(); + +/** + * If enabled (true), turns on SCAYT automatically after loading the editor. + * @name CKEDITOR.config.scayt_autoStartup + * @type Boolean + * @default false + * @example + * config.scayt_autoStartup = true; + */ + +/** + * Defines the number of SCAYT suggestions to show in the main context menu. + * The possible values are: + * + * @name CKEDITOR.config.scayt_maxSuggestions + * @type Number + * @default 5 + * @example + * // Display only three suggestions in the main context menu. + * config.scayt_maxSuggestions = 3; + * @example + * // Do not show the suggestions directly. + * config.scayt_maxSuggestions = -1; + */ + +/** + * Sets the customer ID for SCAYT. Required for migration from free version + * with banner to paid version. + * @name CKEDITOR.config.scayt_customerid + * @type String + * @default '' + * @example + * // Load SCAYT using my customer ID. + * config.scayt_customerid = 'your-encrypted-customer-id'; + */ + +/** + * Enables/disables the "More Suggestions" sub-menu in the context menu. + * The possible values are "on" or "off". + * @name CKEDITOR.config.scayt_moreSuggestions + * @type String + * @default 'on' + * @example + * // Disables the "More Suggestions" sub-menu. + * config.scayt_moreSuggestions = 'off'; + */ + +/** + * Customizes the display of SCAYT context menu commands ("Add Word", "Ignore" + * and "Ignore All"). It must be a string with one or more of the following + * words separated by a pipe ("|"): + * + * @name CKEDITOR.config.scayt_contextCommands + * @type String + * @default 'all' + * @example + * // Show only "Add Word" and "Ignore All" in the context menu. + * config.scayt_contextCommands = 'add|ignoreall'; + */ + +/** + * Sets the default spellchecking language for SCAYT. + * @name CKEDITOR.config.scayt_sLang + * @type String + * @default 'en_US' + * @example + * // Sets SCAYT to German. + * config.scayt_sLang = 'de_DE'; + */ + +/** + * Sets the visibility of the SCAYT tabs in the settings dialog and toolbar + * button. The value must contain a "1" (enabled) or "0" (disabled) number for + * each of the following entries, in this precise order, separated by a + * comma (","): "Options", "Languages" and "Dictionary". + * @name CKEDITOR.config.scayt_uiTabs + * @type String + * @default '1,1,1' + * @example + * // Hide the "Languages" tab. + * config.scayt_uiTabs = '1,0,1'; + */ + + +/** + * Set the URL to SCAYT core. Required to switch to licensed version of SCAYT application. + * Further details at http://wiki.spellchecker.net/doku.php?id=3rd:wysiwyg:fckeditor:wscckf3l . + * @name CKEDITOR.config.scayt_srcUrl + * @type String + * @default '' + * @example + * config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js"; + */ + +/** + * Links SCAYT to custom dictionaries. It's a string containing dictionary ids + * separared by commas (","). Available only for licensed version. + * Further details at http://wiki.spellchecker.net/doku.php?id=custom_dictionary_support . + * @name CKEDITOR.config.scayt_customDictionaryIds + * @type String + * @default '' + * @example + * config.scayt_customDictionaryIds = '3021,3456,3478"'; + */ + +/** + * Makes it possible to activate a custom dictionary on SCAYT. The user + * dictionary name must be used. Available only for licensed version. + * @name CKEDITOR.config.scayt_userDictionaryName + * @type String + * @default '' + * @example + * config.scayt_userDictionaryName = 'MyDictionary'; + */ + +/** + * Define order of placing of SCAYT context menu items by groups. + * It must be a string with one or more of the following + * words separated by a pipe ("|"): + * + * + * @name CKEDITOR.config.scayt_contextMenuItemsOrder + * @type String + * @default 'suggest|moresuggest|control' + * @example + * config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest'; + */