Release notes

Enhancements

WProofreader v2.4

• Improved the overall performance of WProofreader at least by 3 times including the visual mechanism responsible for highlighting problems as a user is typing in rich text editors. 
• Improved the highlighting mechanism in the textarea elements, the delay between checks decreased from 2s to 500ms.
• Added a new theme option to change the default style theme of WProofreader. The available theme options: default, gray, custom. The custom theme allows modifying the default theme using CSS styles. For details, refer to the how-to guides how to tailor the theme to fit your needs for the Cloud and Server versions accordingly.
• Introduced new callback functions onAddWordToUserDictionary and onDeleteWordFromUserDictionary to track when a word is added or removed from a personal user dictionary. 
• Added an extra callback function onCommitOptions that allows monitoring the changes in the spellcheck ignore options and a selected language.
• Initialization using auto-search (autoSearch:true) will respect spellcheck=”false” attribute in HTML textarea and input elements and won’t be started at all. However, this won’t be applied to the rich text editors.
• Added a separate data-wsc=”false” attribute that will instruct auto-search functionality not to start in the element that has such an attribute. This attribute won’t be taken into consideration if the application is started manually using init() method.
• Extended the ignore elements list with code and pre elements that will be ignored during the check.

Languages

• Added a language auto-detection functionality that supports over 80 languages based on the CLD2 library. It is available as an option Auto Detect on the language list. This option will come in handy for those who are working with multilingual content as they no longer need to switch between languages. It can be set as a default language for all users, the language code is auto.
• The American English dictionary was enlarged with 65 new words which were the most added words to the user dictionaries. Some of them are: cybersecurity, blockchain, Pinterest, Reddit, telework.
• The hottest discussed topic and the most popular words added to the dictionaries were the words related to the coronavirus pandemic and healthcare. We’ve added coronavirus, COVID-19, сoronaviruses to the American English, British and Canadian English dictionaries. The rest healthcare and medical related terms are already present in our specialized medical dictionary.

Web API

• A single API request is limited to 50KB of text which is around 50K characters including spaces. The maximum size of the request can be extended in the Server version using a special parameter. Longer requests will be rejected and not processed. To overcome this, the request should be divided into smaller parts.
• A new command detect_language added for detecting a language of given text. For details, refer to the guides for the Cloud and Server versions accordingly.

AppServer

• Added a new parameter MaxApiRequestSize to regulate the size of the maximum allowed API request that will be processed by AppServer. 
• Updated POCO lib to the latest major release 1.10.1.

Supported Deployments

• Published a new Docker image with the Server version of WebSpellChecker/WProofreader with the SSL support. Now there are two prebuilt images with WebSpellChecker/WProofreader available on Docker Hub. You may find more information on that and how to create your custom image using Dockerfile in the updated guide Installing WebSpellChecker Server using Docker and in our GitHub repo. 

Bug Fixes

WProofreader

• [WP-3274] WProofreader: Suggestion popup has wrong height in Draft.js editor.

This is a hot fix release to revert the update introduced in v5.5.7 for the Australian English language where we changed the spellcheck engine source and dictionary to the original one. The reason for this rollback is the incompatibility of the medical dictionary and Australian English running under the new engine. 

Bug Fixes

WProofreader

• [WP-3197] WProofreader: Underlines are not removed for the words which are in the dictionary after it’s connected
• [WP-3198] WProofreader: JS error ”Cannot read property ‘setFocus’ of null at wscbundle.js:44” in console when a user deletes a user dictionary
• [WP-3256], GitHub #21: WProofreader: Incorrect highlighting of problems in track changes feature of CKEditor 5
• [WP-3263] WProofreader: Scroll to the next problem doesn’t work after replace/add word/Ignore all in “Proofread in dialog” mode
• [WP-3264] WProofreader: Problems remain highlighted in the editor after using Ignore all in the “Proofread in dialog” mode
• [WP-3192] WProofreader: Missing or multiple whitespace problem type is incorrectly displayed in the “Proofread in dialog” mode 

Languages Dictionaries

• [WP-3266] AppServer: ‘No_any_suggestions’ returns as suggestion for request with Greek language

Enhancements

Grammar Engine

The 3rd party grammar engine, LanguageTool, has been upgraded to v4.8. As a part of this upgrade new and improved grammar rules for the next languages have been added: Catalan, Chinese (new tokenization), Danish, English, French, German,  Portuguese, Russian, Ukrainian.

Bug Fixes

• [WP-3236] WProofreader / SCAYT plugin for CKEditor 4: Incorrect work with spaces in Japanese causes an incorrect position of underlines and further unresponsiveness

This is a minor release of both Cloud and Server packages intended to fix an issue with the custom dictionaries functionality that didn’t function for French Canadian, English Canadian, British English and Brazilian Portuguese.

Bug Fixes

