Release notes

View the up to date information of the product enhancements, bug fixes and new features added with each release.

v5.25.0

Breaking changes

[On-premise product version] Updated the application server (AppServer) configuration file, AppServer.X.xml:

  • Added a new parameter / tag called CheckKit. It allows flexibly configuring the language settings.
  • Renamed a list of the existing tags in the AppServer.X.xml 
    • GrammarCheckProvider → GrammarCheck
    • SpellEngineOptions → SpellCheck
    • FullPath → Path (it can work in both sides with a absolute path and relative path)
    • SpellCheckEnginePriority → SpellCheckPriority
    • AutoCompleteCheckProviderOptions → Autocomplete + <Locale>en</Locale>
    • AutoCorrect → Autocorrect

Enhancements

  • BETA. English dialects support AI-based English under the hood. Implemented for next dialects:  American, British, Canadian and Australian English. By default it’s disabled but you can enable it as follows:
    • HTTP API: add “enforce_ai=true” to a query string;
    • WProofreader SDK integration: add “enforceAI: true” option to the configuration script.
  • New version of WProofreader core v3.7.4760
    • Added option/parameter to turn ON/OFF enhanced text checking powered by AI.
    • Updated the default path for the WProofreader core for the cloud product version from “servicePath”: “spellcheck31/script/ssrv.cgi” to “servicePath”: “api”.
  • Released v2.2.0 of the WProofreader plugin for CKEditor 5.  Added support of the Restricted editing mode.
  • Improved AI-based English proofreading mechanism. Better handling cases with hyphenated compound words (e.g. mother-in-law), various typographical symbols and punctuation, contraction of verbs (e.g. “it’s”).    
  • [On-premise product version] Updated the demo samples inside the package  to match the online version. By default the path to access the demos as follows: http: localhost/wscservice/samples/

Bug fixes

  • [WP-4399] WProofreader core: Styles were broken in the title of the JIRA issue [detected using browser extension]
  • [WP-4428] WProofreader core: Disabled autocorrect feature for Slate.js
  • [WP-4418] WProofreader core: Focus state shifted in Google Chat  [detected using browser extension]
  • [WP-4405] AppServer: “System exception“ error occurred during license activation
  • [WP-4442] [Cloud] BrE spelling: “tired” word marked as misspelled
  • [WP-4451] [Cloud] BrE spelling: “benifitting”/”benifitted” words are marked as misspelled
  • [WP-4443] AI engine: Incorrect handling suggestions to errors with zero length
  • [WP-4411] HTTP API: Checking text with “%” causes BAD URI syntax error

v5.24.0

Enhancements

Updated WProofreader core v3.6.4736

  • Changed the badge behavior and view. By default, it starts in a small size and has a few states: orange – all is OK, no suggestions found; red – some suggestions found. On hover, users can check the exact number of alerts/suggestions detected. To return it to a large size use the option fullSizeBadge: true.
  • Implemented the 1st version of the global badge under globalBadge option name. If enabled, there will be only one global badge on the page that aggregates all the suggestions on the page instead of having separate badges for each field.  By default, it’s disabled: globalBadge: false.
  • Changed the default state of the suggestion popup view by enabling additional actions like: proofread in dialog, settings, toggle.
  • Deprecated the badge pulsation effect and related disableBadgePulsing​​ option. Also, with the introduction of the small badge, removed the mechanism with the dynamic badge-size depending on the content and the text field.
  • Learn more in the updated version of WProofreader API documentation.

Languages

Updated the sources of the Hunspell dictionaries for the next languages:

Other

  • [On-Premise product version] HTTP API demo added to the demo samples, the same as we have in our public demos.

