Skip to content

[MDL-87117] Describe the new strings to improve activity descriptions #1481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarjona wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[MDL-87117] Describe the new strings to improve activity descriptions #1481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions docs/devupdate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,17 @@ To address these challenges, we're reorganising the API to significantly improve
- Refactor JSON exporters to support multiple Open Badges schema versions (MDL-85621). This will allow for seamless integration with different schema requirements.

More information about the Badges API can be found in the [Badges API documentation](./apis/subsystems/badges/index.md).

## Activity chooser descriptions refinement

<Since version="5.2" issueNumber="MDL-87117" />

The help descriptions within the Activity Chooser have been significantly updated for all core Activities and Resources to provide richer guidance:

- A new optional language string, `modulename_summary`, has been introduced to define a concise, single-paragraph introduction to the module.
- The existing `modulename_help` string has been refined to contain the detailed description, now structured with dedicated sections for:
- **Key features** to highlight the module's primary functionalities.
- **Ways to use it** to provide practical, application-focused examples.
- A new optional string, `modulename_tip`, is available for a supplemental section for best practices, advice, or effective usage tips.

Third-party activity modules and resources can adopt the same structure by adding these language strings (`modulename_summary`, `modulename_help`, and `modulename_tip`) to their plugin's language files. These strings should be placed in the plugin's language file, for example, `mod/pluginname/lang/en/pluginname.php`.