Skip to content

Clarify Moodle compatibility range (4.2 - 5.2) and editor modes in README#71

Merged
eXeLearningProject merged 2 commits into
mainfrom
docs/improve-readme-compatibility
May 13, 2026
Merged

Clarify Moodle compatibility range (4.2 - 5.2) and editor modes in README#71
eXeLearningProject merged 2 commits into
mainfrom
docs/improve-readme-compatibility

Conversation

@erseco
Copy link
Copy Markdown
Collaborator

@erseco erseco commented May 12, 2026

Summary

  • Rewrite the Compatibility section as a supported range from Moodle 4.2 (the minimum, per version.php: $plugin->requires = 2023042400) up to the latest 5.2.x stable, with one row per branch including the 4.5.x LTS used by many institutional deployments. The previous list (3.9, 3.11, 4.1) contradicted version.php and was causing pushback from installers — e.g. on Canarias' Moodle 4.5.5 sites — because their branch was not listed.
  • Make the two editing modes explicit in the intro, with the actual plugin default first:
    • eXeLearning Online (remote server, default) — matches settings.php where editormode defaults to 'online'.
    • Embedded editor (integrated) — second option; only set as default in the Moodle Playground blueprint for demo purposes.
      Until now the README only mentioned the online mode and the wording "You need the eXeLearning online version installed (ws28 or higher)" gave the impression that an external eXeLearning Online server was the only way to run the plugin.
  • Add a Requirements subsection (Moodle / PHP / DB / Browser) and a "Required for eXeLearning Online mode (default)" line that makes clear the remote server is only needed in that mode.
  • Drop the parenthetical "(ws28 or higher)" since the exact server version is a deployment detail.
  • Add a Support section pointing to the GitHub issue tracker.
  • Update copyright year range to 2023-2026.

No code changes. Documentation only.

Test plan

  • Render README.md on GitHub and confirm the compatibility table, requirements list and editor-modes bullets are formatted correctly.
  • Confirm that eXeLearning Online is listed first and tagged as the default mode (matching settings.php).
  • Confirm copyright reads 2023-2026.
  • Confirm there is no mention of unsupported Moodle 3.x / 4.0 / 4.1 branches.

Moodle Playground Preview

The changes in this pull request can be previewed and tested using a Moodle Playground instance.

Preview in Moodle Playground

⚠️ The embedded eXeLearning editor is not included in this preview. You can install it from Modules > eXeLearning SCORM > Configure using the "Download & Install Editor" button. All other module features (ELPX upload, viewer, preview) work normally.

erseco added 2 commits May 12, 2026 15:41
The previous Compatibility list mentioned Moodle 3.9 / 3.11 / 4.1, which
contradicts version.php (requires 2023042400, i.e. Moodle 4.2). Some
installers (e.g. on Moodle 4.5.5) push back during deployment because
their branch is not listed.

Rewrite the section as a clear supported range from Moodle 4.2 up to the
current 5.2.x stable, with a row per branch (including LTS 4.5.x). Also
make explicit that the plugin can run in either of two editing modes
(embedded / integrated, or eXeLearning Online remote server), since the
intro only mentioned the online mode. Add a Requirements section, a
Support/Issues link, and update the copyright year range to 2023-2026.

No functional changes.
…8 hint

The plugin default for the `editormode` setting is `online`
(`settings.php`), so the README should list eXeLearning Online as the
default. Embedded is only forced as default in the Moodle Playground
blueprint for demo purposes. Also drop the "(ws28 or higher)"
parenthetical, since the exact server version is a deployment detail
that does not belong in the README.
@erseco erseco self-assigned this May 12, 2026
@erseco erseco added the documentation Improvements or additions to documentation label May 12, 2026
@ignaciogros ignaciogros reopened this May 13, 2026
@eXeLearningProject eXeLearningProject merged commit 26df1a6 into main May 13, 2026
2 checks passed
@eXeLearningProject eXeLearningProject deleted the docs/improve-readme-compatibility branch May 13, 2026 07:57
@erseco erseco linked an issue May 13, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify Moodle compatibility range

3 participants