Release notes

Enhancements

WProofreader v3.2.4522

• Default language changed from American English (en_US) to Auto Detect (auto). This will be applied if no language is predefined in configuration using lang option.
• Added a new API option autoLangPriorities that allows to define priorities of languages detected by auto-detect. For example, if language auto-detect defines “en”, then British English (en_GB) should be used during check request. It is applicable only if “auto” is available and used as a default language.
• The size of the squeezed badge is decreased by 40%. This state is enabled automatically for fields with small height and when entered text overlap the badge.  

Find out more about all available customization options for WProofreader in API documentation.

Web API

• Added a new parameter auto_lang_priorities to the check command for specifying the language priorities when language auto-detect is used. 

Engines/Languages

• Updated the source of Hunspell dictionary for Turkish.  Source: LibreOffice Extensions > Turkish Spellchecker v1.2.
• Updated the source of Hunspell dictionary for Swiss German. Source: LibreOffice Extensions > German Spellchecker (de-CH frami) v2017.01.12
• 3rd party grammar engine > LanguageTool: Disabled a few grammar rules by default in British English related to Oxford spelling: OXFORD_SPELLING_Z_NOT_S and OXFORD_SPELLING_GRAM.

Bug fixes

WProofreader

• [WP-3887] WProofreader: Extra badge appears after copy/paste in Quill editor field

Enhancements

WProofreader v3.2

• Implemented support of the dark theme. Can be enabled by adding: theme: ‘dark’,
• The size of the orange floating badge is now dynamically adjusted based on the size of the input area and text position.
• Mirrored the orange badge and its elements in case of right-to-left (RTL).
• Updated user interface localization for Norwegian (no), Swedish (sv) and Danish (da) based on the recommendations from the client.
• Added a new user interface localization for Swiss German (de-ch) prepared by one of the customers.

Find our more about all available customization options for WProofreader in API documentation.

Engines

• Updated 3rd party engine, LanguageTool, to version 5.3. Added and improved grammar rules for the next languages: Arabic, Catalan, Dutch, English, French, German, Portuguese, Russian, Spanish and Ukrainian.

Deployment

• Updated public Docker images with WebSpellChecker/WProofreader Server to the latest version.

Bug fixes

WProofreader

• [WP-3838] WProofreader jumps when user changes settings on the page with many instances
• [WP-3827] WProofreader: Dialog is not closing after switching to CKEditor 4 full view

Enhancements

WProofreader v3.1