Bug fixes

  • [WP-4384,GitHub#32] WProofreader plugin for CKEditor 5: Accessibility concerns related to WProofreader badge element
  • [WP-4388] WProofreader core: Autocorrect messes up corrected words
  • [WP-4392] Spelling: Portuguese and Brazilian Portuguese don’t handle words with “ções”and “não” ending

Breaking changes

[On-premise product version] Updated Docker configuration:

  • Settings (e.g. protocol, domain, web-port, etc.) can now be changed on the container run. More details in README.
  • Application server (AppServer) logs are now linked to stdout, so they can be found in docker logs. Note that the license activation logs that are generated during image creation are stored in Logs/img_build_logs.tar.gz.
  • config.ini and configSSL.ini were removed, all build parameters are now ARGs in the Dockerfile and also can be set as ENV variables.

v5.23.0

Enhancements

Languages/Engines:

  • AI-based German. Integrated version 2 of the AI German language model with improved processing quality, F0.5 score increased by 0.05 points. Now the model produces fewer false positive results (incorrect suggestions).
  • Grammar engine. Updated 3rd party engine, LanguageTool, to version 5.8.0
    • Added and improved grammar rules for the next languages: Catalan, English, German, French, Polish, Portuguese, Russian, Spanish, Ukrainian.
    • Updated 3rd party component to fix vulnerability: CVE 2022-25647. Removed vulnerable Jetty libraries from the package. 
  • Dictionaries. Extended the German and English medical dictionaries with new terms reported by the clients (e.g. COVID-19, Moderna, AstraZeneca).

Custom dictionary API:

  • Words added to custom dictionaries can be divided by next separators: \n, Space, Tab, comma.
  • Formed the list of supported characters that can be added to the dictionary (letters, digits and some punctuation marks). Words containing only digits or punctuation as well as their combinations are not supported.

Bug fixes

  • [WP-4349, GitHub #11951] WProofreader core: The caret moves to a different block when pressing space after a word with grammar error in CKEditor 5
  • [WP-4352] WProofreader core: Incorrect behavior of cursor restore during autocorrect in Draft.js

Breaking changes

[On-premise product version] Updated the automated install script:

  • Updated web_server_type values : 1 – Apache HTTP Server, 2 – NGINX, 3 – Other
  • Renamed web server related parameters:
    • restart_apacherestart_web_server
    • apache_config_dirweb_server_config_dir

v5.19.2

Note! Both cloud and on-premise product versions release. The cloud version includes everything from v5.19.1 and the updated grammar check engine to version 5.7.

Enhancements

  • Grammar engine. Updated 3rd party engine, LanguageTool, to version 5.7. Added and improved grammar rules for the next languages: Catalan, French, German, Polish, Portuguese, Russian, Spanish and Ukrainian. It also includes updated versions of dependencies #6423 and fix for multithreading issue #6423 in v5.6.

v5.19.1

Note! On-premise product release only.

Enhancements

  • HTTP API. Added text splitting for the parameter text of check API command in case of AI-based languages such as English, German and Spanish. Initially only token parameter could be used where text was manually divided into sentences.
  • Java-based grammar engine troubleshooting. Extended logging mechanism with full stack trace in case of exceptions in the Java grammar module.
  • Increased default allocated memory value for Java Virtual Machine (JVM) from 512 MB to 700 MB.
  • Improvised security. Excluded from the build vulnerable versions of 3rd party dependencies in the grammar engine module: logback-core:1.2, protobuf-java:3.17.2, jackson-databind:2.12.0.

Bug fixes

  • [WP-3967] WProofreader core: Vertical scroll inside <input> element
  • [WP-4210] WProofreader core: Broken styles for ‘ckeditor5’, ‘gray’ and ‘dark’ themes
  • [WP-4213] WProofreader core: Vertical scroll is shown in the <input> element
  • [WP-4214] WProofreader core: Horizontal scroll comes up after initialization in Google Chat editable area
  • [WP-4220] WProofreader core: Underlines are shifted when vertical scroll overlaps the content of <textarea> element

v5.19.0

Note! Only on-premise product version was released. The cloud product version is still in progress. We had to postpone the release due to Russia’s aggressive military invasion in Ukraine (WebSpellChecker is made by Ukrainians & in Ukraine).

Enhancements

  • Autocomplete suggestions (beta). Brand new functionality is implemented and added to WProofreader-based products – autocomplete suggestions while typing for English. It suggests only a word or short phrase, suggestion can be accepted using the left arrow “>”on the keyboard. Going forward it will be extended to more comprehensive phrases or common sentences. The feature is disabled by default, it can be easily enabled from the user interface by end users or added by developer to the configuration using autocomplete option.
  • Grammar engine. Updated 3rd party engine, LanguageTool, to version 5.6. Added and improved grammar rules for the next languages: Catalan, Dutch, English, French, German, Portuguese, Russian, Spanish and Ukrainian.
  • Security improvements. Updated LanguageTool grammar engine with all its dependencies to eliminate common vulnerabilities. 
  • WProofreader core. The version is updated to v3.5.xxx with the release of autocomplete suggestions. Disabled badge pulsation effect: “disableBadgePulsing: true”.

Bug fixes

  • [WP-4176] Incorrect words count is recorded usage statistics for the cloud product version
  • [WP-4181] WProofreader core: Broken CSS styles in a client environment
  • [WP-4171] WProofreader core: Markup fails in texareas with more than 65 535 characters [Chrome]

v5.18.0

Breaking changes

  • Final deprecation and removal of Spell Checker (“WSC”) plugin for CKEditor 4 and related components such as SSRV.CGI from the cloud and on-premise product versions. Check details in the troubleshooting article and official blog post.
  • Deployment on Java application servers are no longer supported. Removed the Java servlet “wscservice.war” file from Linux installation package along with automated installation steps on Java application servers. Manual configuration steps are still possible using the “Other” option but any misconfiguration issues are not covered by standard support service. 
    • Right now the installation on Linux-based environments is supported and automated for Apache HTTP Server only. Going further we expect to automate deployment on NGINX web server. 
    • For Windows-based environments the default web server is IIS.

Bug fixes

  • [WP-4166] WProofreader core: After each error replace markup is removed in CKEditor 5
  • [WP-4167] WProofreader core: UI of dialog is broken when all suggestions are accepted in CKEditor 5
  • [WP-4168] WProofreader core: Wrong size of the error block for multi-string text
  • [WP-3363] AppServerX.xml: EnableUserActionStatistic parameter is missing in the on-premise product version

v5.17.0

Enhancements

  • [Cloud] Speed up the process of the service activation after the subscription. Previously it took around 5-10 minutes for the subscription to be activated. Now the service starts working right away.
  • Enable English, Spanish, French medical dictionaries for appropriate languages and their dialects. 
  • Enable dictionary-based spell check engine priority for AI-based Spanish and German. 

Breaking changes

  • The list of supported languages was shortened from 160+ to approximately 80+ languages. Only unpopular and unused languages were removed. However, clients who use on-premise product versions have an option to add missing languages manually (Hunspell spell check engine). The updated list of supported languages.
  • Withdrawn the limit on the number of languages that can be used within cloud or on-premise product versions. The on-premise version package is shipped with all supported languages. However, some of them are in the disabled state. They can be easily enabled using the instructions in the following guide. 

Bug fixes

  • [WP-4140] Words with apostrophe can’t be added to user dictionary

v5.16.5

Enhancements

  • Updated the spell check engine provider to Hunspell for Finnish.
  • [On-premise] Redo SpellCheckCache settings in AppServerX.xml by adding boolean parameter – EnableSpellCheckCache. Possible values: true and false, the default is true.

Bug fixes

  • [WP-4115] WProofreader core: Text is inserted into an incorrect position after word replace in Firefox
  • [WP-4131, WP-4132, WP-4133] WProofreader core: Replace doesn’t work in CKEditor 5, Slate, Draft.js editors in Firefox

v5.16.4

Enhancements

  • Extended the English medical dictionary with new terms reported by the client.
  • [Cloud] Updated the spell check engine provider to Hunspell for the following languages: Canadian and Australian English, Canadian French.
  • [On-premise] Updated the spell check engine provider to Hunspell for all supported languages (except Finnish).
  • [On-premise] Improve the configuration of reverse proxy in IIS. API request to the application server endpoint can be used like this: host_name/wscservice/api?cmd=ver

Bug fixes

  • [WP-4066] Incorrect suggestion: When using AI English on “$x” it suggests replacing it with “$”
  • [WP-4069] Misspelled words present in the English medical dictionary
  • [WP-4079] Incorrect suggestion: Duplicated word suggested if no punctuation at the end of sentence in AI German
  • [WP-4103] AppServer: Unknown exception in LicenserThread

v5.16.3

Enhancements

  1. Security improvements. Removed unused libs in 3rd party grammar engine, LanguageTool, that have known vulnerabilities (Jetty, Netty).
  2. User dictionary validation: 
    • Added restrictions to the max length for a word that can be added (up to 63 symbols). 
    • Added restrictions to the max length of the dictionary name (up to 50 symbols), allowed symbols and letters (excluded non-Latin letters, symbols like spaces etc.).

Bug fixes

  • [WP-4063] WProofreader core: Issue with destroyed CKEditor 5
  • [WP-4071] WProofreader core: Settings dialog closes after click on it in Froala Editor

v5.16.2.1

Enhancements

  • A new service entry point is introduced for the cloud-based services. It is applicable for direct API calls and for UI-based components like the WProofreader add-on. For the backward compatibility, the old way also works. 

Old way: https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=[command]&[parameter]=[value]

New way: https://svc.webspellchecker.net/api?cmd=[command]&[parameter]=[value]