Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

All notable changes to the WProofreader plugin for Moodle are documented here.

## 2.0.0 (2026-08-20)

* Widened official Moodle support to 4.1 through the 5.2 branch (previously 4.5 LTS through 5.2).
* Added support for the legacy TinyMCE editor (Moodle 4.1's "TinyMCE HTML editor (legacy)").
* Removed the global badge option.
* Surfaced the WProofreader bundle's own runtime warnings (unsupported language, service unavailable) and the WebSpellChecker service's HTTP error responses (400/403/404/409/500/503) as a non-blocking, per-editor note instead of leaving them silent or shown only in the browser console.

## 1.0.10 (2026-08-11)

* Added warning messages for an exceeded usage limit and an invalid license key on the settings page.
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# WProofreader plugin for Moodle

WProofreader is a real-time spelling, grammar, and style checker for editor
content in Moodle. It works inside the Atto editor (Moodle 4.5 LTS), TinyMCE 6,
and plain HTML textareas, with no per-editor configuration required.
content in Moodle. It works inside the Atto editor (Moodle 4.1 through 4.5 LTS),
TinyMCE 6, the legacy TinyMCE editor (Moodle 4.1 only), and plain HTML
textareas, with no per-editor configuration required.

## Features

Expand Down Expand Up @@ -33,19 +34,20 @@ WProofreader > License key*.

## Supported Moodle versions

* Moodle 4.5 LTS (2024100700) and any later release up to the 5.2 branch
* Atto support is only relevant on 4.5. From 5.0 onward Atto is removed and the
Atto integration becomes a no-op automatically.
* Moodle 4.1 (2022112800) through the 5.2 branch
* Atto is relevant on 4.1 through 4.5 LTS. From 5.0 onward Atto is removed from
core and the Atto integration becomes a no-op automatically.
* On Moodle 5.x the plugin installs under `public/local/wproofreader/` (Moodle's
5.0+ web-root split). On 4.5 it installs under `local/wproofreader/`.
5.0+ web-root split). On 4.1 through 4.5 it installs under `local/wproofreader/`.

## Supported editors

| Editor | How it is detected |
|-----------------|------------------------------------------------------------------|
| Atto | `.editor_atto_content[contenteditable="true"]` in the main DOM |
| TinyMCE 6 | `window.tinymce.editors`, hooked on each editor's `init` event |
| Plain textareas | Bundle's `autoSearch` plus a small list of code-field exclusions |
| Editor | How it is detected |
|---------------------|-----------------------------------------------------------------------|
| Atto | `.editor_atto_content[contenteditable="true"]` in the main DOM |
| TinyMCE 6 | `window.tinymce.editors`, hooked on each editor's `init` event |
| Legacy TinyMCE (4.1 only) | `window.tinymce.editors` (same global as TinyMCE 6, told apart by API shape), hooked on each editor's `onInit` event |
| Plain textareas | Attached explicitly (autoSearch disabled for textareas); a small list of code-field exclusions is skipped, along with any textarea already managed by a TinyMCE instance |

## Installation

Expand All @@ -67,8 +69,7 @@ All settings live under *Site administration > Plugins > Local plugins > WProofr
|----------------------|-------------|-------------|
| License key | empty | Paste the license key delivered with your Moodle Marketplace purchase. Leave empty to use the free version. |
| Default language | Auto | Initial proofreading language. *Auto* lets the WebSpellChecker service detect the language from the content being checked; pick a specific language to pin it. The dropdown is refreshed live from the service when the settings page loads. |
| Show badge button | enabled | Toggles the orange WProofreader badge on or off. |
| Badge placement | Page corner | Where to render the badge. "Page corner" shows a single floating badge in the bottom-right corner of the page that controls all editors. "Per editor" attaches a separate badge to each editor. |
| Show badge button | enabled | Toggles the orange WProofreader badge on or off. A separate badge attaches to each editor on the page. |

### Proofreading features

Expand Down
17 changes: 17 additions & 0 deletions amd/build/bundle_warnings.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions amd/build/bundle_warnings.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions amd/build/constants.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions amd/build/constants.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions amd/build/environment_atto.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading