diff options
Diffstat (limited to 'sources/plugins/scayt')
-rw-r--r-- | sources/plugins/scayt/CHANGELOG.md | 6 | ||||
-rw-r--r-- | sources/plugins/scayt/plugin.js | 251 |
2 files changed, 167 insertions, 90 deletions
diff --git a/sources/plugins/scayt/CHANGELOG.md b/sources/plugins/scayt/CHANGELOG.md index ac33d966..d956208b 100644 --- a/sources/plugins/scayt/CHANGELOG.md +++ b/sources/plugins/scayt/CHANGELOG.md | |||
@@ -3,8 +3,8 @@ SCAYT plugin for CKEditor 4 Changelog | |||
3 | ### CKEditor 4.5.6 | 3 | ### CKEditor 4.5.6 |
4 | 4 | ||
5 | New Features: | 5 | New Features: |
6 | * CKEditor [language adddon](http://ckeditor.com/addon/language) support | 6 | * CKEditor [language addon](http://ckeditor.com/addon/language) support |
7 | * CKEditor [placeholder adddon](http://ckeditor.com/addon/placeholder) support | 7 | * CKEditor [placeholder addon](http://ckeditor.com/addon/placeholder) support |
8 | * Drag and Drop support | 8 | * Drag and Drop support |
9 | * *Experimental* GRAYT functionality http://www.webspellchecker.net/samples/scayt-ckeditor-plugin.html#25 | 9 | * *Experimental* GRAYT functionality http://www.webspellchecker.net/samples/scayt-ckeditor-plugin.html#25 |
10 | 10 | ||
@@ -17,4 +17,4 @@ Fixed issues: | |||
17 | * [#108](https://github.com/WebSpellChecker/ckeditor-plugin-scayt/issues/108) Latest SCAYT copies id of editor element to the iframe | 17 | * [#108](https://github.com/WebSpellChecker/ckeditor-plugin-scayt/issues/108) Latest SCAYT copies id of editor element to the iframe |
18 | * SCAYT stops working when CKEditor Undo plug-in not enabled | 18 | * SCAYT stops working when CKEditor Undo plug-in not enabled |
19 | * Issue with pasting SCAYT markup in CKEditor | 19 | * Issue with pasting SCAYT markup in CKEditor |
20 | * SCAYT stops working after pressing Cancel button in WSC dialog | 20 | * [#32](https://github.com/WebSpellChecker/ckeditor-plugin-wsc/issues/32) SCAYT stops working after pressing Cancel button in WSC dialog |
diff --git a/sources/plugins/scayt/plugin.js b/sources/plugins/scayt/plugin.js index ef315263..8c361b80 100644 --- a/sources/plugins/scayt/plugin.js +++ b/sources/plugins/scayt/plugin.js | |||
@@ -264,7 +264,7 @@ CKEDITOR.plugins.add('scayt', { | |||
264 | plugin.destroy(editor); | 264 | plugin.destroy(editor); |
265 | }; | 265 | }; |
266 | 266 | ||
267 | /** | 267 | /* |
268 | * Dirty fix for placeholder drag&drop | 268 | * Dirty fix for placeholder drag&drop |
269 | * Should be fixed with next release | 269 | * Should be fixed with next release |
270 | */ | 270 | */ |
@@ -320,7 +320,7 @@ CKEDITOR.plugins.add('scayt', { | |||
320 | if(inline_mode) { | 320 | if(inline_mode) { |
321 | 321 | ||
322 | if (!editor.config.scayt_inlineModeImmediateMarkup) { | 322 | if (!editor.config.scayt_inlineModeImmediateMarkup) { |
323 | /** | 323 | /* |
324 | * Give an opportunity to CKEditor to perform all needed updates | 324 | * Give an opportunity to CKEditor to perform all needed updates |
325 | * and only after that call 'scaytDestroy' method (#72725) | 325 | * and only after that call 'scaytDestroy' method (#72725) |
326 | */ | 326 | */ |
@@ -343,7 +343,7 @@ CKEDITOR.plugins.add('scayt', { | |||
343 | 343 | ||
344 | addMarkupStateHandlers(); | 344 | addMarkupStateHandlers(); |
345 | 345 | ||
346 | /** | 346 | /* |
347 | * 'mousedown' handler handle widget selection (click on widget). To | 347 | * 'mousedown' handler handle widget selection (click on widget). To |
348 | * fix the issue when widget#wrapper referenced to element which can | 348 | * fix the issue when widget#wrapper referenced to element which can |
349 | * be broken after markup. | 349 | * be broken after markup. |
@@ -433,7 +433,7 @@ CKEDITOR.plugins.add('scayt', { | |||
433 | var scaytInstance = editor.scayt, | 433 | var scaytInstance = editor.scayt, |
434 | scaytLangList = scaytInstance && scaytInstance.getScaytLangList(); | 434 | scaytLangList = scaytInstance && scaytInstance.getScaytLangList(); |
435 | 435 | ||
436 | /** | 436 | /* |
437 | * Checks SCAYT initialization of LangList. To prevent immediate | 437 | * Checks SCAYT initialization of LangList. To prevent immediate |
438 | * markup which is triggered by 'startSpellCheck' event. | 438 | * markup which is triggered by 'startSpellCheck' event. |
439 | * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true; | 439 | * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true; |
@@ -481,14 +481,14 @@ CKEDITOR.plugins.add('scayt', { | |||
481 | } | 481 | } |
482 | }, this, null, 50); | 482 | }, this, null, 50); |
483 | 483 | ||
484 | /** | 484 | /* |
485 | * Main entry point to react on changes in document | 485 | * Main entry point to react on changes in document |
486 | */ | 486 | */ |
487 | editor.on('reloadMarkupScayt', function(ev) { | 487 | editor.on('reloadMarkupScayt', function(ev) { |
488 | var removeOptions = ev.data && ev.data.removeOptions, | 488 | var removeOptions = ev.data && ev.data.removeOptions, |
489 | timeout = ev.data && ev.data.timeout; | 489 | timeout = ev.data && ev.data.timeout; |
490 | 490 | ||
491 | /** | 491 | /* |
492 | * Perform removeMarkupInSelectionNode and 'startSpellCheck' fire | 492 | * Perform removeMarkupInSelectionNode and 'startSpellCheck' fire |
493 | * asynchroniosly and keep CKEDITOR flow as expected | 493 | * asynchroniosly and keep CKEDITOR flow as expected |
494 | */ | 494 | */ |
@@ -496,14 +496,14 @@ CKEDITOR.plugins.add('scayt', { | |||
496 | var scaytInstance = editor.scayt, | 496 | var scaytInstance = editor.scayt, |
497 | scaytLangList = scaytInstance && scaytInstance.getScaytLangList(); | 497 | scaytLangList = scaytInstance && scaytInstance.getScaytLangList(); |
498 | 498 | ||
499 | /** | 499 | /* |
500 | * Checks SCAYT initialization of LangList. To prevent immediate | 500 | * Checks SCAYT initialization of LangList. To prevent immediate |
501 | * markup which is triggered by 'startSpellCheck' event. | 501 | * markup which is triggered by 'startSpellCheck' event. |
502 | * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true; | 502 | * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true; |
503 | */ | 503 | */ |
504 | if (!scaytLangList || !(scaytLangList.ltr && scaytLangList.rtl)) return; | 504 | if (!scaytLangList || !(scaytLangList.ltr && scaytLangList.rtl)) return; |
505 | 505 | ||
506 | /** | 506 | /* |
507 | * CKEditor can keep \u200B character in document (with selection#selectRanges) | 507 | * CKEditor can keep \u200B character in document (with selection#selectRanges) |
508 | * we need to take care about that. For this case we fire | 508 | * we need to take care about that. For this case we fire |
509 | * 'keydown' [left arrow], what will trigger 'removeFillingChar' on Webkit | 509 | * 'keydown' [left arrow], what will trigger 'removeFillingChar' on Webkit |
@@ -1443,7 +1443,10 @@ CKEDITOR.on('scaytReady', function() { | |||
1443 | }); | 1443 | }); |
1444 | 1444 | ||
1445 | /** | 1445 | /** |
1446 | * The parameter turns on/off SCAYT on the autostartup. If 'true', turns on SCAYT automatically after loading the editor. | 1446 | * Automatically enables SCAYT on editor startup. When set to `true`, this option turns on SCAYT automatically |
1447 | * after loading the editor. | ||
1448 | * | ||
1449 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1447 | * | 1450 | * |
1448 | * config.scayt_autoStartup = true; | 1451 | * config.scayt_autoStartup = true; |
1449 | * | 1452 | * |
@@ -1452,36 +1455,44 @@ CKEDITOR.on('scaytReady', function() { | |||
1452 | */ | 1455 | */ |
1453 | 1456 | ||
1454 | /** | 1457 | /** |
1455 | * The parameter turns on/off Grammar As You Type (GRAYT) on the SCAYT startup. If 'true', turns on GRAYT automatically after SCAYT started. | 1458 | * Enables Grammar As You Type (GRAYT) on SCAYT startup. When set to `true`, this option turns on GRAYT automatically |
1459 | * after SCAYT started. | ||
1460 | * | ||
1461 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1456 | * | 1462 | * |
1457 | * config.grayt_autoStartup = true; | 1463 | * config.grayt_autoStartup = true; |
1458 | * | 1464 | * |
1465 | * @since 4.5.6 | ||
1459 | * @cfg {Boolean} [grayt_autoStartup=false] | 1466 | * @cfg {Boolean} [grayt_autoStartup=false] |
1460 | * @member CKEDITOR.config | 1467 | * @member CKEDITOR.config |
1461 | */ | 1468 | */ |
1462 | 1469 | ||
1463 | /** | 1470 | /** |
1464 | * The parameter turns on/off SCAYT initiation when Inline CKEditor is not focused. SCAYT markup is taken place (SCAYT instance is not destroyed) | 1471 | * Enables SCAYT initialization when inline CKEditor is not focused. When set to `true`, SCAYT markup is |
1465 | * in both Inline CKEditor's states, focused and unfocused. | 1472 | * displayed in both inline editor states, focused and unfocused, so the SCAYT instance is not destroyed. |
1473 | * | ||
1474 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1466 | * | 1475 | * |
1467 | * config.scayt_inlineModeImmediateMarkup = true; | 1476 | * config.scayt_inlineModeImmediateMarkup = true; |
1468 | * | 1477 | * |
1478 | * @since 4.5.6 | ||
1469 | * @cfg {Boolean} [scayt_inlineModeImmediateMarkup=false] | 1479 | * @cfg {Boolean} [scayt_inlineModeImmediateMarkup=false] |
1470 | * @member CKEDITOR.config | 1480 | * @member CKEDITOR.config |
1471 | */ | 1481 | */ |
1472 | 1482 | ||
1473 | |||
1474 | /** | 1483 | /** |
1475 | * The parameter defines the number of SCAYT suggestions to show in the main context menu. | 1484 | * Defines the number of SCAYT suggestions to show in the main context menu. |
1476 | * Possible values are: | 1485 | * Possible values are: |
1477 | * | 1486 | * |
1478 | * * `0` (zero) – No suggestions are shown in the main context menu. All | 1487 | * * `0` (zero) – No suggestions are shown in the main context menu. All |
1479 | * entries will be listed in the "More Suggestions" sub-menu. | 1488 | * entries will be listed in the "More Suggestions" sub-menu. |
1480 | * * Positive number – The maximum number of suggestions to show in the context | 1489 | * * Positive number – The maximum number of suggestions to show in the context |
1481 | * menu. Other entries will be shown in the "More Suggestions" sub-menu. | 1490 | * menu. Other entries will be shown in the "More Suggestions" sub-menu. |
1482 | * * Negative number – 5 suggestions are shown in the main context menu. All other | 1491 | * * Negative number – Five suggestions are shown in the main context menu. All other |
1483 | * entries will be listed in the "More Suggestions" sub-menu. | 1492 | * entries will be listed in the "More Suggestions" sub-menu. |
1484 | * | 1493 | * |
1494 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1495 | * | ||
1485 | * Examples: | 1496 | * Examples: |
1486 | * | 1497 | * |
1487 | * // Display only three suggestions in the main context menu. | 1498 | * // Display only three suggestions in the main context menu. |
@@ -1495,12 +1506,14 @@ CKEDITOR.on('scaytReady', function() { | |||
1495 | */ | 1506 | */ |
1496 | 1507 | ||
1497 | /** | 1508 | /** |
1498 | * The parameter defines minimum length of the words that will be collected from editor's text for spell checking. | 1509 | * Defines the minimum length of words that will be collected from the editor content for spell checking. |
1499 | * Possible value is any positive number. | 1510 | * Possible value is any positive number. |
1500 | * | 1511 | * |
1512 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1513 | * | ||
1501 | * Examples: | 1514 | * Examples: |
1502 | * | 1515 | * |
1503 | * // Set minimum length of the words that will be collected from text. | 1516 | * // Set the minimum length of words that will be collected from editor text. |
1504 | * config.scayt_minWordLength = 5; | 1517 | * config.scayt_minWordLength = 5; |
1505 | * | 1518 | * |
1506 | * @cfg {Number} [scayt_minWordLength=4] | 1519 | * @cfg {Number} [scayt_minWordLength=4] |
@@ -1508,9 +1521,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1508 | */ | 1521 | */ |
1509 | 1522 | ||
1510 | /** | 1523 | /** |
1511 | * The parameter sets the customer ID for SCAYT. Used for hosted users only. Required for migration from free | 1524 | * Sets the customer ID for SCAYT. Used for hosted users only. Required for migration from free |
1512 | * to trial or paid versions. | 1525 | * to trial or paid versions. |
1513 | * | 1526 | * |
1527 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1528 | * | ||
1514 | * // Load SCAYT using my customer ID. | 1529 | * // Load SCAYT using my customer ID. |
1515 | * config.scayt_customerId = 'your-encrypted-customer-id'; | 1530 | * config.scayt_customerId = 'your-encrypted-customer-id'; |
1516 | * | 1531 | * |
@@ -1519,9 +1534,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1519 | */ | 1534 | */ |
1520 | 1535 | ||
1521 | /** | 1536 | /** |
1522 | * The parameter enables/disables the "More Suggestions" sub-menu in the context menu. | 1537 | * Enables and disables the "More Suggestions" sub-menu in the context menu. |
1523 | * Possible values are `'on'` and `'off'`. | 1538 | * Possible values are `'on'` and `'off'`. |
1524 | * | 1539 | * |
1540 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1541 | * | ||
1525 | * // Disables the "More Suggestions" sub-menu. | 1542 | * // Disables the "More Suggestions" sub-menu. |
1526 | * config.scayt_moreSuggestions = 'off'; | 1543 | * config.scayt_moreSuggestions = 'off'; |
1527 | * | 1544 | * |
@@ -1530,23 +1547,26 @@ CKEDITOR.on('scaytReady', function() { | |||
1530 | */ | 1547 | */ |
1531 | 1548 | ||
1532 | /** | 1549 | /** |
1533 | * The parameter customizes the display of SCAYT context menu commands ("Add Word", "Ignore", | 1550 | * Customizes the display of SCAYT context menu commands ("Add Word", "Ignore", |
1534 | * "Ignore All", "Options", "Languages", "Dictionaries" and "About"). | 1551 | * "Ignore All", "Options", "Languages", "Dictionaries" and "About"). |
1535 | * This must be a string with one or more of the following | 1552 | * This must be a string with one or more of the following |
1536 | * words separated by a pipe character (`'|'`): | 1553 | * words separated by a pipe character (`'|'`): |
1537 | * | 1554 | * |
1538 | * * `off` – disables all options. | 1555 | * * `off` – Disables all options. |
1539 | * * `all` – enables all options. | 1556 | * * `all` – Enables all options. |
1540 | * * `ignore` – enables the "Ignore" option. | 1557 | * * `ignore` – Enables the "Ignore" option. |
1541 | * * `ignoreall` – enables the "Ignore All" option. | 1558 | * * `ignoreall` – Enables the "Ignore All" option. |
1542 | * * `add` – enables the "Add Word" option. | 1559 | * * `add` – Enables the "Add Word" option. |
1543 | * * `option` – enables "Options" menu item. | 1560 | * * `option` – Enables the "Options" menu item. |
1544 | * * `language` – enables "Languages" menu item. | 1561 | * * `language` – Enables the "Languages" menu item. |
1545 | * * `dictionary` – enables "Dictionaries" menu item. | 1562 | * * `dictionary` – Enables the "Dictionaries" menu item. |
1546 | * * `about` – enables "About" menu item. | 1563 | * * `about` – Enables the "About" menu item. |
1547 | * | 1564 | * |
1548 | * Note, that availability of 'Options', 'Languages' and 'Dictionaries' items | 1565 | * Please note that availability of the "Options", "Languages" and "Dictionaries" items |
1549 | * depends on scayt_uiTabs option also. | 1566 | * also depends on the {@link CKEDITOR.config#scayt_uiTabs} option. |
1567 | * | ||
1568 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1569 | * | ||
1550 | * Example: | 1570 | * Example: |
1551 | * | 1571 | * |
1552 | * // Show only "Add Word" and "Ignore All" in the context menu. | 1572 | * // Show only "Add Word" and "Ignore All" in the context menu. |
@@ -1557,12 +1577,14 @@ CKEDITOR.on('scaytReady', function() { | |||
1557 | */ | 1577 | */ |
1558 | 1578 | ||
1559 | /** | 1579 | /** |
1560 | * The parameter sets the default spell checking language for SCAYT. Possible values are: | 1580 | * Sets the default spell checking language for SCAYT. Possible values are: |
1561 | * `'en_US'`, `'en_GB'`, `'pt_BR'`, `'da_DK'`, | 1581 | * `'en_US'`, `'en_GB'`, `'pt_BR'`, `'da_DK'`, |
1562 | * `'nl_NL'`, `'en_CA'`, `'fi_FI'`, `'fr_FR'`, | 1582 | * `'nl_NL'`, `'en_CA'`, `'fi_FI'`, `'fr_FR'`, |
1563 | * `'fr_CA'`, `'de_DE'`, `'el_GR'`, `'it_IT'`, | 1583 | * `'fr_CA'`, `'de_DE'`, `'el_GR'`, `'it_IT'`, |
1564 | * `'nb_NO'`, `'pt_PT'`, `'es_ES'`, `'sv_SE'`. | 1584 | * `'nb_NO'`, `'pt_PT'`, `'es_ES'`, `'sv_SE'`. |
1565 | * | 1585 | * |
1586 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1587 | * | ||
1566 | * // Sets SCAYT to German. | 1588 | * // Sets SCAYT to German. |
1567 | * config.scayt_sLang = 'de_DE'; | 1589 | * config.scayt_sLang = 'de_DE'; |
1568 | * | 1590 | * |
@@ -1571,11 +1593,13 @@ CKEDITOR.on('scaytReady', function() { | |||
1571 | */ | 1593 | */ |
1572 | 1594 | ||
1573 | /** | 1595 | /** |
1574 | * The parameter customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs/items. | 1596 | * Customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs and items. |
1575 | * This setting must contain a `1` (enabled) or `0` | 1597 | * This setting must contain a `1` (enabled) or `0` |
1576 | * (disabled) value for each of the following entries, in this precise order, | 1598 | * (disabled) value for each of the following entries, in this precise order, |
1577 | * separated by a comma (`','`): `'Options'`, `'Languages'`, and `'Dictionary'`. | 1599 | * separated by a comma (`','`): `'Options'`, `'Languages'`, and `'Dictionary'`. |
1578 | * | 1600 | * |
1601 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1602 | * | ||
1579 | * // Hides the "Languages" tab. | 1603 | * // Hides the "Languages" tab. |
1580 | * config.scayt_uiTabs = '1,0,1'; | 1604 | * config.scayt_uiTabs = '1,0,1'; |
1581 | * | 1605 | * |
@@ -1584,9 +1608,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1584 | */ | 1608 | */ |
1585 | 1609 | ||
1586 | /** | 1610 | /** |
1587 | * The parameter allows to specify protocol for WSC service (ssrv.cgi) full path. | 1611 | * Sets the protocol for the WebSpellChecker service (`ssrv.cgi`) full path. |
1588 | * | 1612 | * |
1589 | * // Defines protocol for WSC service (ssrv.cgi) full path. | 1613 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). |
1614 | * | ||
1615 | * // Defines the protocol for the WebSpellChecker service (ssrv.cgi) path. | ||
1590 | * config.scayt_serviceProtocol = 'https'; | 1616 | * config.scayt_serviceProtocol = 'https'; |
1591 | * | 1617 | * |
1592 | * @cfg {String} [scayt_serviceProtocol='http'] | 1618 | * @cfg {String} [scayt_serviceProtocol='http'] |
@@ -1594,9 +1620,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1594 | */ | 1620 | */ |
1595 | 1621 | ||
1596 | /** | 1622 | /** |
1597 | * The parameter allows to specify host for WSC service (ssrv.cgi) full path. | 1623 | * Sets the host for the WebSpellChecker service (`ssrv.cgi`) full path. |
1624 | * | ||
1625 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1598 | * | 1626 | * |
1599 | * // Defines host for WSC service (ssrv.cgi) full path. | 1627 | * // Defines the host for the WebSpellChecker service (ssrv.cgi) path. |
1600 | * config.scayt_serviceHost = 'my-host'; | 1628 | * config.scayt_serviceHost = 'my-host'; |
1601 | * | 1629 | * |
1602 | * @cfg {String} [scayt_serviceHost='svc.webspellchecker.net'] | 1630 | * @cfg {String} [scayt_serviceHost='svc.webspellchecker.net'] |
@@ -1604,9 +1632,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1604 | */ | 1632 | */ |
1605 | 1633 | ||
1606 | /** | 1634 | /** |
1607 | * The parameter allows to specify port for WSC service (ssrv.cgi) full path. | 1635 | * Sets the port for the WebSpellChecker service (`ssrv.cgi`) full path. |
1608 | * | 1636 | * |
1609 | * // Defines port for WSC service (ssrv.cgi) full path. | 1637 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). |
1638 | * | ||
1639 | * // Defines the port for the WebSpellChecker service (ssrv.cgi) path. | ||
1610 | * config.scayt_servicePort = '2330'; | 1640 | * config.scayt_servicePort = '2330'; |
1611 | * | 1641 | * |
1612 | * @cfg {String} [scayt_servicePort='80'] | 1642 | * @cfg {String} [scayt_servicePort='80'] |
@@ -1614,9 +1644,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1614 | */ | 1644 | */ |
1615 | 1645 | ||
1616 | /** | 1646 | /** |
1617 | * The parameter allows to specify path for WSC service (ssrv.cgi) full path. | 1647 | * Sets the path to the WebSpellChecker service (`ssrv.cgi`). |
1648 | * | ||
1649 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1618 | * | 1650 | * |
1619 | * // Defines host for WSC service (ssrv.cgi) full path. | 1651 | * // Defines the path to the WebSpellChecker service (ssrv.cgi). |
1620 | * config.scayt_servicePath = 'my-path/ssrv.cgi'; | 1652 | * config.scayt_servicePath = 'my-path/ssrv.cgi'; |
1621 | * | 1653 | * |
1622 | * @cfg {String} [scayt_servicePath='spellcheck31/script/ssrv.cgi'] | 1654 | * @cfg {String} [scayt_servicePath='spellcheck31/script/ssrv.cgi'] |
@@ -1624,9 +1656,12 @@ CKEDITOR.on('scaytReady', function() { | |||
1624 | */ | 1656 | */ |
1625 | 1657 | ||
1626 | /** | 1658 | /** |
1627 | * The parameter sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT application. | 1659 | * Sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT. |
1628 | * | 1660 | * |
1629 | * Further details available at [http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck](http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck) | 1661 | * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck) |
1662 | * for more details. | ||
1663 | * | ||
1664 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1630 | * | 1665 | * |
1631 | * config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js"; | 1666 | * config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js"; |
1632 | * | 1667 | * |
@@ -1635,10 +1670,13 @@ CKEDITOR.on('scaytReady', function() { | |||
1635 | */ | 1670 | */ |
1636 | 1671 | ||
1637 | /** | 1672 | /** |
1638 | * The parameter links SCAYT to custom dictionaries. This is a string containing dictionary IDs | 1673 | * Links SCAYT to custom dictionaries. This is a string containing the dictionary IDs |
1639 | * separated by commas (`','`). Available only for the licensed version. | 1674 | * separated by commas (`','`). Available only for the licensed version. |
1640 | * | 1675 | * |
1641 | * Further details at [http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed) | 1676 | * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed) |
1677 | * for more details. | ||
1678 | * | ||
1679 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1642 | * | 1680 | * |
1643 | * config.scayt_customDictionaryIds = '3021,3456,3478'; | 1681 | * config.scayt_customDictionaryIds = '3021,3456,3478'; |
1644 | * | 1682 | * |
@@ -1647,9 +1685,14 @@ CKEDITOR.on('scaytReady', function() { | |||
1647 | */ | 1685 | */ |
1648 | 1686 | ||
1649 | /** | 1687 | /** |
1650 | * The parameter activates a User Dictionary in SCAYT. The user | 1688 | * Activates a User Dictionary in SCAYT. The user |
1651 | * dictionary name must be used. Available only for the licensed version. | 1689 | * dictionary name must be used. Available only for the licensed version. |
1652 | * | 1690 | * |
1691 | * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:userdictionaries) | ||
1692 | * for more details. | ||
1693 | * | ||
1694 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1695 | * | ||
1653 | * config.scayt_userDictionaryName = 'MyDictionary'; | 1696 | * config.scayt_userDictionaryName = 'MyDictionary'; |
1654 | * | 1697 | * |
1655 | * @cfg {String} [scayt_userDictionaryName=''] | 1698 | * @cfg {String} [scayt_userDictionaryName=''] |
@@ -1657,14 +1700,16 @@ CKEDITOR.on('scaytReady', function() { | |||
1657 | */ | 1700 | */ |
1658 | 1701 | ||
1659 | /** | 1702 | /** |
1660 | * The parameter defines the order SCAYT context menu items by groups. | 1703 | * Defines the order of SCAYT context menu items by groups. |
1661 | * This must be a string with one or more of the following | 1704 | * This must be a string with one or more of the following |
1662 | * words separated by a pipe character (`'|'`): | 1705 | * words separated by a pipe character (`'|'`): |
1663 | * | 1706 | * |
1664 | * * `suggest` – main suggestion word list, | 1707 | * * `suggest` – The main suggestion word list. |
1665 | * * `moresuggest` – more suggestions word list, | 1708 | * * `moresuggest` – The "More suggestions" word list. |
1666 | * * `control` – SCAYT commands, such as "Ignore" and "Add Word". | 1709 | * * `control` – SCAYT commands, such as "Ignore" and "Add Word". |
1667 | * | 1710 | * |
1711 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1712 | * | ||
1668 | * Example: | 1713 | * Example: |
1669 | * | 1714 | * |
1670 | * config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest'; | 1715 | * config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest'; |
@@ -1674,9 +1719,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1674 | */ | 1719 | */ |
1675 | 1720 | ||
1676 | /** | 1721 | /** |
1677 | * If set to `true` – overrides checkDirty functionality of CK | 1722 | * If set to `true`, it overrides the {@link CKEDITOR.editor#checkDirty checkDirty} functionality of CKEditor |
1678 | * to fix SCAYT issues with incorrect checkDirty behavior. If set to `false`, | 1723 | * to fix SCAYT issues with incorrect `checkDirty` behavior. If set to `false`, |
1679 | * provides better performance on big preloaded text. | 1724 | * it provides better performance on big preloaded text. |
1725 | * | ||
1726 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1680 | * | 1727 | * |
1681 | * config.scayt_handleCheckDirty = 'false'; | 1728 | * config.scayt_handleCheckDirty = 'false'; |
1682 | * | 1729 | * |
@@ -1685,9 +1732,12 @@ CKEDITOR.on('scaytReady', function() { | |||
1685 | */ | 1732 | */ |
1686 | 1733 | ||
1687 | /** | 1734 | /** |
1688 | * If set to `true` – overrides undo\redo functionality of CK | 1735 | * Configures undo/redo behavior of SCAYT in CKEditor. |
1689 | * to fix SCAYT issues with incorrect undo\redo behavior. If set to `false`, | 1736 | * If set to `true`, it overrides the undo/redo functionality of CKEditor |
1690 | * provides better performance on undo\redo text. | 1737 | * to fix SCAYT issues with incorrect undo/redo behavior. If set to `false`, |
1738 | * it provides better performance on text undo/redo. | ||
1739 | * | ||
1740 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1691 | * | 1741 | * |
1692 | * config.scayt_handleUndoRedo = 'false'; | 1742 | * config.scayt_handleUndoRedo = 'false'; |
1693 | * | 1743 | * |
@@ -1696,62 +1746,81 @@ CKEDITOR.on('scaytReady', function() { | |||
1696 | */ | 1746 | */ |
1697 | 1747 | ||
1698 | /** | 1748 | /** |
1699 | * The parameter that turns off\on 'ignore-all-caps-words' option by default | 1749 | * Enables the "Ignore All-Caps Words" option by default. |
1700 | * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority. | 1750 | * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be |
1751 | * effective because option storage has a higher priority. | ||
1701 | * | 1752 | * |
1702 | * config.scayt_ignoreAllCapsWords = false; | 1753 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). |
1703 | * | 1754 | * |
1755 | * config.scayt_ignoreAllCapsWords = true; | ||
1756 | * | ||
1757 | * @since 4.5.6 | ||
1704 | * @cfg {Boolean} [scayt_ignoreAllCapsWords=false] | 1758 | * @cfg {Boolean} [scayt_ignoreAllCapsWords=false] |
1705 | * @member CKEDITOR.config | 1759 | * @member CKEDITOR.config |
1706 | */ | 1760 | */ |
1707 | 1761 | ||
1708 | /** | 1762 | /** |
1709 | * The parameter that turns off\on 'ignore-domain-names' option by default | 1763 | * Enables the "Ignore Domain Names" option by default. |
1710 | * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority. | 1764 | * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be |
1765 | * effective because option storage has a higher priority. | ||
1766 | * | ||
1767 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1711 | * | 1768 | * |
1712 | * config.scayt_ignoreDomainNames = false; | 1769 | * config.scayt_ignoreDomainNames = true; |
1713 | * | 1770 | * |
1771 | * @since 4.5.6 | ||
1714 | * @cfg {Boolean} [scayt_ignoreDomainNames=false] | 1772 | * @cfg {Boolean} [scayt_ignoreDomainNames=false] |
1715 | * @member CKEDITOR.config | 1773 | * @member CKEDITOR.config |
1716 | */ | 1774 | */ |
1717 | 1775 | ||
1718 | /** | 1776 | /** |
1719 | * The parameter that turns off\on 'ignore-words-with-mixed-cases' option by default | 1777 | * Enables the "Ignore Words with Mixed Case" option by default. |
1720 | * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority. | 1778 | * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be |
1779 | * effective because option storage has a higher priority. | ||
1721 | * | 1780 | * |
1722 | * config.scayt_ignoreWordsWithMixedCases = false; | 1781 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). |
1723 | * | 1782 | * |
1783 | * config.scayt_ignoreWordsWithMixedCases = true; | ||
1784 | * | ||
1785 | * @since 4.5.6 | ||
1724 | * @cfg {Boolean} [scayt_ignoreWordsWithMixedCases=false] | 1786 | * @cfg {Boolean} [scayt_ignoreWordsWithMixedCases=false] |
1725 | * @member CKEDITOR.config | 1787 | * @member CKEDITOR.config |
1726 | */ | 1788 | */ |
1727 | 1789 | ||
1728 | /** | 1790 | /** |
1729 | * The parameter that turns off\on 'ignore-words-with-numbers' option by default | 1791 | * Enables the "Ignore Words with Numbers" option by default. |
1730 | * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority. | 1792 | * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be |
1793 | * effective because option storage has a higher priority. | ||
1794 | * | ||
1795 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1731 | * | 1796 | * |
1732 | * config.scayt_ignoreWordsWithNumbers = false; | 1797 | * config.scayt_ignoreWordsWithNumbers = true; |
1733 | * | 1798 | * |
1799 | * @since 4.5.6 | ||
1734 | * @cfg {Boolean} [scayt_ignoreWordsWithNumbers=false] | 1800 | * @cfg {Boolean} [scayt_ignoreWordsWithNumbers=false] |
1735 | * @member CKEDITOR.config | 1801 | * @member CKEDITOR.config |
1736 | */ | 1802 | */ |
1737 | 1803 | ||
1738 | /** | 1804 | /** |
1739 | * Disabling of SCAYT Options storing during several sessions. Options storing will be turned off after page refresh. | 1805 | * Disables storing of SCAYT options between sessions. Option storing will be turned off after a page refresh. |
1806 | * The following settings can be used: | ||
1807 | * | ||
1808 | * * `'options'` – Disables storing of all SCAYT Ignore options. | ||
1809 | * * `'ignore-all-caps-words'` – Disables storing of the "Ignore All-Caps Words" option. | ||
1810 | * * `'ignore-domain-names'` – Disables storing of the "Ignore Domain Names" option. | ||
1811 | * * `'ignore-words-with-mixed-cases'` – Disables storing of the "Ignore Words with Mixed Case" option. | ||
1812 | * * `'ignore-words-with-numbers'` – Disables storing of the "Ignore Words with Numbers" option. | ||
1813 | * * `'lang'` – Disables storing of the SCAYT spell check language. | ||
1814 | * * `'all'` – Disables storing of all SCAYT options. | ||
1740 | * | 1815 | * |
1741 | * * `'options'` - disables all SCAYT Ignore options | 1816 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). |
1742 | * * `'ignore-all-caps-words'` - disables 'Ignore All-Caps Words' option | ||
1743 | * * `'ignore-domain-names'` - disables 'Ignore Domain Names' option | ||
1744 | * * `'ignore-words-with-mixed-cases'` - disables 'Ignore Words with Mixed Case' option | ||
1745 | * * `'ignore-words-with-numbers'` - disables 'Ignore Words with Numbers' option | ||
1746 | * * `'lang'` - disables SCAYT spell check language storing | ||
1747 | * * `'all'` - disables all SCAYT options storing | ||
1748 | * | 1817 | * |
1749 | * Example: | 1818 | * Example: |
1750 | * | 1819 | * |
1751 | * // One options disabling. | 1820 | * // Disabling one option. |
1752 | * config.scayt_disableOptionsStorage = 'all'; | 1821 | * config.scayt_disableOptionsStorage = 'all'; |
1753 | * | 1822 | * |
1754 | * // Several options disabling. | 1823 | * // Disabling several options. |
1755 | * config.scayt_disableOptionsStorage = ['lang', 'ignore-domain-names', 'ignore-words-with-numbers']; | 1824 | * config.scayt_disableOptionsStorage = ['lang', 'ignore-domain-names', 'ignore-words-with-numbers']; |
1756 | * | 1825 | * |
1757 | * | 1826 | * |
@@ -1759,9 +1828,11 @@ CKEDITOR.on('scaytReady', function() { | |||
1759 | * @member CKEDITOR.config | 1828 | * @member CKEDITOR.config |
1760 | */ | 1829 | */ |
1761 | 1830 | ||
1762 | /** | 1831 | /** |
1763 | * Specifies the names of tags that will be skipped while spell checking. This is a string containing tag names | 1832 | * Specifies the names of tags that will be skipped while spell checking. This is a string containing tag names |
1764 | * separated by commas (`','`). Please note that `'style'` tag would be added to specified tags list. | 1833 | * separated by commas (`','`). Please note that the `'style'` tag would be added to specified tags list. |
1834 | * | ||
1835 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1765 | * | 1836 | * |
1766 | * config.scayt_elementsToIgnore = 'del,pre'; | 1837 | * config.scayt_elementsToIgnore = 'del,pre'; |
1767 | * | 1838 | * |
@@ -1769,8 +1840,10 @@ CKEDITOR.on('scaytReady', function() { | |||
1769 | * @member CKEDITOR.config | 1840 | * @member CKEDITOR.config |
1770 | */ | 1841 | */ |
1771 | 1842 | ||
1772 | /** | 1843 | /** |
1773 | * The parameter turns on/off multi language support in SCAYT. If 'true', turns on SCAYT multi language support after loading the editor. | 1844 | * Enables multi-language support in SCAYT. If set to `true`, turns on SCAYT multi-language support after loading the editor. |
1845 | * | ||
1846 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1774 | * | 1847 | * |
1775 | * config.scayt_multiLanguageMode = true; | 1848 | * config.scayt_multiLanguageMode = true; |
1776 | * | 1849 | * |
@@ -1778,18 +1851,22 @@ CKEDITOR.on('scaytReady', function() { | |||
1778 | * @member CKEDITOR.config | 1851 | * @member CKEDITOR.config |
1779 | */ | 1852 | */ |
1780 | 1853 | ||
1781 | /** | 1854 | /** |
1782 | * Defines additional styles for misspellings for specified languages. Styles will be applied only if 'scayt_multiLanguageMode' parameter is set to 'true' | 1855 | * Defines additional styles for misspellings for specified languages. Styles will be applied only if |
1783 | * and 'language' plugin included and loaded into editor. All misspellings still will be underlined with red waveline by default. | 1856 | * the {@link CKEDITOR.config#scayt_multiLanguageMode} option is set to `true` and the [Language](http://ckeditor.com/addon/language) |
1857 | * plugin is included and loaded in the editor. By default, all misspellings will still be underlined with the red waveline. | ||
1858 | * | ||
1859 | * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html). | ||
1784 | * | 1860 | * |
1785 | * Example: | 1861 | * Example: |
1786 | * | 1862 | * |
1787 | * // Display misspellings in French language with green color and underlined with red waveline | 1863 | * // Display misspellings in French language with green color and underlined with red waveline. |
1788 | * config.scayt_multiLanguageStyles = { | 1864 | * config.scayt_multiLanguageStyles = { |
1789 | * 'fr': 'color: green' | 1865 | * 'fr': 'color: green' |
1790 | * }; | 1866 | * }; |
1791 | * | 1867 | * |
1792 | * // Display misspellings in Italian language with green color and underlined with red waveline and German misspellings with red color only | 1868 | * // Display misspellings in Italian language with green color and underlined with red waveline |
1869 | * // and German misspellings with red color only. | ||
1793 | * config.scayt_multiLanguageStyles = { | 1870 | * config.scayt_multiLanguageStyles = { |
1794 | * 'it': 'color: green', | 1871 | * 'it': 'color: green', |
1795 | * 'de': 'background-image: none; color: red' | 1872 | * 'de': 'background-image: none; color: red' |