• [WP-3232] Custom dictionaries functionality didn’t function for French Canadian (fr_CA), English Canadian (en_CA), British English (en_GB) and Brazilian Portuguese (pt_BR).
• [WP-3230] Arabic localization is missing for Japanese, Simplified Chinese and Ukrainian languages

Enhancements

WProofreader v2.3

• Added localization of the default language list on the Language tab of the settings dialog to a language that is set by the localization option.

Languages Updates

• Improved the quality of spelling check in the Arabic language by prioritization of suggestions given for a misspelled word.
• Updated and enlarged language dictionaries for the following languages: Norwegian Bokmål, Norwegian Nynorsk, Slovak, Indonesian, Catalan, Korean, Chilean Spanish, Ukrainian, Polish, Austrian German, Hungarian, Bulgarian, Azerbaijani or Azeri (Latin alphabet), Hindi, Macedonian, Croatian, Uzbek (Cyrillic alphabet), Latvian, Georgian, Mongolian. You can test the quality of the updated dictionaries on the additional dictionaries page.
• Changed the dictionary source for Australian English language to improve the quality of the check.

Enhancements

WProofreader v2.3.3915

• Added UI localization for the Simplified Chinese and Japanese languages.
• Minor improvements accessibility based on the accessibility validation tools (reports).
• The height of the section with the list of words on the Dictionaries tab is increased to 360 pixels to improve usability.

Languages Updates

1. Extended dictionaries of the Norwegian dialects:

• Norwegian Bokmål (nb_NO)
• Norwegian Nynorsk (nn_NO)

Check the quality of spell checking for Norwegian Bokmål and Nynorsk at the Additional languages page.

2. New additional languages for the Asian group. This release enables the long-awaited grammar checking for two new languages from the Asian group:

• Simplified Chinese (zh_CN) 
• Japanese (ja_JP)

Check the quality of grammar checking for Simplified Chinese and Japanese at our Additional languages demo page.

3. Enabled a new grammar rule for all English dialects that catches repeated whitespaces in writing. The rule description is “Whitespace repetition (bad formatting)”.

Bug Fixes

WProofreader

• [WP-3149] WProofreader: Highlighting of a selected language is cropped in Languages tab when using keyboard navigation
• [WP-3153] WProofreader: Redundant ‘aria-level’ and ‘aria-expanded’ tags with empty value present in button snippets
• [WP-3155] WProofreader: Some elements have insufficient color contrast 
• [WP-3157] WProofreader: Invalid ARIA attribute values for ‘aria-labelledby’ tag in checkboxes, radio buttons and inputs
• [WP-3158] WProofreader: Invalid ARIA roles used
• [WP-3180] WProofreader: Badge disappears in iframe
• [WP-3168] WProofreader: Actions in the badge are shifted in the expanded/active state
• [WP-3163] WProofreader: Insufficient styles protection of elements

SCAYT plugin for CKEditor 4

• [WP-3172] SCAYT plugin for CKEditor 4: Unsupported locale parameter ‘ru’ when browser localization is set to Russian

Enhancements

WProofreader v2.3

1. This version brings major user interface updates for WProofreader based on the user feedback that we collected:

• Both WProofreader dialog and the badge have more contrast colors for all elements, including the icons and the color of the text being checked.
• When using keyboard navigation to move around WProofreader dialog, badge, and Settings dialog, you can benefit from the addition highlighting of the elements currently in focus.
• We have extended and simplified each view of the Settings sections, including Languages, Options, and Dictionaries.
• Pop-up notifications on the changes made in the Settings sections now appear at the bottom of the dialog to avoid overlapping of the top section of WProofreader dialog.
• Improved experience and working with dictionaries allowing even easier to disconnect the dictionaries which may be no longer required and connect them any time later. 
• When proofreading in a dialog mode now, users see only one discovered problem and suggestions to it at a time allowing easier navigation and better user experience in text proofreading.

For details, refer to the updated version of WProofreader User guide for the Server and Cloud.

2. Improvements in accessibility and navigation. We have revised and updated the already existing navigation when using a keyboard only:

• The keyboard combinations are now simplified.
• We have introduced Space as one more key to confirm your actions or changes made in addition to the Enter key which could be used before.
• User interface response is now better as the highlighting of the selected element is more precise and contrasting with the rest of the UI.
• You can navigate between the discovered problems and their suggestions using either left and right arrow keys when proofreading in WProofreader dialog.

For details, refer to the updated version of WProofreader keyboard navigation guide for the Server and Cloud versions.

User Guides

We have updated our previous versions of WProofreader user guide and keyboard navigation with a new version to describe the most recent interface changes and keyboard accessibility improvements.

• User guide and Keyboard navigation for the Server version;
• User guide and Keyboard navigation for the Cloud version.

AppServer

• POCO C++ library has been- updated to v1.10.0.

Supported Deployments

