JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.2
[ckeditor.git] / _source / plugins / scayt / plugin.js
index 1395d6d..c945735 100644 (file)
@@ -108,7 +108,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                // Remove scripts.\r
                                var scripts = CKEDITOR.document.getElementsByTag( 'script' ),\r
                                        scaytIdRegex =  /^dojoIoScript(\d+)$/i,\r
-                                       scaytSrcRegex =  /^https?:\/\/svc\.spellchecker\.net\/spellcheck\/script\/ssrv\.cgi/i;\r
+                                       scaytSrcRegex =  /^https?:\/\/svc\.webspellchecker\.net\/spellcheck\/script\/ssrv\.cgi/i;\r
 \r
                                for ( var i=0; i < scripts.count(); i++ )\r
                                {\r
@@ -394,7 +394,7 @@ CKEDITOR.plugins.scayt =
                        var protocol = document.location.protocol;\r
                        // Default to 'http' for unknown.\r
                        protocol = protocol.search( /https?:/) != -1? protocol : 'http:';\r
-                       var baseUrl  = 'svc.spellchecker.net/scayt26/loader__base.js';\r
+                       var baseUrl  = 'svc.webspellchecker.net/scayt26/loader__base.js';\r
 \r
                        var scaytUrl  =  editor.config.scayt_srcUrl || ( protocol + '//' + baseUrl );\r
                        var scaytConfigBaseUrl =  plugin.parseUrl( scaytUrl ).path +  '/';\r
@@ -821,27 +821,28 @@ CKEDITOR.plugins.scayt =
 })();\r
 \r
 /**\r
- * If enabled (true), turns on SCAYT automatically after loading the editor.\r
+ * If enabled (set to <code>true</code>), turns on SCAYT automatically\r
+ * after loading the editor.\r
  * @name CKEDITOR.config.scayt_autoStartup\r
  * @type Boolean\r
- * @default false\r
+ * @default <code>false</code>\r
  * @example\r
  * config.scayt_autoStartup = true;\r
  */\r
 \r
 /**\r
  * Defines the number of SCAYT suggestions to show in the main context menu.\r
- * The possible values are:\r
+ * Possible values are:\r
  * <ul>\r
- *     <li>0 (zero): All suggestions are displayed in the main context menu.</li>\r
- *     <li>Positive number: The maximum number of suggestions to shown in context\r
- *             menu. Other entries will be shown in "More Suggestions" sub-menu.</li>\r
- *     <li>Negative number: No suggestions are shown in the main context menu. All\r
- *             entries will be listed in the "Suggestions" sub-menu.</li>\r
+ *     <li><code>0</code> (zero) &ndash; All suggestions are displayed in the main context menu.</li>\r
+ *     <li>Positive number &ndash; The maximum number of suggestions to show in the context\r
+ *             menu. Other entries will be shown in the "More Suggestions" sub-menu.</li>\r
+ *     <li>Negative number &ndash; No suggestions are shown in the main context menu. All\r
+ *             entries will be listed in the the "Suggestions" sub-menu.</li>\r
  * </ul>\r
  * @name CKEDITOR.config.scayt_maxSuggestions\r
  * @type Number\r
- * @default 5\r
+ * @default <code>5</code>\r
  * @example\r
  * // Display only three suggestions in the main context menu.\r
  * config.scayt_maxSuggestions = 3;\r
@@ -851,11 +852,11 @@ CKEDITOR.plugins.scayt =
  */\r
 \r
 /**\r
- * Sets the customer ID for SCAYT. Required for migration from free version\r
- * with banner to paid version.\r
+ * Sets the customer ID for SCAYT. Required for migration from free,\r
+ * ad-supported version to paid, ad-free version.\r
  * @name CKEDITOR.config.scayt_customerid\r
  * @type String\r
- * @default ''\r
+ * @default <code>''</code>\r
  * @example\r
  * // Load SCAYT using my customer ID.\r
  * config.scayt_customerid  = 'your-encrypted-customer-id';\r
@@ -863,10 +864,10 @@ CKEDITOR.plugins.scayt =
 \r
 /**\r
  * Enables/disables the "More Suggestions" sub-menu in the context menu.\r
- * The possible values are "on" or "off".\r
+ * Possible values are <code>on</code> and <code>off</code>.\r
  * @name CKEDITOR.config.scayt_moreSuggestions\r
  * @type String\r
- * @default 'on'\r
+ * @default <code>'on'</code>\r
  * @example\r
  * // Disables the "More Suggestions" sub-menu.\r
  * config.scayt_moreSuggestions = 'off';\r
@@ -874,91 +875,99 @@ CKEDITOR.plugins.scayt =
 \r
 /**\r
  * Customizes the display of SCAYT context menu commands ("Add Word", "Ignore"\r
- * and "Ignore All"). It must be a string with one or more of the following\r
- * words separated by a pipe ("|"):\r
+ * and "Ignore All"). This must be a string with one or more of the following\r
+ * words separated by a pipe character ("|"):\r
  * <ul>\r
- *     <li>"off": disables all options.</li>\r
- *     <li>"all": enables all options.</li>\r
- *     <li>"ignore": enables the "Ignore" option.</li>\r
- *     <li>"ignoreall": enables the "Ignore All" option.</li>\r
- *     <li>"add": enables the "Add Word" option.</li>\r
+ *     <li><code>off</code> &ndash; disables all options.</li>\r
+ *     <li><code>all</code> &ndash; enables all options.</li>\r
+ *     <li><code>ignore</code> &ndash; enables the "Ignore" option.</li>\r
+ *     <li><code>ignoreall</code> &ndash; enables the "Ignore All" option.</li>\r
+ *     <li><code>add</code> &ndash; enables the "Add Word" option.</li>\r
  * </ul>\r
  * @name CKEDITOR.config.scayt_contextCommands\r
  * @type String\r
- * @default 'all'\r
+ * @default <code>'all'</code>\r
  * @example\r
  * // Show only "Add Word" and "Ignore All" in the context menu.\r
  * config.scayt_contextCommands = 'add|ignoreall';\r
  */\r
 \r
 /**\r
- * Sets the default spellchecking language for SCAYT.\r
+ * Sets the default spell checking language for SCAYT. Possible values are:\r
+ * <code>en_US</code>, <code>en_GB</code>, <code>pt_BR</code>, <code>da_DK</code>,\r
+ * <code>nl_NL</code>, <code>en_CA</code>, <code>fi_FI</code>, <code>fr_FR</code>,\r
+ * <code>fr_CA</code>, <code>de_DE</code>, <code>el_GR</code>, <code>it_IT</code>,\r
+ * <code>nb_NO</code>, <code>pt_PT</code>, <code>es_ES</code>, <code>sv_SE</code>.\r
  * @name CKEDITOR.config.scayt_sLang\r
  * @type String\r
- * @default 'en_US'\r
+ * @default <code>'en_US'</code>\r
  * @example\r
  * // Sets SCAYT to German.\r
  * config.scayt_sLang = 'de_DE';\r
  */\r
 \r
 /**\r
- * Sets the visibility of the SCAYT tabs in the settings dialog and toolbar\r
- * button. The value must contain a "1" (enabled) or "0" (disabled) number for\r
- * each of the following entries, in this precise order, separated by a\r
- * comma (","): "Options", "Languages" and "Dictionary".\r
+ * Sets the visibility of particular tabs in the SCAYT dialog window and toolbar\r
+ * button. This setting must contain a <code>1</code> (enabled) or <code>0</code>\r
+ * (disabled) value for each of the following entries, in this precise order,\r
+ * separated by a comma (","): "Options", "Languages", and "Dictionary".\r
  * @name CKEDITOR.config.scayt_uiTabs\r
  * @type String\r
- * @default '1,1,1'\r
+ * @default <code>'1,1,1'</code>\r
  * @example\r
- * // Hide the "Languages" tab.\r
+ * // Hides the "Languages" tab.\r
  * config.scayt_uiTabs = '1,0,1';\r
  */\r
 \r
 \r
 /**\r
- * Set the URL to SCAYT core. Required to switch to licensed version of SCAYT application.\r
- * Further details at http://wiki.spellchecker.net/doku.php?id=3rd:wysiwyg:fckeditor:wscckf3l .\r
+ * Sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT application.\r
+ * Further details available at\r
+ * <a href="http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck">\r
+ * http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck</a>.\r
  * @name CKEDITOR.config.scayt_srcUrl\r
  * @type String\r
- * @default ''\r
+ * @default <code>''</code>\r
  * @example\r
  * config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js";\r
  */\r
 \r
 /**\r
- * Links SCAYT to custom dictionaries. It's a string containing dictionary ids\r
- * separared by commas (","). Available only for licensed version.\r
- * Further details at http://wiki.spellchecker.net/doku.php?id=custom_dictionary_support .\r
+ * Links SCAYT to custom dictionaries. This is a string containing dictionary IDs\r
+ * separared by commas (","). Available only for the licensed version.\r
+ * Further details at\r
+ * <a href="http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed">\r
+ * http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed</a>.\r
  * @name CKEDITOR.config.scayt_customDictionaryIds\r
  * @type String\r
- * @default ''\r
+ * @default <code>''</code>\r
  * @example\r
  * config.scayt_customDictionaryIds = '3021,3456,3478"';\r
  */\r
 \r
 /**\r
- * Makes it possible to activate a custom dictionary on SCAYT. The user\r
- * dictionary name must be used. Available only for licensed version.\r
+ * Makes it possible to activate a custom dictionary in SCAYT. The user\r
+ * dictionary name must be used. Available only for the licensed version.\r
  * @name CKEDITOR.config.scayt_userDictionaryName\r
  * @type String\r
- * @default ''\r
+ * @default <code>''</code>\r
  * @example\r
  * config.scayt_userDictionaryName = 'MyDictionary';\r
  */\r
 \r
 /**\r
- * Define order of placing of SCAYT context menu items by groups.\r
- * It must be a string with one or more of the following\r
- * words separated by a pipe ("|"):\r
+ * Defines the order SCAYT context menu items by groups.\r
+ * This must be a string with one or more of the following\r
+ * words separated by a pipe character ("|"):\r
  * <ul>\r
- *     <li>'suggest'     - main suggestion word list,</li>\r
- *     <li>'moresuggest' - more suggestions word list,</li>\r
- *     <li>'control'     - SCAYT commands, such as 'Ignore' and 'Add Word'</li>\r
+ *     <li><code>suggest</code> &ndash; main suggestion word list,</li>\r
+ *     <li><code>moresuggest</code> &ndash; more suggestions word list,</li>\r
+ *     <li><code>control</code> &ndash; SCAYT commands, such as "Ignore" and "Add Word".</li>\r
  * </ul>\r
  *\r
  * @name CKEDITOR.config.scayt_contextMenuItemsOrder\r
  * @type String\r
- * @default 'suggest|moresuggest|control'\r
+ * @default <code>'suggest|moresuggest|control'</code>\r
  * @example\r
  * config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';\r
  */\r