Release notes

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;

Bug Fixes

WProofreader v2.2.3712

• [WP-2926]: WProofreader: The bullet points outside of the correction popup box
• [WP-3006]: WProofreader: autoDestroy functionality doesn’t work properly in IE 11 which results in ‘Unspecified errors’ in the console
• [WP-2978]: WProofreader: Spinner in the badge is endlessly spinning after the dialog is closed

Enhancements

• Grammar checking option is enabled by default for WProofreader.
• WProofreader version has been changed to v2.2.
• Windows Installer. Updated “Configure Service SSL Certificate” in the Windows wizard. Add a checkbox that allows the client to skip this step and use the SSL certificate installed on your Web or Java Application Server. If selected, the connection with the service will be configured via the FastGCI protocol.

Bug Fixes

WProofreader

• [WP-2950]: WProofreader: XSS vulnerability in the Dictionary tab
  [WP-2938]: WProofreader: Lost accessibility to the badge using ‘Tab’ and ‘Enter’
  GitHub #1: [CKEditor 4] WProofreader is active in source mode highlighting HTML tags [CKEditor 4]
• GitHub #8: [CKEditor 5] Word correction doesn’t work after list item indentation
• GitHub #7: [CKEditor 5] Crash after correcting a word
• GitHub #10: [CKEditor 5] Modifier keys close WProofreader balloon
• GitHub #12: [CKEditor 5] WProofreader balloon opens while dropdown is opened
• GitHub #14: [CKEditor 5] Correcting a word doesn’t work well with markers
• GitHub #17: [CKEditor 5] No need for a workaround to assign the editor instance to a HTMLElement

Enhancements

• [WP-2888]: UserDictHost parameter renamed to UserDictServerAddress in AppServerX.xml 
• Change the priority of the suggestions for spellings such as ‘hte’ and ‘teh with ‘the’.

Bug Fixes

• [WP-2933]: WProofreader: getBoundingClientRect problem on the element which isn’t added to the document in IE11

Enhancements

• The medical dictionary for Americal and Brishish English has been enlarged with 3,314 new medical terms.

WProofreader v2.1

• Extended and improved WEBSPELLCHECKER.init() method for editable control creation. This method can be used for manual auto-start of WProofreader in any type of editable control including WYSIWYG editors.

Bug Fixes

• [WP-2874]: WProofreader: Problem corrections are shown for all clicked problems
• [WP-2823]: SCAYT plugin for CKEditor 4: scayt_elementsToIgnore CKEDITOR config’s parameter doesn’t work.

Enhancements

• WebSpellChecker Server installation is compatible with Windows Server 2019 and Ubuntu 19.04.
• Updated the version of the grammar engine, LanguageTool to 4.6 as for June 26, 2019.
• The Ukrainian language is added to the list of default languages and shipped with the standard package. Both spelling and grammar checking is available for Ukrainian. Check the demo with Ukrainian here.
• The name of JavaEE servlet is changed from ‘spellcheck.war’ to ‘wscservice.war’.

Installers

Updated Windows and Linux installation wizards. The following steps and changes are introduced:

• Step with the Components selection is replaced with the Products selection. 
• Step to specify the protocol selection (HTTP or HTTP).
• Step to specify the path to the SSL certificate and SSL password if SSL connection is selected.
• Step to confirm the port that will be used to communicate with AppServer service (by default: 2880 port).
• Step to verify if the Java Virtual Machine (JVM) is detected for the grammar engine self-check. If the JVM is not detected automatically, the installer will send a notification that the JVM is not found and ask to provide a path.
• All the confirmation messages are redone to be consistent in the Linux wizard, e.g. Enter ‘y’ or ‘n’. [y]:
• Default virtual directory for the WebSpellChecker service is changed from ‘spellcheck’ to ‘wscservice’.
• Improved and clarified text messages in the Linux wizard.
• Removed ‘wscservice.war’ from the installation procedure if the connection is configured directly with AppServer (not via FastCGI protocol using SSRV.CGI component).

Refer to the up-to-date setup guides for WebSpellChecker Server on Windows and Linux-based environments.

Guidelines

The following guidelines have been updated and added:

• Installation guidelines of WebSpellChecker Server on Windows-based environments under IIS, Apache HTTP Server and Apache Tomcat
• Installation guidelines of WebSpellChecker Server on Linux-based environments under Apache HTTP Server, Nginx and Apache Tomcat
• WebSpellChecker Server Architecture Diagram 
• WebSpellChecker Server Hardware Requirements
• WebSpellChecker Server System Requirements
• Main AppServer Commands
• Excluding Words from the Language Dictionary
• Configuring Server Global Custom Dictionary
• Configuring Server Personal User Dictionaries

Bug Fixes

AppServer

• [WP-2879]: AppServerX.xml: Duplicated EnableUserDictServer in the AppServerX.xml file

WProofreader

• [WP-2831]: WProofreader: After pressing ‘Ctrl+Z’ problem markup is not refreshed
• [WP-2881]: WProofreader: Incorrect problem markup for CKEditor 5 with multi-cursor

Enhancements

• [WP-2868]: Improved performance. Changed the default requestSentencesCount and requestWordsCount values to 10 and 100 accordingly. The maximum number of sentences per request has been increased to 10 and number of words per request changed from 10 to 100.

Bug Fixes

AppServer

• [WP-2852]: Incorrect path to PathToJavaVirtualMachine is written to AppServerX.xml if Java isn’t installed in the default directory

Installers

• [WP-2854]: Installation doesn’t fail or show warning if incorrect libjvm.so is specified during installation in Linux
• [WP-2816]: Silent installation on Linux: #Comment option doesn’t work properly in the config file and fails the installation

WProofreader

• [WP-2829]: WProofreader: Problem underline is cut off by area of checking
• [WP-2832]: WProofreader: Drag&drop doesn’t remove existing problems underlining 
• [WProofreader]: Incomplete hover of the spelling problem of several words separated by a line break
• [WP-2872]: WProofreader: Problem markup appears in wrong position in <textarea>
• [WP-2288]: WProofreader: ‘Finish checking’ button is blocking the main functionality of ‘Proofread in a dialog’ mode
• [WP-2837]: WProofreader: Sections separation lines on the Dictionary tab are missing in Internet Explorer