The Server version of WebSpellChecker/WProofreader is available as a Docker image on Docker Hub. You may find more information on that in a new guide Installing WebSpellChecker Server using Docker and in our GitHub repo.

Bug Fixes

WProofreader

• [WP-3124] WProofreader: Virtual markup with underlined problems shifts if to open an editor in a full screen
• [WP-3127] WProofreader: Memory leaks in Internet Explorer 11 and MS Edge
• [WP-3135] WProofreader: The grammar problem description tooltip is not capitalized
• [WP-3129] WProofreader: Incorrect color of the number of errors in the badge when integrated into TinyMCE 4 (black instead of white)
• [WP-3145] WProofreader: Bootstrap label type overwrites dialog settings and languages list labels style
• [WP-3146] WProofreader: Foundation CSS styles breaks checkboxes alignment on the Options tab

AppServer

• [WP-3138]: AppServer: Сonstant AppServerX.xml warning message due to the default CacheSavePath ‘none’ value
• [WP-3120]: AppServer: Some SSL certificates failed to load from Windows Certificate Store to enable SSL connection with AppServer

This is a hot fix release for both Cloud and Server versions to solve the issue with incorrect work of the user dictionary functionality.

• [WP-3113]: User dictionaries: Word added using user dictionary functionality is remarked as a misspelled one after page refresh

Also, there is a minor change in the tag names that are used for checking status and version of the WebSpellChecker Server package.

Updated response for command status (status): http(s)://your_host_name:port/?cmd=status

{
    "SpellCheckEngine": {
        "active": true
    },
    "GrammarCheckEngine": {
        "active": true
    },
    "ThesaurusEngine": {
        "active": true
    }
}

Updated response for command version (ver): http(s)://your_host_name:port/?cmd=ver

{
    "Copyright": "(c) 2000-2019 WebSpellChecker LLC",
    "ProductWebsite": "webspellchecker.com",
    "ProgramVersion": "5.5.4.2 x64 master:4fb43001 (1893) #41",
    "PackageVersion": "5.5.4.2 master:58e1bc7 (639) #47"
}

Enhancements

WProofreader v2.2.3806

• Added the customInsertText event that provides certain flexibility in the process of the text insertion. Here you can find an example of using customInsertText event.
• Updated API documentation with the up-to-date information about the available options and default values.

The following options have been added:

The following options have been removed and no longer available:

Breaking Changes

Check Command

Introduced a new approach to processing grammar and spell check requests. We switched to per-sentence proofreading rather than meaningless per-word check. Now in a single request in such products as WProofreader and SCAYT plugin for CKEditor 4, we send up to 10 tokens (sentences) using a new unified command check for checking text for spelling and grammar problems at the same time.

If you are using Web API, you can consider migrating to a new check command rather than using spelling and grammar checking commands separately. Check this Check Command guide which outlines the list of all available parameters and possible values, structure of request and its response. Along with that we added Overview of HTTP Response Status Codes that you can find helpful in case of errors.

Bug Fixes

SCAYT plugin for CKEditor 4

• [WP-3049]: SCAYT plugin for CKEditor 4: The text copied and pasted in CKEditor won’t be checked for errors
• [WP-3034]: SCAYT plugin for CKEditor 4: XSS vulnerability: Grammar description with double quotes and <suggestion></suggestion> tag breaks menu in CKEditor 4

AppServer

• [WP-3020]: AppServerX: Warning in console ‘CORS response parsing error: SyntaxError: Unexpected token < in JSON at position 0’
• [WP-3027]: AppServerX.xml: Incorrect description of SSLCertificateStore setting in comments

Enhancements

Installation Wizard and AppServer

• Updated step with the SSL connection configuration in the installation wizard for Windows-based deployments. Added an extra option with an SSL certificate export from Windows Certificate Store. Now you have three options to configure SSL connection: (1) export SSL certificate from Windows Certificate Store; (2) specify a path to an SSL certificate file (*.pfx) in AppServerX.xml; (3) apply SSL certificate that is used by a web or Java application server.
• Additional parameters have been added to AppServerX.xml configuration file to manage settings of SSL connection for both Windows and Linux-based deployments. Please check the list of all new parameters in the AppServer Parameters guide.

Bug Fixes

WProofreader v2.2.3717

• [WP-2984]: WProofreader: Settings tab in the dialog are not localized to other languages
• [WP-2984]: WProofreader: Disable WProofreader in ‘Code View’ in Froala Editor v3

AppServer

• [WP-3012]: In the logs of AppServer (Main.log) there is a record ‘package version: unknown’

Languages

• [WP-3014]: Language dictionaries: Remove ‘ddts’ word from the standard dictionary (American and British English)

Bug Fixes

WProofreader

• [WP-3008]: WProofreader: Can’t remove branding for the Server version. Server returns canRemoveBranding: false;