Skip to content

Commit 9cc88c5

Browse files
authored
Merge pull request #1481 from sarjona/activitydescriptions
[MDL-87117] Describe the new strings to improve activity descriptions
2 parents af30a93 + d2bc3d0 commit 9cc88c5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/devupdate.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,17 @@ To address these challenges, we're reorganising the API to significantly improve
2020
- Refactor JSON exporters to support multiple Open Badges schema versions (MDL-85621). This will allow for seamless integration with different schema requirements.
2121

2222
More information about the Badges API can be found in the [Badges API documentation](./apis/subsystems/badges/index.md).
23+
24+
## Activity chooser descriptions refinement
25+
26+
<Since version="5.2" issueNumber="MDL-87117" />
27+
28+
The help descriptions within the Activity Chooser have been significantly updated for all core Activities and Resources to provide richer guidance:
29+
30+
- A new optional language string, `modulename_summary`, has been introduced to define a concise, single-paragraph introduction to the module.
31+
- The existing `modulename_help` string has been refined to contain the detailed description, now structured with dedicated sections for:
32+
- **Key features** to highlight the module's primary functionalities.
33+
- **Ways to use it** to provide practical, application-focused examples.
34+
- A new optional string, `modulename_tip`, is available for a supplemental section for best practices, advice, or effective usage tips.
35+
36+
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`.

0 commit comments

Comments
 (0)