• Implemented global proofread dialog that aggregates all suggestions from the editable element on the page. Enabled by default: globalProofreadDialog: true.
• Storing spell check ignore options and language selection globally for the same origin (domain/subdomain+protocol//:domain+port) in the browser local storage instead of per instance storage. Enabled by default: disableOptionsStorage [options, language].
• Implemented per page options and language synchronization mechanism. Enabled by default: syncOptions = true. It means that language selected in one instance, will be applied for all consequent and existing instances.
• Updated localization of UI for the Ukrainian and Russian languages.

Core & API

• Added localized description for spelling type mistakes “Spelling mistake”
• Updated and shortened error messages relates to the Cloud services usage (subscription, languages, domain permissions)

Deployment

• Created Dockerfile and deployment instructions for WebSpellChecker Server based on the latest CentOS.
• Updated public Docker images with WebSpellChecker/WProofreader Server to the latest version.

Bug fixes

Core & API

• [WP-2951] API: Wrong error message when user sends getdict API command without user dictionary name handler
• [WP-3780] Updated translation of supposed languages in Ukrainian
• [WP-3817] API: Ignore_all_caps option doesn’t flag any spelling issues if it is set to “1” for Russian/Ukrainian etc.

WProofreader

• [WP-3794] WProofreader: Elements position is shifted if initialized in elements with “display: inline;”
• [WP-3781] WProofreader: When removing a word from dictionary Russian localization says about removing a dictionary instead
• [WP-3786] WProofreader: ‘Settings’ title is shown on dialog window if it is reopened from the badge
• [WP-3795] WProofreader: Badge doesn’t refresh the suggestions count
• [WP-3814] WProofreader: Wrong focus after replace action in dialog
• [WP-3822] TypeError: Unable to get property ‘doctype’ of undefined or null reference for WProofreader in EdgeHTML
• [WP-3824] WProofreader: Icons for such actions as Add, Ignore, More displaced in hovered state in IE11

Bug fixes

Core & API

• [WP-3721] Automated license activation fails if a network proxy server is enabled. For more details, visit License activation through proxy server.
• [WP-3767] German is incorrectly spelled in French localization
• [WP-3799] AppServer: Language de_AT returns descriptions in Spanish instead of German
• [WP-3720] Disabling en_US causes status command to fail

Enhancements

WProofreader v3.0.4457

• Implemented support of right-to-left (RTL) mode for a new floating proofread dialog. Thus, user interface elements for such RTL languages as Arabic or Hebrew will be mirrored compared to the left-to-right languages.
• Updated localization of the WProofreader user interface, specifically suggestion pop-up and floating dialog, for English (en), French (fr), Arabic (ar), Hebrew (he), Ukrainian (uk) and Italian (it). Also created localization for Russian (ru).
• Added a new onToggle callback that allows listening to the application state changes from enabled to disabled.

Engines

• Implemented support of a user-level dictionary for the AI-based engine. Now users can add words to their dictionaries using the Add word button for spelling type problems. Those words won’t be underlined until this word in the dictionary.
• Added support of the Russian dictionary with strict Cyrillic ‘Yo’ / Unicode ‘Io’ as a separate language option with the language code: ry_RU, (source: https://extensions.libreoffice.org/en/extensions/show/russian-dictionary-pack). Available on demand.
• Updated 3rd party engine, LanguageTool, to version 5.2. Added and improved grammar rules for the next languages: Catalan, Dutch, English, French, German, Portuguese, Russian, Spanish and Ukrainian.

Bug fixes

WProofreader

• [WP-3737] WProofreader: Replace action doesn’t work in the unfocused state of inline CKEditor 4
• [WP-3747] WProofreader: Overwritten style of font from normal to bold and no line break in dialog
• [WP-3723, GitHub#18]: WProofreader plugin for CKE5: If backend is unavailable for more than 5 requests, the instances states won’t be synchronized

Other

• [WP-3748]: API: Dictionary name value is not protected against XSS injection
• [WP-3745]  AppServer: Request with the chosen language ‘auto’ fails

Enhancements

WProofreader v3.0

• Static proofread in dialog mode was replaced with a compact and intuitive floating one. Now the dialog collects only suggestions without extracting the whole text from the original text field.
• The color of detected grammar-type errors changed from green to blue.

AI-based proofreading engine

• AI-based engine outputs two types of suggestions: spelling and grammar. Suggested corrections will be flagged with red and blue underlines accordingly. Previously spelling suggestions were mixed with the classical dictionary-based spelling engine.
• Added new option <Enabled>true</Enabled> to SpellEngineOptions tag that regulates if classical spell check engine should be enabled in parallel with AI-based engine.

Core & API

• [GitHub#180] API | SCAYT | WProofreader: Alphabetical sorting of personal dictionary

Bug fixes

WProofreader

• [WP-3463] WProofreader: Misspelled words are not highlighted if contenteditable=’false’ mentioned in the same element as text to be spell checked
• [WP-3434, GitHub#26] WProofreader: There is no tooltip on hover to the badge with the problems counter
• [WP-3610] WProofreader: Broken styles of badge and suggestion pop-up on Square website
• [WP-3677] WProofreader: Disabled badge overlay text at the right corner of editable field
• [WP-3695] WProofreader: App fails to start in inline elements like span
• [WP-3701] WProofreader: App fails to start with enabled detectLocalizationLanguage option
• [WP-3707] WProofreader/SCAYT core: Incorrect sentence detection with <sub> and <sup> HTML elements
• [WP-3711] WProofreader: Suggestion can’t be applied if the badge is focused
• [WP-3718] WProofreader: App can’t be initialized properly in <textarea> if user ignore <div> elements

Other

• [WP-3667] XSS vulnerability in user dictionary functionality
• [WP-3712] Cloud-based products: Randomly all words are underlined with no suggestions as if the dictionaries are not found
• [GitHub#181] Soft hyphens should not be stored in user dictionary
• [WP-3714] Memory issues in the spell check engine discovered by AddressSanitizer
• [WP-1356] AppServer: CORS header is missing in OPTION requests from client to server

Enhancements & Bug fixes

• Got rid of the Enchant library that is used as a proxy to the Hunspell spell check engine. Now WebSpellChecker AppServer directly communicates with the Hunspell engine. It is used as a core spell check engine for a set of the additional languages. The Hunspell version is 1.7.
• [WP-3217] www,WWW,WW-like suggestions to Cyrillic words written with Latin languages
• [WP-2965] Product size is calculated incorrectly in the Windows installer

Enhancements & Bug fixes

• WProofreader user interface is localized to the Luxembourgish language. The language code for localizations is lb.
• [WP-3689] WProofreader: Styles broken when ‘padding: 0’, ‘margin: 0’ and ‘border: none’ are missing for the wrappers and badge

Breaking changes

Reconsidered the licensing mechanism for the server-based version of the WebSpellChecker package. The license is no longer validated by or tied to the hardware characteristics of a machine or server. 

This is the major step forward and improvement for those customers who are using WebSpellChecker in dynamic cloud environments or deploying it using containerized environments (e.g. Docker). Also, it means that the floating licensing mechanism is no longer needed.

Along with this the pricing model has been also adjusted to a new licensing approach. We’ve got rid of per server or per user pricing. For more details, please reach our sales department. 

If you are using Docker for WProofreader deployment, please check out the updated guide how to create a Docker image with built-in license.

Enhancements

WProofreader

• Updated UI of suggestion pop-up for all themes (standard, gray, ckeditor5). Now it’s more compact and with intuitive icons. 

Engines

• Implemented the first version AI-based suggestions categorization by two types: spelling and grammar&other. Thus, with AI-based engines enabled there will be two types of underlines (red and green). However, for spelling-type errors there will be mixed output used from AI-based engine and standard dictionary-based spell check engine.
• Introduced the beta version of AI-based engine for German which provides 2 times better accuracy compared to the standard dictionary and rules-based engines.
• Updated 3rd party engine, LanguageTool, to version 5.1. Added and improved grammar rules for the next languages: Catalan, Dutch, English, French, German, Italian, Portuguese, Russian, Spanish and Ukrainian.
• Improved descriptions provided by the grammar engine for the English language. Removed meaningless phrases like: Did you mean? or Consider using.

AppServer & Other

• The default number of suggestions for spelling type errors changed from 8 to 3.
• Implemented lazy loading of language models which are required for AI-based engines during the installation process instead of packing them into the installation package. It allowed to keep the size of the package relatively small and allow customers to decide if they want to install those languages at all.
• Added a new parameter to the languages tag that regulates priority of spell check engines over the other ones (e.g. grammar or AI-based). The parameter name is SpellCheckEnginePriority with two possible values: true and false.

Bug fixes

• [WP-3660]: Ukrainian dictionary for spell check causes memory corruption

Enhancements

WProofreader

• Improved mechanism of highlighting and replacing problems in textarea elements.

AppServer

• Added and improved notifications when using AppServer commands such start.sh and stop.sh on Linux. For example, when running start.sh script, there will be a message indicating that AppServer is starting and there will be an additional message confirming that AppServer started or there was an error. 

Bug fixes

WProofreader

• [WP-3588] WProofreader: Misaligned badge if iframe body is min-height 100%

Engines

• [WP-3586] Suggestions for grammar problems are repeated in the Description section
• [GitHub #177] Soft hyphens cause problems

Enhancements

WProofreader

• Added a new API option restoreNativeSpellCheck that restores a native browser spell checker if WProofreader is switched to the disable state.

AI-based English

AI-based engine for general English has been integrated into the package. Compared with traditional engines built on a set of static rules and dictionaries, the accuracy and quality of the new engine is 3x higher. The algorithm digs deep in the context of every sentence and corrects tiny spelling, grammar, and punctuation mistakes.

• Enabled by default in the server-based package and can be enabled on demand for Cloud-based subscription as a separate language option. The name of the language is AI-based English (en_AI).
• Available for WProofreader add-on for rich text editors and WebSpellChecker API only. 

Try it here.

Additional references:

• WebSpellChecker Server v5.7.0 hardware requirements
• Enabling AI engine as grammar provider

Enhancements

WProofreader

• Improved paragraph-based mechanism for larger text proofreading to decrease load on a client’s browser.
• Minor improvements to the French and Canadian French localization.
• Enhanced Ignore functionality.

AppServer

Added three new parameters to the AppServerX.xml file:

• VerificationMode regulates the severity of a client’s SSL certificate verification process; 
• PathToLogsDirectory sets a path to the Logs folder where system messages and errors are recorded. By default: …/Installation_path/AppServer/Logs;
• PathToServiceFilesDirectory defines a custom path for the license.xml file.

Bug fixes

• [GitHub #175] SCAYT plugin for CKEditor 4 stopped working in old IEs (IE9-IE10)
• [WP-3522] Global custom dictionary: The last word in the list is ignored unless an extra space is added at the end of a file
• [WP-3530] WSC Dialog plugin for CKEditor 4: Add word/Create dictionary/Ignore options stopped working in Chrome 80 and later versions