instruction
stringclasses 1
value | input
stringlengths 61
6.42k
| solvability
stringclasses 2
values | output
stringlengths 60
70.4k
| text
stringlengths 715
71.3k
|
---|---|---|---|---|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.7.1/3.6.5 upgrade
description: Moodle 3.7.1 is scheduled for release on Monday 8 July 2019.
| Unsolvable | 1.summary: Upgrade moodle.net to 3.6.5
description:
2.summary: Upgrade dev.moodle.org to 3.6.5
description:
3.summary: Upgrade moodle.org to 3.7.1
description:
4.summary: Upgrade learn.moodle.net to 3.7.1
description:
5.summary: Upgrade school.demo.moodle.net to 3.7.1
description:
6.summary: Upgrade demo.moodle.net to 3.7.1
description:
7.summary: Upgrade lang.moodle.org to 3.6.5
description:
8.summary: Upgrade download.moodle.org to latest 3.5.x
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.7.1/3.6.5 upgrade
description: Moodle 3.7.1 is scheduled for release on Monday 8 July 2019.
### Response:
1.summary: Upgrade moodle.net to 3.6.5
description:
2.summary: Upgrade dev.moodle.org to 3.6.5
description:
3.summary: Upgrade moodle.org to 3.7.1
description:
4.summary: Upgrade learn.moodle.net to 3.7.1
description:
5.summary: Upgrade school.demo.moodle.net to 3.7.1
description:
6.summary: Upgrade demo.moodle.net to 3.7.1
description:
7.summary: Upgrade lang.moodle.org to 3.6.5
description:
8.summary: Upgrade download.moodle.org to latest 3.5.x
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle app
summary: Forum improvements for 3.8
description: Forum improvements for 3.8
| Unsolvable | 1.summary: Allow user to edit forum posts
description: allow user to edit forum posts from moodle mobile.
2.summary: Forum - posts without replies sometimes the time elapsed is shown
description: Using the App (Android mobile device as well as iPhone as well as Moodle Desktop (Mac)), posts without replies (0 replies) of forums sometimes the time elapsed is shown and others isnt. See screenshoots
3.summary: Delete forum posts
description: Add option to delete forum posts
4.summary: UI improvements on forum
description: Change locked, pinned, starred, subscribed status on the discussion list. Right now, only when entering a discussions can be done (except subscribed, cannot be done right now). Show complete dates (with time) on discussion posts. Show image attached as inline, currently theres shown as an attachment file. (Check the same for audio and video) Match nested mobile UI to modern forum UI. (I think theres no need to have both). restriction on size
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle app
summary: Forum improvements for 3.8
description: Forum improvements for 3.8
### Response:
1.summary: Allow user to edit forum posts
description: allow user to edit forum posts from moodle mobile.
2.summary: Forum - posts without replies sometimes the time elapsed is shown
description: Using the App (Android mobile device as well as iPhone as well as Moodle Desktop (Mac)), posts without replies (0 replies) of forums sometimes the time elapsed is shown and others isnt. See screenshoots
3.summary: Delete forum posts
description: Add option to delete forum posts
4.summary: UI improvements on forum
description: Change locked, pinned, starred, subscribed status on the discussion list. Right now, only when entering a discussions can be done (except subscribed, cannot be done right now). Show complete dates (with time) on discussion posts. Show image attached as inline, currently theres shown as an attachment file. (Check the same for audio and video) Match nested mobile UI to modern forum UI. (I think theres no need to have both). restriction on size
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: MoodleNet 3.0.0
description: MoodleNet 3.0 advances version 2.x.x to include an Extensibility Environment for Developer Contributions and Add-Ons. This provides a structured and documented way to allow internal and external developers to develop non-core features for MoodleNet. This will allow developers to work on features and functionality that allow MoodleNet to fit into processes (e.g. SSO, Allow/Deny Domains, Social interaction improvements, gamification and achievement badges) that are not on the current roadmap.
| Unsolvable | 1.summary: Profile Page improvements
description: bru.mas finalize current impl as static page in storybook ettore.bevilacqua then implement Ctrl and apply to webapp route
2.summary: Admin page
description: An Admin page needs to be set up.
3.summary: deploy a staging server
description: Would be great to have kind of a staging live system, where we can showcase the state-of-the-art of the system and feature-packages development with "live" upgrade functionalities
4.summary: MoodleNet Developer Webinar
description: Prepare for a webinar on v3.0 on 30th November 2022 on Moodle Academy
5.summary: Moodle Academy Course on MoodleNet Development
description: This course is designed for developers who want to start developing MoodleNet packages and contribute to the MoodleNet community.
6.summary: save and use custom primary color on
description: In settings/appearance page the user can choose a `primary color` for the webapp create backend service for saving when webapp loads it fetches appearance settings and applies them in the webapp
7.summary: Profile Page edit
description: bru.mas add editing features to static profile page ettore.bevilacqua amend Ctrl implementation no auth checks needed for the moment
8.summary: Repository - documentation and community guidelines
description: Lets clearly define the processes we want to see from community developers about contributing to source (eg the use of tracker issues, pull requests etc) and document those clearly in our docs and on the gitlab page
9.summary: ArangoDB package
description: manages the main Moodlenet databases, exposes services for packages to use arangodb: on request, creates a new private database for each package (and deletes it package uninstallation) provides services for collection maintainance and querying
10.summary: simple-email-auth package (email - password auth)
description: Finalize basic features of simple-email-auth Complete signup workflow with confirmation email (using crypto package for token) Use Auth-manager for email-user association use ArangoDB package for storage
11.summary: review packages lifecycle/naming and framework apis
description: the package is the extension. extension name is the package name Id suggest to use the term package for users too.. I think extension would be kind of misleading review pkg Lifecycle with install setup / uninstall cleanup Simplified framework internals and APIs, to let the architecture be clearer for developers
12.summary: key-value-store package
description: a handful simple key-value store for any package needing to easily persist data typically used for configs, but not only. works on top of arangodb pkg
13.summary: cryptographic services package
description: a (growing) centralized set of crypto services. stores key-pairs in KVStore currently provides - encrypt - decrypt - signJWT - verifyJWT
14.summary: email services package
description: services for emails. stores email configs (nodemailer transport config) currently just provides a send service
15.summary: proper and complete cli install workflow
description: standard procedure installs a number of fundamental packages, cli accepts option arguments for all necessary configs needed for first bootstrapping cli implements user friendly prompts for any mandatory config not provided as argument
16.summary: improve authentication-manager pkg
description: leverage newly implemented packages arangodb for user storage crypto for session token enc/dec
17.summary: react-app backend : Appearance/customization config & storage
description: implement backend services for react-app configs/settings storage (key-value-store)
18.summary: organization/instance package backend
description: create the package implement services to store and retrieve instance data (key-value-store)
19.summary: content-graph : backend
description: over arangodb Manages Content graph nodes(entities) and edges(relations) Creates new node-collections and edges-collections for packages on install and removes on uninstall Let packages maintain own custom metadata to any collection-entities
20.summary: profile package : backend
description: Adds Profile node to Content graph Adds a DB in ArangoDB for (Auth-manager)account-profile association
21.summary: email-auth : hook to profile
description: on signup completed and user created, create a web-user-profile associated to it
22.summary: Authorisation System
description: Implement an authorisation system based on API scopes (similar to OAuth) and user-type/user-role (permissions/roles/user-types) packages can add scopes to system packages must configure their APIs assigning them scopes (theirs or others) packages can add user-types to system
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: MoodleNet 3.0.0
description: MoodleNet 3.0 advances version 2.x.x to include an Extensibility Environment for Developer Contributions and Add-Ons. This provides a structured and documented way to allow internal and external developers to develop non-core features for MoodleNet. This will allow developers to work on features and functionality that allow MoodleNet to fit into processes (e.g. SSO, Allow/Deny Domains, Social interaction improvements, gamification and achievement badges) that are not on the current roadmap.
### Response:
1.summary: Profile Page improvements
description: bru.mas finalize current impl as static page in storybook ettore.bevilacqua then implement Ctrl and apply to webapp route
2.summary: Admin page
description: An Admin page needs to be set up.
3.summary: deploy a staging server
description: Would be great to have kind of a staging live system, where we can showcase the state-of-the-art of the system and feature-packages development with "live" upgrade functionalities
4.summary: MoodleNet Developer Webinar
description: Prepare for a webinar on v3.0 on 30th November 2022 on Moodle Academy
5.summary: Moodle Academy Course on MoodleNet Development
description: This course is designed for developers who want to start developing MoodleNet packages and contribute to the MoodleNet community.
6.summary: save and use custom primary color on
description: In settings/appearance page the user can choose a `primary color` for the webapp create backend service for saving when webapp loads it fetches appearance settings and applies them in the webapp
7.summary: Profile Page edit
description: bru.mas add editing features to static profile page ettore.bevilacqua amend Ctrl implementation no auth checks needed for the moment
8.summary: Repository - documentation and community guidelines
description: Lets clearly define the processes we want to see from community developers about contributing to source (eg the use of tracker issues, pull requests etc) and document those clearly in our docs and on the gitlab page
9.summary: ArangoDB package
description: manages the main Moodlenet databases, exposes services for packages to use arangodb: on request, creates a new private database for each package (and deletes it package uninstallation) provides services for collection maintainance and querying
10.summary: simple-email-auth package (email - password auth)
description: Finalize basic features of simple-email-auth Complete signup workflow with confirmation email (using crypto package for token) Use Auth-manager for email-user association use ArangoDB package for storage
11.summary: review packages lifecycle/naming and framework apis
description: the package is the extension. extension name is the package name Id suggest to use the term package for users too.. I think extension would be kind of misleading review pkg Lifecycle with install setup / uninstall cleanup Simplified framework internals and APIs, to let the architecture be clearer for developers
12.summary: key-value-store package
description: a handful simple key-value store for any package needing to easily persist data typically used for configs, but not only. works on top of arangodb pkg
13.summary: cryptographic services package
description: a (growing) centralized set of crypto services. stores key-pairs in KVStore currently provides - encrypt - decrypt - signJWT - verifyJWT
14.summary: email services package
description: services for emails. stores email configs (nodemailer transport config) currently just provides a send service
15.summary: proper and complete cli install workflow
description: standard procedure installs a number of fundamental packages, cli accepts option arguments for all necessary configs needed for first bootstrapping cli implements user friendly prompts for any mandatory config not provided as argument
16.summary: improve authentication-manager pkg
description: leverage newly implemented packages arangodb for user storage crypto for session token enc/dec
17.summary: react-app backend : Appearance/customization config & storage
description: implement backend services for react-app configs/settings storage (key-value-store)
18.summary: organization/instance package backend
description: create the package implement services to store and retrieve instance data (key-value-store)
19.summary: content-graph : backend
description: over arangodb Manages Content graph nodes(entities) and edges(relations) Creates new node-collections and edges-collections for packages on install and removes on uninstall Let packages maintain own custom metadata to any collection-entities
20.summary: profile package : backend
description: Adds Profile node to Content graph Adds a DB in ArangoDB for (Auth-manager)account-profile association
21.summary: email-auth : hook to profile
description: on signup completed and user created, create a web-user-profile associated to it
22.summary: Authorisation System
description: Implement an authorisation system based on API scopes (similar to OAuth) and user-type/user-role (permissions/roles/user-types) packages can add scopes to system packages must configure their APIs assigning them scopes (theirs or others) packages can add user-types to system
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: MUA new model setup (Discovery)
description: Goal: propose a new setup for MUA /HQ/ community interaction MUA ideas - board of trustees / steering group including volunteers elected and recognised (how) top universities and contributors - Regular Community Teams/ MUA liaison meetings - Able to fund the costs of its organisation and projects Remodelling MUA and stakeholder representation into a stronger Moodle.org community. By the end of this epic, Aurelie will offer options of models of work with MUA and partners in Moodle.org.
| Unsolvable | 1.summary: Initial draft with MUA
description: Aurelie to review work so far in MUA Improvement Planning document by MUA. and organise next meeting to review inputs.
2.summary: MUA committee / Aurelie interviews to build proposal
description: Aurelie will book time with all who can on the committee during November, and write up notes, to feed into the model options.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: MUA new model setup (Discovery)
description: Goal: propose a new setup for MUA /HQ/ community interaction MUA ideas - board of trustees / steering group including volunteers elected and recognised (how) top universities and contributors - Regular Community Teams/ MUA liaison meetings - Able to fund the costs of its organisation and projects Remodelling MUA and stakeholder representation into a stronger Moodle.org community. By the end of this epic, Aurelie will offer options of models of work with MUA and partners in Moodle.org.
### Response:
1.summary: Initial draft with MUA
description: Aurelie to review work so far in MUA Improvement Planning document by MUA. and organise next meeting to review inputs.
2.summary: MUA committee / Aurelie interviews to build proposal
description: Aurelie will book time with all who can on the committee during November, and write up notes, to feed into the model options.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Moodle 4.1 theme epic
description: Collection of issues raised during 4.0 dev that have been deferred till 4.1+
| Unsolvable | 1.summary: Move form submit buttons to the left
description: The form submit buttons should be aligned left to match the UX designs in figma
2.summary: Allow users to resize and crop images
description: To give users more control over images like the profile picture and images used in content users should be able to resize and crop images in Moodle. Large images should be resized automatically to prevent slow page loads. This will help improve the usability of the user profile editing page and give users more control over how the images will be displayed.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Moodle 4.1 theme epic
description: Collection of issues raised during 4.0 dev that have been deferred till 4.1+
### Response:
1.summary: Move form submit buttons to the left
description: The form submit buttons should be aligned left to match the UX designs in figma
2.summary: Allow users to resize and crop images
description: To give users more control over images like the profile picture and images used in content users should be able to resize and crop images in Moodle. Large images should be resized automatically to prevent slow page loads. This will help improve the usability of the user profile editing page and give users more control over how the images will be displayed.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Improve accessibility of the filepicker
description: A new LMS accessibility study from University of Illinois was published recently, unfortunately they had Moodle 2.3 only, but has some useful things to say: The main issue they had was unfortunately with our filepicker, which is complex. Ive created this issue to address that. The FRONTEND team needs to develop a list of the exact problems (as subtasks here) and then tackle them together. Note that its likely that accessibility improvements will also make the experience better for everyone on touch screens.
| Unsolvable | 1.summary: Explore ideas for reducing the size of the file picker.
description: The filepicker takes up alot of vertical space. When it is used in a form in pushed elements below it off the bottom of the page. Because it is large, it also implies (visually) that it is important which may not be the case (e.g. coursefiles). Maybe it should have a smaller view by default and have a expand/collapse toggle (and get bigger when a drag/drop is in progress). This issue was raised because of a request to add a filepicker to the assignment settings page - but I am reluctant to do that because it will push important settings off the page.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Improve accessibility of the filepicker
description: A new LMS accessibility study from University of Illinois was published recently, unfortunately they had Moodle 2.3 only, but has some useful things to say: The main issue they had was unfortunately with our filepicker, which is complex. Ive created this issue to address that. The FRONTEND team needs to develop a list of the exact problems (as subtasks here) and then tackle them together. Note that its likely that accessibility improvements will also make the experience better for everyone on touch screens.
### Response:
1.summary: Explore ideas for reducing the size of the file picker.
description: The filepicker takes up alot of vertical space. When it is used in a form in pushed elements below it off the bottom of the page. Because it is large, it also implies (visually) that it is important which may not be the case (e.g. coursefiles). Maybe it should have a smaller view by default and have a expand/collapse toggle (and get bigger when a drag/drop is in progress). This issue was raised because of a request to add a filepicker to the assignment settings page - but I am reluctant to do that because it will push important settings off the page.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.6
description: In 3.6 we can remove functionality that was deprecated in 3.2 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.6. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Properly deprecate print_textarea()
description: This issue remains here so we can eventually deprecate this function when all usages are removed. Until then keep moving it to the next deprecation epic Deprecated function print_textarea() does not display debugging message. Also there are still usages in core: code $ git grep print_textarea lib/adminlib.php: $return = .print_textarea(true, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, summar lib/form/htmleditor.php: print_textarea(true, mod/feedback/show_nonrespondents.php: print_textarea(true, 15, 25, 30, 10, "message", $message); mod/wiki/editors/html.php: echo $OUTPUT->container(print_textarea(true, 20, 100, 0, 0, "newcontent", $content, 0, true, , form-textarea-advan mod/wiki/editors/wiki_editor.php: echo $OUTPUT->container(print_textarea(false, 20, 60, 0, 0, "newcontent", $content, 0, true), false, wiki_edi user/message.html: code Also see
2.summary: Remove callback delete_course deprecated in 3.2
description: Remove callback delete_course deprecated in 3.1 in
3.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.2
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.2 should be replaced with exceptions in 3.6 This includes all functions in lib/deprecatedlib.php that say since 3.2 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.6- please list them in this issue description_
4.summary: Remove strings deprecated in 3.2
description: Remove strings from language files under the heading "Deprecated since Moodle 3.2" and the respective lines in deprecated.txt files See also
5.summary: Final deprecation of useredit_update_picture
description: Remove useredit_update_picture from user/editlib.php
6.summary: Final deprecation of get_records_csv and put_records_csv.
description: Remove get_records_csv() and put_records_csv from deprecatedlib.php See for the proper process.
7.summary: Remove password_compat skeleton
description: See for further information. A skeleton was included to inform developers that manual skeleton inclusion was no longer necessary. This can now be removed.
8.summary: Remove deprecated apis in behat_config_mananger.php in 3.2
description: While working on ---- lot of static apis were deprecated in behat_config_mananger.php as they are not needed. - get_features_with_tags() - get_components_steps_definitions() - get_config_file_contents() - merge_behat_config() - get_behat_profile() - profile_guided_allocate() - merge_config() - clean_path() - get_behat_tests_path()
9.summary: Remove i_set_the_field_to_multiline deprecated in 3.2
description: Remove i_set_the_field_to_multiline deprecated in 3.2
10.summary: Remove support for message objects as stdClass
description: Remove the debugging message in lib/classes/message/manager.php send_message when event data is passed as a stdClass. Throw a coding exception instead (the logic for the coding exception is there already, so it just needs to be removed from the allowed types. Tip: Look for "" in codebase and youll find a number of places (both and TODO) pointing to places and changes expected.
11.summary: Remove functions from calendar/lib that were deprecated in 3.2
description: In the function calendar_preferences_button(stdClass $course) was deprecated. This issue is to perform final deprecation.
12.summary: Final deprecation of css optimiser and related functions
description: Following
13.summary: Remove behat_transformations::prefixed_tablenode_transformations in 3.6
description: behat_transformations::prefixed_tablenode_transformations() was deprecated in Moodle 3.2 and no longer in use. Please remove in Moodle 3.6
14.summary: Phase 2 (or remove) media stuff deprecated in 3.2 when new media plugin type was introduced
description: Specifically: - remove lib/medialib.php and add it to "standard removed files" - remove class core_media_renderer - core_media_player::is_enabled and core_media_player_link::is_enabled - core_media_player::compare_by_rank
15.summary: Remove old class renames
description: core_component looks for COMPONENT/db/renamedclasses.php files, it allows us to avoid traumatic transitions and BC breakages by listing classes that have been removed. We need to clean the list at some point.
16.summary: Remove behat steps deprecated in 3.2
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.2 please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
17.summary: Remove Assignment upgrade helper from core
description: Its been 5 years now - time to remove this old code.
18.summary: Final deprecation of core_renderer::update_module_button
description: Remove core_renderer::update_module_button which was deprecated in 3.2.
19.summary: Deprecate the htmleditor form element
description: The htmleditor form element (lib/form/htmleditor.php) is not used anywhere in core (instead we use the editor element).
20.summary: Final deprecation of core_course_renderer::add_modchoosertoggle(), deprecated in 3.2
description: core_course_renderer::add_modchoosertoggle() was deprecated for Moodle 3.2 by This is about to remove it for 3.6 completely.
21.summary: Final deprecation of the form element submitlink
description: This was deprecated in 3.2 in .
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.6
description: In 3.6 we can remove functionality that was deprecated in 3.2 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.6. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Properly deprecate print_textarea()
description: This issue remains here so we can eventually deprecate this function when all usages are removed. Until then keep moving it to the next deprecation epic Deprecated function print_textarea() does not display debugging message. Also there are still usages in core: code $ git grep print_textarea lib/adminlib.php: $return = .print_textarea(true, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, summar lib/form/htmleditor.php: print_textarea(true, mod/feedback/show_nonrespondents.php: print_textarea(true, 15, 25, 30, 10, "message", $message); mod/wiki/editors/html.php: echo $OUTPUT->container(print_textarea(true, 20, 100, 0, 0, "newcontent", $content, 0, true, , form-textarea-advan mod/wiki/editors/wiki_editor.php: echo $OUTPUT->container(print_textarea(false, 20, 60, 0, 0, "newcontent", $content, 0, true), false, wiki_edi user/message.html: code Also see
2.summary: Remove callback delete_course deprecated in 3.2
description: Remove callback delete_course deprecated in 3.1 in
3.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.2
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.2 should be replaced with exceptions in 3.6 This includes all functions in lib/deprecatedlib.php that say since 3.2 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.6- please list them in this issue description_
4.summary: Remove strings deprecated in 3.2
description: Remove strings from language files under the heading "Deprecated since Moodle 3.2" and the respective lines in deprecated.txt files See also
5.summary: Final deprecation of useredit_update_picture
description: Remove useredit_update_picture from user/editlib.php
6.summary: Final deprecation of get_records_csv and put_records_csv.
description: Remove get_records_csv() and put_records_csv from deprecatedlib.php See for the proper process.
7.summary: Remove password_compat skeleton
description: See for further information. A skeleton was included to inform developers that manual skeleton inclusion was no longer necessary. This can now be removed.
8.summary: Remove deprecated apis in behat_config_mananger.php in 3.2
description: While working on ---- lot of static apis were deprecated in behat_config_mananger.php as they are not needed. - get_features_with_tags() - get_components_steps_definitions() - get_config_file_contents() - merge_behat_config() - get_behat_profile() - profile_guided_allocate() - merge_config() - clean_path() - get_behat_tests_path()
9.summary: Remove i_set_the_field_to_multiline deprecated in 3.2
description: Remove i_set_the_field_to_multiline deprecated in 3.2
10.summary: Remove support for message objects as stdClass
description: Remove the debugging message in lib/classes/message/manager.php send_message when event data is passed as a stdClass. Throw a coding exception instead (the logic for the coding exception is there already, so it just needs to be removed from the allowed types. Tip: Look for "" in codebase and youll find a number of places (both and TODO) pointing to places and changes expected.
11.summary: Remove functions from calendar/lib that were deprecated in 3.2
description: In the function calendar_preferences_button(stdClass $course) was deprecated. This issue is to perform final deprecation.
12.summary: Final deprecation of css optimiser and related functions
description: Following
13.summary: Remove behat_transformations::prefixed_tablenode_transformations in 3.6
description: behat_transformations::prefixed_tablenode_transformations() was deprecated in Moodle 3.2 and no longer in use. Please remove in Moodle 3.6
14.summary: Phase 2 (or remove) media stuff deprecated in 3.2 when new media plugin type was introduced
description: Specifically: - remove lib/medialib.php and add it to "standard removed files" - remove class core_media_renderer - core_media_player::is_enabled and core_media_player_link::is_enabled - core_media_player::compare_by_rank
15.summary: Remove old class renames
description: core_component looks for COMPONENT/db/renamedclasses.php files, it allows us to avoid traumatic transitions and BC breakages by listing classes that have been removed. We need to clean the list at some point.
16.summary: Remove behat steps deprecated in 3.2
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.2 please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
17.summary: Remove Assignment upgrade helper from core
description: Its been 5 years now - time to remove this old code.
18.summary: Final deprecation of core_renderer::update_module_button
description: Remove core_renderer::update_module_button which was deprecated in 3.2.
19.summary: Deprecate the htmleditor form element
description: The htmleditor form element (lib/form/htmleditor.php) is not used anywhere in core (instead we use the editor element).
20.summary: Final deprecation of core_course_renderer::add_modchoosertoggle(), deprecated in 3.2
description: core_course_renderer::add_modchoosertoggle() was deprecated for Moodle 3.2 by This is about to remove it for 3.6 completely.
21.summary: Final deprecation of the form element submitlink
description: This was deprecated in 3.2 in .
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.0
description: In 4.0 we can remove functionality that was deprecated in 3.8 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.8 should be replaced with exceptions in 4.0 This includes all functions in lib/deprecatedlib.php that say since 3.8 If any functions from this file do not have this comment but also need to be finally deprecated in 4.0 - please list them in this issue description
2.summary: Final deprecation of get_grades() in lib/classes/grades_external.php
description: In get_grades in lib/classes/grades_external.php was deprecated (it landed in 3.2). The final deprecation can be done to completely remove this method.
3.summary: Check pcre.jit php.ini setting state
description: We disabled pcre.git in because of a php bug ( We need to see if there is any progress ( and revert fix + set any alternative they provide.
4.summary: deprecate grade_grade::insert method that just calls its parent
description: Looks like this should of be done ages ago. This method grade_grade.php 1030| just calls grade_object.php 339| So the method grade_object:insert override was done in March 2008 (commit Fixing unit tests for gradebook. Mainly a change in set_locked() arguments. Merging from MOODLE_19_STABLE). And then the only line that made that function different was commented few days later (commit message feedback itself is a type of grading - date graded is now affected by feedback too; merged from MOODLE_19_STABLE). So by the look of things this extra method could be removed ... in March 2008
5.summary: Remove behat steps deprecated in 3.8
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.8 (or earlier) please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
6.summary: Remove deprecated functions in lib/setuplib.php
description: In 3.8 the following methods were deprecated - generate_uuid()
7.summary: Remove strings deprecated in 3.8
description: Remove strings from language files under the heading "Deprecated in Moodle 3.8" and the respective lines in deprecated.txt files See also
8.summary: Remove deprecated subplugins.php files
description: These were deprecated in and can now be safely removed.
9.summary: Final deprecations of forum_count_replies and get_forum_discussion_posts
description: Remove forum_count_replies and get_forum_discussion_posts functions.
10.summary: Remove deprecated functions in messages/classes/api.php
description: In 3.8 the following methods were deprecated - can_post_message() get_individual_conversations_between_users()
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.0
description: In 4.0 we can remove functionality that was deprecated in 3.8 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.8 should be replaced with exceptions in 4.0 This includes all functions in lib/deprecatedlib.php that say since 3.8 If any functions from this file do not have this comment but also need to be finally deprecated in 4.0 - please list them in this issue description
2.summary: Final deprecation of get_grades() in lib/classes/grades_external.php
description: In get_grades in lib/classes/grades_external.php was deprecated (it landed in 3.2). The final deprecation can be done to completely remove this method.
3.summary: Check pcre.jit php.ini setting state
description: We disabled pcre.git in because of a php bug ( We need to see if there is any progress ( and revert fix + set any alternative they provide.
4.summary: deprecate grade_grade::insert method that just calls its parent
description: Looks like this should of be done ages ago. This method grade_grade.php 1030| just calls grade_object.php 339| So the method grade_object:insert override was done in March 2008 (commit Fixing unit tests for gradebook. Mainly a change in set_locked() arguments. Merging from MOODLE_19_STABLE). And then the only line that made that function different was commented few days later (commit message feedback itself is a type of grading - date graded is now affected by feedback too; merged from MOODLE_19_STABLE). So by the look of things this extra method could be removed ... in March 2008
5.summary: Remove behat steps deprecated in 3.8
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.8 (or earlier) please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
6.summary: Remove deprecated functions in lib/setuplib.php
description: In 3.8 the following methods were deprecated - generate_uuid()
7.summary: Remove strings deprecated in 3.8
description: Remove strings from language files under the heading "Deprecated in Moodle 3.8" and the respective lines in deprecated.txt files See also
8.summary: Remove deprecated subplugins.php files
description: These were deprecated in and can now be safely removed.
9.summary: Final deprecations of forum_count_replies and get_forum_discussion_posts
description: Remove forum_count_replies and get_forum_discussion_posts functions.
10.summary: Remove deprecated functions in messages/classes/api.php
description: In 3.8 the following methods were deprecated - can_post_message() get_individual_conversations_between_users()
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Web service API Roadmap
description: .How to add a web service function into core if you want to suggest or implement a web service function, read the Moodledocs| .Integration priority the ones required for the official Mobile app (generally very few) the ones for which a git patch has been submitted. the most voted ones| the other ones
| Unsolvable | 1.summary: mod_resource_get_resources_by_courses
description: Retrieve a list of resources from several courses
2.summary: New Web Service mod_page_view_page
description: Trigger the module view event and update completion status. This function will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
3.summary: New Web Service mod_resource_view_resource
description: Trigger the module view event and update completion status
4.summary: New webservice: mod_url_view_url
description: Trigger the module view event and update completion status
5.summary: New Web Service core_course_search_courses
description: Search courses search by (name, blocklist, modulelist, tagid) params: criterianame criteriavalue page perpage Returns: totalcourses courses(name, shortname, description+attachment, categoryname,categoryid, courseid, teachers, guestaccessenabled ) warnings
6.summary: New Web Service mod_folder_view_folder
description: Trigger the module view event and update completion status. This functions will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
7.summary: New Web Service mod_book_view_book
description: Trigger the module view event.
8.summary: New Web Service mod_imscp_view_imscp
description: Trigger the module view event and update completion status
9.summary: New Web Service mod_choice_get_choices_by_courses
description: Retrieve all choices available in a course
10.summary: New Web Service mod_scorm_get_scorms_by_courses
description: Retrieve a list of SCORMs from several courses
11.summary: New Web Service mod_scorm_get_scorm_attempts
description: Parameters: scormid and userid Returns: A list containing information of all the attempts done by the specified user id This will be used to know the current attempt status for the user (last attempt, etc..)
12.summary: New Web Service mod_scorm_get_scorm_scoes
description: Parameters: scormid Returns a list of scoes inside the specified scorm
13.summary: New Web Service mod_scorm_get_scorm_user_data
description: Parameters: scorm, attempt Returns all the user tracks for all the scorm scoes (including objectives and interactions) This will be used for preparing the API runtime data
14.summary: New Web Service mod_scorm_insert_scorm_tracks
description: Parameters:scoid, userid, attempt, array of element, value Inserts track information about a SCO Returns: track id values and warnings
15.summary: core_course_get_course_modules
description: This new external function will return the basic and common module information/settings: - id - course - modname - instance - name - description - groups settings - completion settings - availability settings It will also have an optional "settings" parameter to make the external function return information for just one module, just the modules in a section, return also optional data like the current grade or completion status
16.summary: New Web Service mod_scorm_view_scorm
description: Trigger the module view event (this WS is just for simulating the scorm/view.php page)
17.summary: New Web Service mod_scorm_launch_sco
description: Trigger the \mod_scorm\event\sco_launched event (this WS is just for simulating the scorm/loadSCO.php page so the user interactions are logged in Moodle)
18.summary: New Web Service mod_book_get_books_by_courses
description: Retrieve a list of books from several courses
19.summary: New Web Service mod_chat_get_chats_by_courses
description: Retrieve a list of chats from several courses
20.summary: mod_folder_get_folders_by_courses
description: Retrieve a list of folders from several courses
21.summary: mod_glossary_get_glossaries_by_courses
description: Retrieve a list of glossaries from several courses
22.summary: New Web Service mod_imscp_get_imscps_by_courses
description: Retrieve a list of imscps from several courses
23.summary: mod_label_get_labels_by_courses
description: Retrieve a list of labels from several courses
24.summary: New Web Service mod_lti_get_ltis_by_courses
description: Retrieve a list of ltis from several courses
25.summary: mod_lesson_get_lessons_by_courses
description: Retrieve a list of lessons from several courses
26.summary: mod_page_get_pages_by_courses
description: Retrieve a list of pages from several courses
27.summary: New Web Service mod_quiz_get_quizzes_by_courses
description: Retrieve a list of quizzes from several courses
28.summary: mod_survey_get_surveys_by_courses
description: Retrieve a list of surveys from several courses
29.summary: mod_url_get_urls_by_courses
description: Retrieve a list of urls from several courses
30.summary: mod_wiki_get_wikis_by_courses
description: Retrieve a list of wikis from several courses
31.summary: New Web Service mod_scorm_get_scorm_sco_tracks
description: Wrapper function for: scorm_get_tracks($scoid, $userid, $attempt=) Parameters: $scoid, $userid, $attempt (default 0) Returns, sco track elements for the given user
32.summary: New Web Services for mod_chat
description: mod_chat_login_user Log a user into a chat room in the given chat and return the unique chatsid. This function will be a wrapper for core function chat_login_user and it will be used to log a user in a chat root and get the chatsid for starting sending and receiving messages. mod_chat_get_chat_users Get the list of users in the given chat session. This is a wrapper for the chat_get_users function. mod_chat_send_chat_message Send a message to a chat Wrapper function for chat_send_chatmessage mod_chat_get_chat_latest_messages Retrieve the latest messages starting the given time
33.summary: New Web Service: mod_chat_get_chat_users
description: Get the list of users in the given chat session. This is a wrapper for the chat_get_users function.
34.summary: New Web Service core_completion_mark_course_self_completed
description: This WS will be used for mark a course as self completed by a student
35.summary: Web Services for mod_choice
description: Implement a set of Web Services for the mod_choice: mod_choice_get_choice_options mod_choice_submit_choice_response mod_choice_get_choice_results mod_choice_view_choice This will fix issues: and
36.summary: New Web Service core_group_get_activity_groupmode
description: Implement a wrapper external function for core function: groups_get_activity_groupmode
37.summary: New Web Service core_group_get_activity_allowed_groups
description: New Web Service for retrieving a list of groups that the user is allowed to access within the specified activity. It will be just a wrapper for the group_get_activity_allowed_groups core function
38.summary: New Web Service core_block_get_course_blocks
description: This function will be used to return the course blocks information and optionally the block content rendered
39.summary: New Web Service mod_forum_add_discussion
description: This function will be used for creating new discussions into an existing forum. Parameters: forumid, subject, message, options Response: Same response that get_forum_discussions but only including the discussion created Initially, we wont support attachments or advanced features like "Post to all groups", we wont support "Post to all users" either. (The teacher will have to choose which group to post in case groups are used) We will used a generic parameter "options" for parameters like groups or future functionalities like the ones mentioned above. This will make very easy to maintain the function without further API changes
40.summary: New Web Service mod_forum_add_discussion_post
description: This function will be used for creating new posts into an existing discussion. Parameters: postid (post to reply, the initial discussion or any post within the discussion), subject, message, options Response: Same response that get_forum_posts but only including the post created Initially, we wont support attachments or another advanced features. We will used a generic parameter "options" for parameters like groups or future functionality like the ones mentioned above. This will make very easy to maintain the function without further API changes
41.summary: New Web Service mod_scorm_get_scorm_attempt_count
description: Parameters: scormid userid ignoremissingcompletion (ignores attempts that havent reported a grade/completion) Returns: The number of attempts done by a user in the given SCORM, optionally it can ignore the attempts not completed This will be used to know the current attempt status for the user (last attempt, etc..)
42.summary: New Web Service core_course_get_course_module
description: core_course_get_course_module Returns information about a course module (the user needs to have permission to view the module) parameters: cmid - Course module id returns: Module information (the information returned by get_coursemodule_from_id) including the section number Note: Some private/sensitive information wont be returned if the user does not have the manageactivities capability at module level
43.summary: New Web Service mod_choice_delete_choice_responses
description: Web Service for deleting the responses of a give choice
44.summary: New Web Service enrol_self_enrol_user
description: New Web Service for auto-enrolling users (passing as parameter the course id and optionally a password)
45.summary: New Web Service get_course_module_by_instance
description: Return module information passing the module name and instance id
46.summary: New Web Service mod_lti_view_lti
description: This function will trigger the module view event and call completion API
47.summary: New Web Services for mod_survey
description: New Web Services: mod_survey_get_surveys_by_courses mod_survey_view_survey (events) mod_survey_get_questions mod_survey_submit_answers
48.summary: New Web Services mod_wiki_view_wiki and mod_wiki_view_page
description: This function will trigger the module view event and call completion API.
49.summary: New Web Service mod_wiki_get_subwiki_pages
description: This function will return the list of pages of a certain subwiki.
50.summary: New Web Service core_group_can_access_all_groups
description: Check if the current user can access all groups of a given context level (course or module) and instance id (course id, or cmid). The function will return true if: The course or activity does not use groups The groupmode is VISIBLEGROUPS The user has the moodle/site:accessallgroups capability In some cases, it will good to now if the user can access all groups due to the capability. For example in some modules, like the forum, having that capability make the user able to create discussions for any group. This means that the return parameters would be something like: status - True or False if the user can or cannot access all groups haveaccessallgroupscap - If the user has the capability warnings
51.summary: New Web Service mod_wiki_get_page_contents
description: This WS will return the contents of a wiki page.
52.summary: New Web Service enrol_guest_get_instance_info
description: Return public information about the guest enrolment method settings.
53.summary: New Web Service core_message_delete_message
description: Since 3.0 messages can be deleted in the web interface, wed need a WS to be able to delete messages in the Mobile app too.
54.summary: New Web Service mod_forum_can_add_discussion
description: Check if the user can add discussions in the given forum (and optionally group).
55.summary: New Web Service mod_quiz_view_quiz
description: Trigger the module view event and update completion status. This Web Service is required by external system to be able to log interactions and update the completion status of the module, see for a list of modules currently implementing this Web Service (forum, lti, scorm, imscp, glossary, wiki, etc..) and (policy issue) for the rationale of this approach.
56.summary: New Web Service mod_quiz_get_user_attempts
description: Return quiz attempts information for the given user: Parameteres: quizid userid (default, current user) status (default finished) includepreviews (default false)
57.summary: New web Services for checking access requirements to quizzes and attempts
description: -This function returns general access information, is basically a wrapper of the access manager class that returns some capabilities information too.- Information returned will be: canmanage canattempt canreviewmine canpreview canviewreports canreviewmyattempts endtime isfinished ispreflightcheckrequired accessrules preventaccessreasons preventnewattemptreasons -This web service also returns the question types used in the quiz, including the potential ones (in case random questions are used).- -This is necessary because well need to check the question types before starting a new attempt to determine if the quiz can be open in the app (initially the app wont support all question types or contrib add-ons)- Please, note that we finally decided to split in 3 functions: mod_quiz_get_quiz_access_information mod_quiz_get_attempt_access_information mod_quiz_get_quiz_required_qtypes
58.summary: New Web Service mod_quiz_get_user_best_grade
description: Get the best current grade for the given user in a quiz.
59.summary: New Web Service mod_quiz_get_combined_review_options
description: Combines the review options from a number of different quiz attempts.
60.summary: New Web Service mod_quiz_start_attempt
description: Starts a new attempt at a quiz. Parameters: quizid forcenew - to force a new attempt in review mode Returns: attempt id attempt unique id attempt number page (in cases like last attempt page)
61.summary: New Web Service mod_wiki_get_subwikis
description: This WebService will return the list of subwikis a user can view in a certain wiki. It will return all the possible subwikis, not only the ones created in database. This WS is similar to the creation of the dropdown in Moodle web to pick which subwiki you want to edit.
62.summary: New Web Service mod_quiz_get_attempt_data
description: Returns information for the given attempt page for a quiz attempt in progress Parameters: - attemptid - pageid - preflightdata (optional) We need this because we don have a session object persistent between Web Service requests Returns: - Attempt object (with the attempt information) - Next page number - A list of access messages - A list of questions rendered
63.summary: New Web Service mod_quiz_get_attempt_summary
description: Returns a summary of a quiz attempt before it is submitted. parameters attemptid : The attempt id preflightdata: Like the quiz password returns: list of questions with: question number (the sequencial number) state (integer, the state id) status (string associated with the state) flagged (whether the question is flagged or not) mark (optional, this depends on the quiz mode-behaviour)
64.summary: New Web Service mod_quiz_save_attempt
description: Processes save requests during the quiz. This function is intended for the quiz auto-save feature. Parameters: attemptid data (the post data to be saved) Returns: status: true on success
65.summary: New Web Service mod_quiz_process_attempt
description: Process responses during an attempt at a quiz Parameters: attemptid - The attempt id finishattempt - Whether to finish or not the attempt timeup - Whether the WS was called by a timer data - the data to be processed, post format Returns: state - the quiz attempt state after the processing: quiz_attempt::IN_PROGRESS, quiz_attempt::OVERDUE, quiz_attempt::FINISHED, quiz_attempt::ABANDONED
66.summary: New Web Service mod_quiz_get_attempt_review
description: Returns review information for the given attempt, can be used by users or teaches parameters attemptid - the attempt id page - return information only for questions in this page (optional, leave empty for all the questions in all the pages) returns attempt - the complete attempt data additionaldata - additional data from the behaviour and the feedback questions list of: slot - slot number html - question rendered
67.summary: New web services for triggering events in mod_quiz
description: mod_quiz_view_attempt (attemptid, page) To trigger the attempt viewed event and to set the current page in the attempt. mod_quiz_view_attempt_summary (attempt) To trigger the attempt summary viewed event. mod_quiz_view_attempt_review (attempt) To trigger the attempt reviewed event. All returning a status field
68.summary: New Web Service mod_assign_get_submission_status
description: Given an attemptid and userid this web service returns the following information: - Grading summary (if the user has permissions) - Submission status - Feedback received - Previous attempts information This function return all the information that is displayed in the submission view page in Moodle for a user.
69.summary: New Web Service mod_assign_view_submission_status
description: Web Service to trigger the submission viewed event
70.summary: New Web Service mod_quiz_get_quiz_feedback_for_grade
description: Get the feedback text that should be show to a student who got the given grade in the given quiz. Parameters: quizid - Int, the quiz instance id grade - Float, the grade
71.summary: New Web Service core_badges_get_user_badges
description: This Web Service will be used for returning the list of badges awarded to a given user
72.summary: New Web Service mod_wiki_get_subwiki_files
description: This function will return the list of files in a subwiki, similar to what the option "Files" in Moodle web does.
73.summary: New Web Service gradereport_overview_get_course_grades
description: Retrieve the courses final grades for the given user. It will match the current "Grades" option in the user profile menu. Please, note that this WS does not cover all the functionalities from the user/overview/report, this WS is designed to return the course final grades in all the courses where he is enrolled, it can be used by admin/managers to retrieve other users final grades though. Information like numusers is not returned because is always 0 in the site context (this is not a bug, is how is designed the overview report)
74.summary: New Web Service tool_mobile_get_site_public_settings
description: New Web Service not requiring a session and published via AJAX that must return this information: siteurl sitename guestloginbutton rememberusername authloginviaemail registerauth wwwroot forgottenpasswordurl authinstructions isenabledauthnone enablewebservices enablemobilewebservice maintenance_enabled This will help us to: Obtain information (like the site name) just knowing the URL Check if the site has self-registration enabled Obtain the valid siteurl and for authentication (right now we have to guess it testing and then error prone) Check if mobile services are enabled (without having to check it doing a request to login/token.php)
75.summary: New Web Service tool_mobile_get_config
description: we need a new Web Service for retrieving site settings required by the app, for example, the frontpage settings to be able to display a Site Home similar to Moodle one (or for fixing issues like ). The idea is to not overload the existing core_get_site_info web service with tons of new settings and use this new WS specific for mobile instead. This WS must include some filtering, like filtering for "setting sections" in that way you can retrieve only the settings you need at any moment. For Moodle Mobile 3.2 well be using this WS for retrieving the frontpage settings, so we can build a front page in the app that is similar to the web version one.
76.summary: New Web Service core_course_get_activities_overview
description: Retrieve the modules overview (my courses page)
77.summary: New Web Service core_course_get_courses_by_field
description: This new WS is intended to be a replacement of the current core_course_get_courses, reasons are: core_course_get_courses only works for courses where the user have the course:view capability on Users should be able to view the basic course information (id, fullname,...) even if they are not enrolled in a course (but only if the course is visible). Returned data is missing some key information, like the enrolment methods enabled in the course, the "public visible teachers", filters enabled, etc.. It doesnt handle nicely exception/warnings (the whole WS fails if you requested a course where you dont have permissions)
78.summary: New Web Service mod_assign_view_assign
description: This Web Service is just for launching $completion->set_module_viewed
79.summary: New Web Service core_user_get_user_preferences
description: It will return the user Moodle preferences Parameters: name - Preference name, optional, default to retrieve all preferences userid - The user to retrieve the preferences from, optional, default to current user
80.summary: New Web Service core_user_set_users_preferences
description: Given an array of: preference name preference value user (optional) This WS will set the preferences
81.summary: New Web Service core_message_get_user_notification_preferences
description: To be developed once is finished This is the Web Service for retrieving the current user messaging preferences
82.summary: New Web Services for retrieving navigation and administration options available
description: After discussing it much (with Dani and Eloy) we think that the new WS names should be: core_course_get_user_administration_options($courseids) core_course_get_user_navigation_options($courseids) The new APIs at course/lib.php will be: course_get_user_administration_options($context) course_get_user_navigation_options($context) Why we need this new WS? Because in the Mobile app we dont have currently a way to know wich options in a course (administration or navigation level) are available for a user. The only way to know if something is available for a user is doing a pre-fetch call to the WS and check if is returning errors or not (for example, retrieve the list of participants, the user grade book, the user notes) etc.. This is causing serious performance and data consumption issues in the app when the user is enrolled in several courses, for 12 courses we are doing like 70 WS calls that we will be able to save with this new web services Required core changes Well be refactoring the navigationlib to use this new functions to avoid code duplication (it will be basically moving $CFG and capabilities check to those functions)
83.summary: New Web Service mod_glossary_add_entry
description: Web Services for adding new entries in a glossary. Parameters: glossaryid, concept, definition, options (for all the optional settings and possible attachments) Ill be following the same patterns applied when mod_forum_add_post was implemented, so this type of functions are consistent
84.summary: New Web Service core_rating_add_rating
description: New Web Service for adding rates to a Moodle item (like a forum post) The code should be very close to the current AJAX interface for rating (we should move it to a locallib or something like that)
85.summary: New Web Service gradereport_user_get_grade_items
description: This new Web Service will be a good replacement for core_grades_get_grades, basically, it will allow a user or manager (teacher/admin) to retrieve all the grate items from the course gradebook: - Grades - Outcomes - Manual - Categories among with feedback, rank, range etc.. Including the final course grade and aggregations. We have to base the new WS on the user report code because is the only one taking care of advanced gradebook features like hiding affected grades, adjust bounds, etc.. A first view of the user grader report reflects its complexity, the more sensible approach (under my opinion) would be not to touch any single line of code and just add a new data structure (rawgradeitemdata) that will be filled in the recursive process of building the grades table. (Basically, in the fill_table_recursive function). At the end, the report class will generate two data structures: tabledata ready for printing the table and the rawgradeitemdata, with a representation of the gradebook ready to be used by external functions. The ideal thing would be to split the code into one function generating a templatable/renderable and then another one for build the table, but looking at the actual code this will be very complex, will require a lot of code duplication and Im afraid of possible regressions.
86.summary: New Web Service core_search_get_search_areas_list
description: Returns the list of existing search areas
87.summary: New Web Service message_airnotifier_get_user_devices
description: Return the list of mobile devices that are registered in Moodle for the given user.
88.summary: New Web Service message_airnotifier_enable_device
description: Enable or disable a mobile device registered in Moodle for the user
89.summary: New Web Service core_user_update_picture
description: Updates or deletes the user picture
90.summary: New Web Service core_course_check_updates
description: Check if a module has been updated since the given timestamp. Parameters: - array of cmid and timestamp Returns: - array of the type of elements that were updated: configuration, files, posts (for forum), pages (for wiki), entries (for glossary), etc.. This wont return the element ids of additional information, just a boolean indicating if something was updated since the given time. Why do we need this information: The mobile app allows to download both resources and activities for offline access/usage. Right now, for calculating if a resource or activity needs update (so we can show a button to allow the user to update the downloaded module) we must perform several "heavy" web services requests. This is because we need to retrieve the module information and associated files and data to compare with the local information stored and see if something was updated. For example: For a quiz we must retrieve the quiz attempts to see if there is a new attempt. For forums, we must download discussions/posts. For assignment, we need to download the recent submissions to check if there is any change. For a normal course we could end up doing lots of requests to display the modules needing update. This is the reason wed need a simple Web Service able to return some basic information about the modules status since a given date. This Web Service will receive a list of cmids and timestamps and well ask every module type to calculate if there has been any update affecting the user since the given time. Please, note that we must specify a different timestamp for each module, because maybe the user updated manually some modules of the course but not all of them. These changes can help us also to "mark/display" in the app the modules with updates since the last visit of the user. So basically with these changes we will be able to: Check if the already downloaded modules (if any) needs to be updated. Every time the user open a course, check for updates to display using badges (red filled circles with a number inside) Implementation This WS will do multiple request for retrieve all the required information for all the modules, but this will have a lower performance impact that the current requests we are doing (right now to calculate the status we perform multiple request) so this will be a performance improvement for both sites using 3.2 and the app. Another implementation approach could have been implement an event observer in a plugin and store the update information in a new database table. Or not an event observer and using direct calls (a new subsystem) or whatever available in lib/ so any component or plugin could report updates. I think that this is the simplest way, and right now it will reduce the amount of request that the app needs to do.
91.summary: New Web Service mod_chat_get_past_sessions
description: Web Service for retrieve the chat past sessions where the user participated
92.summary: New Web Service core_message_get_user_message_preferences
description: In 3.2 the messaging preferences have been split in: Notification preferences Message preferences We already implemented a WS to retrieve notification preferences in but we didnt notice that we were missing the "Message" ones because of the split. Wed need this new WS in order to enabling changing these preferences from the mobile app (it make totally sense to be able to configure what type of notifications you want to receive in Mobile)
93.summary: New Web Services for retrieving chat sessions
description: To retrieve chat past sessions wed need two web services: - mod_chat_get_sessions: To list all the chat sessions for the given chat - mod_chat_get_session_messages: To get the chat messages from one chat session
94.summary: New Web Service core_course_get_updates_since
description: In order to re-use the current check_updates API at module level, we could create a new function for retrieving all the course updates since a given date. Right now, there is a core_course_check_updates function but checks module by module (not the whole course) Parameters would be: courseid since - Check updates since this time stamp filter- Check only for updates in the given areas
95.summary: New Web Service core_user_get_private_files_info
description: We need a WS that will return the remaining user quota in the private files are for the current user.
96.summary: New Web Service core_auth_request_password_reset
description: Public Web Service (via XHR) to allow users to request a password reset using the mobile app.
97.summary: New Web Service core_blog_get_entries
description: New Web Service for retrieving blog entries
98.summary: New Web Service core_blog_view_entries
description: We need a new WS for triggering the blog_entries_viewed event
99.summary: New Web Service mod_glossary_update_entry
description: Ws for updating entries
100.summary: New WebService mod_scorm_get_scorm_access_information
description: We need this WebService to return the capabilities affecting the current user in order to calculate if the user is able to see some information controlled by capabilities (a particular case is the score information). See for more information.
101.summary: New Web Services for updating a forum post (or a discussion topic post)
description: Create a new set of functions for being able to update discussion posts. It will require some additional helper WS function to set/prepare the draft attachment and editors. Web services to be created are: mod_forum_get_discussion_post - To obtain particular information about a post and specifically if the user is able to update ir or not mod_forum_prepare_draft_area_for_post - To prepare the draft areas for a post that it is going to be updated including the files to be kept in the draft area when editing a post mod_forum_update_discussion_post - To update a post
102.summary: New web services for adding and deleting comments
description: New Web Service for adding and deleting comments in any commenting area.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Web service API Roadmap
description: .How to add a web service function into core if you want to suggest or implement a web service function, read the Moodledocs| .Integration priority the ones required for the official Mobile app (generally very few) the ones for which a git patch has been submitted. the most voted ones| the other ones
### Response:
1.summary: mod_resource_get_resources_by_courses
description: Retrieve a list of resources from several courses
2.summary: New Web Service mod_page_view_page
description: Trigger the module view event and update completion status. This function will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
3.summary: New Web Service mod_resource_view_resource
description: Trigger the module view event and update completion status
4.summary: New webservice: mod_url_view_url
description: Trigger the module view event and update completion status
5.summary: New Web Service core_course_search_courses
description: Search courses search by (name, blocklist, modulelist, tagid) params: criterianame criteriavalue page perpage Returns: totalcourses courses(name, shortname, description+attachment, categoryname,categoryid, courseid, teachers, guestaccessenabled ) warnings
6.summary: New Web Service mod_folder_view_folder
description: Trigger the module view event and update completion status. This functions will be used by the Mobile app in order to allow logging and trigger events when the user navigate the site and courses via the mobile app.
7.summary: New Web Service mod_book_view_book
description: Trigger the module view event.
8.summary: New Web Service mod_imscp_view_imscp
description: Trigger the module view event and update completion status
9.summary: New Web Service mod_choice_get_choices_by_courses
description: Retrieve all choices available in a course
10.summary: New Web Service mod_scorm_get_scorms_by_courses
description: Retrieve a list of SCORMs from several courses
11.summary: New Web Service mod_scorm_get_scorm_attempts
description: Parameters: scormid and userid Returns: A list containing information of all the attempts done by the specified user id This will be used to know the current attempt status for the user (last attempt, etc..)
12.summary: New Web Service mod_scorm_get_scorm_scoes
description: Parameters: scormid Returns a list of scoes inside the specified scorm
13.summary: New Web Service mod_scorm_get_scorm_user_data
description: Parameters: scorm, attempt Returns all the user tracks for all the scorm scoes (including objectives and interactions) This will be used for preparing the API runtime data
14.summary: New Web Service mod_scorm_insert_scorm_tracks
description: Parameters:scoid, userid, attempt, array of element, value Inserts track information about a SCO Returns: track id values and warnings
15.summary: core_course_get_course_modules
description: This new external function will return the basic and common module information/settings: - id - course - modname - instance - name - description - groups settings - completion settings - availability settings It will also have an optional "settings" parameter to make the external function return information for just one module, just the modules in a section, return also optional data like the current grade or completion status
16.summary: New Web Service mod_scorm_view_scorm
description: Trigger the module view event (this WS is just for simulating the scorm/view.php page)
17.summary: New Web Service mod_scorm_launch_sco
description: Trigger the \mod_scorm\event\sco_launched event (this WS is just for simulating the scorm/loadSCO.php page so the user interactions are logged in Moodle)
18.summary: New Web Service mod_book_get_books_by_courses
description: Retrieve a list of books from several courses
19.summary: New Web Service mod_chat_get_chats_by_courses
description: Retrieve a list of chats from several courses
20.summary: mod_folder_get_folders_by_courses
description: Retrieve a list of folders from several courses
21.summary: mod_glossary_get_glossaries_by_courses
description: Retrieve a list of glossaries from several courses
22.summary: New Web Service mod_imscp_get_imscps_by_courses
description: Retrieve a list of imscps from several courses
23.summary: mod_label_get_labels_by_courses
description: Retrieve a list of labels from several courses
24.summary: New Web Service mod_lti_get_ltis_by_courses
description: Retrieve a list of ltis from several courses
25.summary: mod_lesson_get_lessons_by_courses
description: Retrieve a list of lessons from several courses
26.summary: mod_page_get_pages_by_courses
description: Retrieve a list of pages from several courses
27.summary: New Web Service mod_quiz_get_quizzes_by_courses
description: Retrieve a list of quizzes from several courses
28.summary: mod_survey_get_surveys_by_courses
description: Retrieve a list of surveys from several courses
29.summary: mod_url_get_urls_by_courses
description: Retrieve a list of urls from several courses
30.summary: mod_wiki_get_wikis_by_courses
description: Retrieve a list of wikis from several courses
31.summary: New Web Service mod_scorm_get_scorm_sco_tracks
description: Wrapper function for: scorm_get_tracks($scoid, $userid, $attempt=) Parameters: $scoid, $userid, $attempt (default 0) Returns, sco track elements for the given user
32.summary: New Web Services for mod_chat
description: mod_chat_login_user Log a user into a chat room in the given chat and return the unique chatsid. This function will be a wrapper for core function chat_login_user and it will be used to log a user in a chat root and get the chatsid for starting sending and receiving messages. mod_chat_get_chat_users Get the list of users in the given chat session. This is a wrapper for the chat_get_users function. mod_chat_send_chat_message Send a message to a chat Wrapper function for chat_send_chatmessage mod_chat_get_chat_latest_messages Retrieve the latest messages starting the given time
33.summary: New Web Service: mod_chat_get_chat_users
description: Get the list of users in the given chat session. This is a wrapper for the chat_get_users function.
34.summary: New Web Service core_completion_mark_course_self_completed
description: This WS will be used for mark a course as self completed by a student
35.summary: Web Services for mod_choice
description: Implement a set of Web Services for the mod_choice: mod_choice_get_choice_options mod_choice_submit_choice_response mod_choice_get_choice_results mod_choice_view_choice This will fix issues: and
36.summary: New Web Service core_group_get_activity_groupmode
description: Implement a wrapper external function for core function: groups_get_activity_groupmode
37.summary: New Web Service core_group_get_activity_allowed_groups
description: New Web Service for retrieving a list of groups that the user is allowed to access within the specified activity. It will be just a wrapper for the group_get_activity_allowed_groups core function
38.summary: New Web Service core_block_get_course_blocks
description: This function will be used to return the course blocks information and optionally the block content rendered
39.summary: New Web Service mod_forum_add_discussion
description: This function will be used for creating new discussions into an existing forum. Parameters: forumid, subject, message, options Response: Same response that get_forum_discussions but only including the discussion created Initially, we wont support attachments or advanced features like "Post to all groups", we wont support "Post to all users" either. (The teacher will have to choose which group to post in case groups are used) We will used a generic parameter "options" for parameters like groups or future functionalities like the ones mentioned above. This will make very easy to maintain the function without further API changes
40.summary: New Web Service mod_forum_add_discussion_post
description: This function will be used for creating new posts into an existing discussion. Parameters: postid (post to reply, the initial discussion or any post within the discussion), subject, message, options Response: Same response that get_forum_posts but only including the post created Initially, we wont support attachments or another advanced features. We will used a generic parameter "options" for parameters like groups or future functionality like the ones mentioned above. This will make very easy to maintain the function without further API changes
41.summary: New Web Service mod_scorm_get_scorm_attempt_count
description: Parameters: scormid userid ignoremissingcompletion (ignores attempts that havent reported a grade/completion) Returns: The number of attempts done by a user in the given SCORM, optionally it can ignore the attempts not completed This will be used to know the current attempt status for the user (last attempt, etc..)
42.summary: New Web Service core_course_get_course_module
description: core_course_get_course_module Returns information about a course module (the user needs to have permission to view the module) parameters: cmid - Course module id returns: Module information (the information returned by get_coursemodule_from_id) including the section number Note: Some private/sensitive information wont be returned if the user does not have the manageactivities capability at module level
43.summary: New Web Service mod_choice_delete_choice_responses
description: Web Service for deleting the responses of a give choice
44.summary: New Web Service enrol_self_enrol_user
description: New Web Service for auto-enrolling users (passing as parameter the course id and optionally a password)
45.summary: New Web Service get_course_module_by_instance
description: Return module information passing the module name and instance id
46.summary: New Web Service mod_lti_view_lti
description: This function will trigger the module view event and call completion API
47.summary: New Web Services for mod_survey
description: New Web Services: mod_survey_get_surveys_by_courses mod_survey_view_survey (events) mod_survey_get_questions mod_survey_submit_answers
48.summary: New Web Services mod_wiki_view_wiki and mod_wiki_view_page
description: This function will trigger the module view event and call completion API.
49.summary: New Web Service mod_wiki_get_subwiki_pages
description: This function will return the list of pages of a certain subwiki.
50.summary: New Web Service core_group_can_access_all_groups
description: Check if the current user can access all groups of a given context level (course or module) and instance id (course id, or cmid). The function will return true if: The course or activity does not use groups The groupmode is VISIBLEGROUPS The user has the moodle/site:accessallgroups capability In some cases, it will good to now if the user can access all groups due to the capability. For example in some modules, like the forum, having that capability make the user able to create discussions for any group. This means that the return parameters would be something like: status - True or False if the user can or cannot access all groups haveaccessallgroupscap - If the user has the capability warnings
51.summary: New Web Service mod_wiki_get_page_contents
description: This WS will return the contents of a wiki page.
52.summary: New Web Service enrol_guest_get_instance_info
description: Return public information about the guest enrolment method settings.
53.summary: New Web Service core_message_delete_message
description: Since 3.0 messages can be deleted in the web interface, wed need a WS to be able to delete messages in the Mobile app too.
54.summary: New Web Service mod_forum_can_add_discussion
description: Check if the user can add discussions in the given forum (and optionally group).
55.summary: New Web Service mod_quiz_view_quiz
description: Trigger the module view event and update completion status. This Web Service is required by external system to be able to log interactions and update the completion status of the module, see for a list of modules currently implementing this Web Service (forum, lti, scorm, imscp, glossary, wiki, etc..) and (policy issue) for the rationale of this approach.
56.summary: New Web Service mod_quiz_get_user_attempts
description: Return quiz attempts information for the given user: Parameteres: quizid userid (default, current user) status (default finished) includepreviews (default false)
57.summary: New web Services for checking access requirements to quizzes and attempts
description: -This function returns general access information, is basically a wrapper of the access manager class that returns some capabilities information too.- Information returned will be: canmanage canattempt canreviewmine canpreview canviewreports canreviewmyattempts endtime isfinished ispreflightcheckrequired accessrules preventaccessreasons preventnewattemptreasons -This web service also returns the question types used in the quiz, including the potential ones (in case random questions are used).- -This is necessary because well need to check the question types before starting a new attempt to determine if the quiz can be open in the app (initially the app wont support all question types or contrib add-ons)- Please, note that we finally decided to split in 3 functions: mod_quiz_get_quiz_access_information mod_quiz_get_attempt_access_information mod_quiz_get_quiz_required_qtypes
58.summary: New Web Service mod_quiz_get_user_best_grade
description: Get the best current grade for the given user in a quiz.
59.summary: New Web Service mod_quiz_get_combined_review_options
description: Combines the review options from a number of different quiz attempts.
60.summary: New Web Service mod_quiz_start_attempt
description: Starts a new attempt at a quiz. Parameters: quizid forcenew - to force a new attempt in review mode Returns: attempt id attempt unique id attempt number page (in cases like last attempt page)
61.summary: New Web Service mod_wiki_get_subwikis
description: This WebService will return the list of subwikis a user can view in a certain wiki. It will return all the possible subwikis, not only the ones created in database. This WS is similar to the creation of the dropdown in Moodle web to pick which subwiki you want to edit.
62.summary: New Web Service mod_quiz_get_attempt_data
description: Returns information for the given attempt page for a quiz attempt in progress Parameters: - attemptid - pageid - preflightdata (optional) We need this because we don have a session object persistent between Web Service requests Returns: - Attempt object (with the attempt information) - Next page number - A list of access messages - A list of questions rendered
63.summary: New Web Service mod_quiz_get_attempt_summary
description: Returns a summary of a quiz attempt before it is submitted. parameters attemptid : The attempt id preflightdata: Like the quiz password returns: list of questions with: question number (the sequencial number) state (integer, the state id) status (string associated with the state) flagged (whether the question is flagged or not) mark (optional, this depends on the quiz mode-behaviour)
64.summary: New Web Service mod_quiz_save_attempt
description: Processes save requests during the quiz. This function is intended for the quiz auto-save feature. Parameters: attemptid data (the post data to be saved) Returns: status: true on success
65.summary: New Web Service mod_quiz_process_attempt
description: Process responses during an attempt at a quiz Parameters: attemptid - The attempt id finishattempt - Whether to finish or not the attempt timeup - Whether the WS was called by a timer data - the data to be processed, post format Returns: state - the quiz attempt state after the processing: quiz_attempt::IN_PROGRESS, quiz_attempt::OVERDUE, quiz_attempt::FINISHED, quiz_attempt::ABANDONED
66.summary: New Web Service mod_quiz_get_attempt_review
description: Returns review information for the given attempt, can be used by users or teaches parameters attemptid - the attempt id page - return information only for questions in this page (optional, leave empty for all the questions in all the pages) returns attempt - the complete attempt data additionaldata - additional data from the behaviour and the feedback questions list of: slot - slot number html - question rendered
67.summary: New web services for triggering events in mod_quiz
description: mod_quiz_view_attempt (attemptid, page) To trigger the attempt viewed event and to set the current page in the attempt. mod_quiz_view_attempt_summary (attempt) To trigger the attempt summary viewed event. mod_quiz_view_attempt_review (attempt) To trigger the attempt reviewed event. All returning a status field
68.summary: New Web Service mod_assign_get_submission_status
description: Given an attemptid and userid this web service returns the following information: - Grading summary (if the user has permissions) - Submission status - Feedback received - Previous attempts information This function return all the information that is displayed in the submission view page in Moodle for a user.
69.summary: New Web Service mod_assign_view_submission_status
description: Web Service to trigger the submission viewed event
70.summary: New Web Service mod_quiz_get_quiz_feedback_for_grade
description: Get the feedback text that should be show to a student who got the given grade in the given quiz. Parameters: quizid - Int, the quiz instance id grade - Float, the grade
71.summary: New Web Service core_badges_get_user_badges
description: This Web Service will be used for returning the list of badges awarded to a given user
72.summary: New Web Service mod_wiki_get_subwiki_files
description: This function will return the list of files in a subwiki, similar to what the option "Files" in Moodle web does.
73.summary: New Web Service gradereport_overview_get_course_grades
description: Retrieve the courses final grades for the given user. It will match the current "Grades" option in the user profile menu. Please, note that this WS does not cover all the functionalities from the user/overview/report, this WS is designed to return the course final grades in all the courses where he is enrolled, it can be used by admin/managers to retrieve other users final grades though. Information like numusers is not returned because is always 0 in the site context (this is not a bug, is how is designed the overview report)
74.summary: New Web Service tool_mobile_get_site_public_settings
description: New Web Service not requiring a session and published via AJAX that must return this information: siteurl sitename guestloginbutton rememberusername authloginviaemail registerauth wwwroot forgottenpasswordurl authinstructions isenabledauthnone enablewebservices enablemobilewebservice maintenance_enabled This will help us to: Obtain information (like the site name) just knowing the URL Check if the site has self-registration enabled Obtain the valid siteurl and for authentication (right now we have to guess it testing and then error prone) Check if mobile services are enabled (without having to check it doing a request to login/token.php)
75.summary: New Web Service tool_mobile_get_config
description: we need a new Web Service for retrieving site settings required by the app, for example, the frontpage settings to be able to display a Site Home similar to Moodle one (or for fixing issues like ). The idea is to not overload the existing core_get_site_info web service with tons of new settings and use this new WS specific for mobile instead. This WS must include some filtering, like filtering for "setting sections" in that way you can retrieve only the settings you need at any moment. For Moodle Mobile 3.2 well be using this WS for retrieving the frontpage settings, so we can build a front page in the app that is similar to the web version one.
76.summary: New Web Service core_course_get_activities_overview
description: Retrieve the modules overview (my courses page)
77.summary: New Web Service core_course_get_courses_by_field
description: This new WS is intended to be a replacement of the current core_course_get_courses, reasons are: core_course_get_courses only works for courses where the user have the course:view capability on Users should be able to view the basic course information (id, fullname,...) even if they are not enrolled in a course (but only if the course is visible). Returned data is missing some key information, like the enrolment methods enabled in the course, the "public visible teachers", filters enabled, etc.. It doesnt handle nicely exception/warnings (the whole WS fails if you requested a course where you dont have permissions)
78.summary: New Web Service mod_assign_view_assign
description: This Web Service is just for launching $completion->set_module_viewed
79.summary: New Web Service core_user_get_user_preferences
description: It will return the user Moodle preferences Parameters: name - Preference name, optional, default to retrieve all preferences userid - The user to retrieve the preferences from, optional, default to current user
80.summary: New Web Service core_user_set_users_preferences
description: Given an array of: preference name preference value user (optional) This WS will set the preferences
81.summary: New Web Service core_message_get_user_notification_preferences
description: To be developed once is finished This is the Web Service for retrieving the current user messaging preferences
82.summary: New Web Services for retrieving navigation and administration options available
description: After discussing it much (with Dani and Eloy) we think that the new WS names should be: core_course_get_user_administration_options($courseids) core_course_get_user_navigation_options($courseids) The new APIs at course/lib.php will be: course_get_user_administration_options($context) course_get_user_navigation_options($context) Why we need this new WS? Because in the Mobile app we dont have currently a way to know wich options in a course (administration or navigation level) are available for a user. The only way to know if something is available for a user is doing a pre-fetch call to the WS and check if is returning errors or not (for example, retrieve the list of participants, the user grade book, the user notes) etc.. This is causing serious performance and data consumption issues in the app when the user is enrolled in several courses, for 12 courses we are doing like 70 WS calls that we will be able to save with this new web services Required core changes Well be refactoring the navigationlib to use this new functions to avoid code duplication (it will be basically moving $CFG and capabilities check to those functions)
83.summary: New Web Service mod_glossary_add_entry
description: Web Services for adding new entries in a glossary. Parameters: glossaryid, concept, definition, options (for all the optional settings and possible attachments) Ill be following the same patterns applied when mod_forum_add_post was implemented, so this type of functions are consistent
84.summary: New Web Service core_rating_add_rating
description: New Web Service for adding rates to a Moodle item (like a forum post) The code should be very close to the current AJAX interface for rating (we should move it to a locallib or something like that)
85.summary: New Web Service gradereport_user_get_grade_items
description: This new Web Service will be a good replacement for core_grades_get_grades, basically, it will allow a user or manager (teacher/admin) to retrieve all the grate items from the course gradebook: - Grades - Outcomes - Manual - Categories among with feedback, rank, range etc.. Including the final course grade and aggregations. We have to base the new WS on the user report code because is the only one taking care of advanced gradebook features like hiding affected grades, adjust bounds, etc.. A first view of the user grader report reflects its complexity, the more sensible approach (under my opinion) would be not to touch any single line of code and just add a new data structure (rawgradeitemdata) that will be filled in the recursive process of building the grades table. (Basically, in the fill_table_recursive function). At the end, the report class will generate two data structures: tabledata ready for printing the table and the rawgradeitemdata, with a representation of the gradebook ready to be used by external functions. The ideal thing would be to split the code into one function generating a templatable/renderable and then another one for build the table, but looking at the actual code this will be very complex, will require a lot of code duplication and Im afraid of possible regressions.
86.summary: New Web Service core_search_get_search_areas_list
description: Returns the list of existing search areas
87.summary: New Web Service message_airnotifier_get_user_devices
description: Return the list of mobile devices that are registered in Moodle for the given user.
88.summary: New Web Service message_airnotifier_enable_device
description: Enable or disable a mobile device registered in Moodle for the user
89.summary: New Web Service core_user_update_picture
description: Updates or deletes the user picture
90.summary: New Web Service core_course_check_updates
description: Check if a module has been updated since the given timestamp. Parameters: - array of cmid and timestamp Returns: - array of the type of elements that were updated: configuration, files, posts (for forum), pages (for wiki), entries (for glossary), etc.. This wont return the element ids of additional information, just a boolean indicating if something was updated since the given time. Why do we need this information: The mobile app allows to download both resources and activities for offline access/usage. Right now, for calculating if a resource or activity needs update (so we can show a button to allow the user to update the downloaded module) we must perform several "heavy" web services requests. This is because we need to retrieve the module information and associated files and data to compare with the local information stored and see if something was updated. For example: For a quiz we must retrieve the quiz attempts to see if there is a new attempt. For forums, we must download discussions/posts. For assignment, we need to download the recent submissions to check if there is any change. For a normal course we could end up doing lots of requests to display the modules needing update. This is the reason wed need a simple Web Service able to return some basic information about the modules status since a given date. This Web Service will receive a list of cmids and timestamps and well ask every module type to calculate if there has been any update affecting the user since the given time. Please, note that we must specify a different timestamp for each module, because maybe the user updated manually some modules of the course but not all of them. These changes can help us also to "mark/display" in the app the modules with updates since the last visit of the user. So basically with these changes we will be able to: Check if the already downloaded modules (if any) needs to be updated. Every time the user open a course, check for updates to display using badges (red filled circles with a number inside) Implementation This WS will do multiple request for retrieve all the required information for all the modules, but this will have a lower performance impact that the current requests we are doing (right now to calculate the status we perform multiple request) so this will be a performance improvement for both sites using 3.2 and the app. Another implementation approach could have been implement an event observer in a plugin and store the update information in a new database table. Or not an event observer and using direct calls (a new subsystem) or whatever available in lib/ so any component or plugin could report updates. I think that this is the simplest way, and right now it will reduce the amount of request that the app needs to do.
91.summary: New Web Service mod_chat_get_past_sessions
description: Web Service for retrieve the chat past sessions where the user participated
92.summary: New Web Service core_message_get_user_message_preferences
description: In 3.2 the messaging preferences have been split in: Notification preferences Message preferences We already implemented a WS to retrieve notification preferences in but we didnt notice that we were missing the "Message" ones because of the split. Wed need this new WS in order to enabling changing these preferences from the mobile app (it make totally sense to be able to configure what type of notifications you want to receive in Mobile)
93.summary: New Web Services for retrieving chat sessions
description: To retrieve chat past sessions wed need two web services: - mod_chat_get_sessions: To list all the chat sessions for the given chat - mod_chat_get_session_messages: To get the chat messages from one chat session
94.summary: New Web Service core_course_get_updates_since
description: In order to re-use the current check_updates API at module level, we could create a new function for retrieving all the course updates since a given date. Right now, there is a core_course_check_updates function but checks module by module (not the whole course) Parameters would be: courseid since - Check updates since this time stamp filter- Check only for updates in the given areas
95.summary: New Web Service core_user_get_private_files_info
description: We need a WS that will return the remaining user quota in the private files are for the current user.
96.summary: New Web Service core_auth_request_password_reset
description: Public Web Service (via XHR) to allow users to request a password reset using the mobile app.
97.summary: New Web Service core_blog_get_entries
description: New Web Service for retrieving blog entries
98.summary: New Web Service core_blog_view_entries
description: We need a new WS for triggering the blog_entries_viewed event
99.summary: New Web Service mod_glossary_update_entry
description: Ws for updating entries
100.summary: New WebService mod_scorm_get_scorm_access_information
description: We need this WebService to return the capabilities affecting the current user in order to calculate if the user is able to see some information controlled by capabilities (a particular case is the score information). See for more information.
101.summary: New Web Services for updating a forum post (or a discussion topic post)
description: Create a new set of functions for being able to update discussion posts. It will require some additional helper WS function to set/prepare the draft attachment and editors. Web services to be created are: mod_forum_get_discussion_post - To obtain particular information about a post and specifically if the user is able to update ir or not mod_forum_prepare_draft_area_for_post - To prepare the draft areas for a post that it is going to be updated including the files to be kept in the draft area when editing a post mod_forum_update_discussion_post - To update a post
102.summary: New web services for adding and deleting comments
description: New Web Service for adding and deleting comments in any commenting area.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic Create an Event Monitor tool
description: Create a report that lets users subscribe to various events happening in Moodle.
| Unsolvable | 1.summary: Event monitor: Finalise the basic file and database structure
description: Commit the basic file structure with the following:- Directory structure xmldb files permissions (db/access.php)
2.summary: Event monitor: Create a rule manager class with unit tests
description: Create a class report_monitor\rule_manager that lets you Create rules Edit rules Delete rules get rules Get rule With unit tests
3.summary: Event monitor: Create a subscription manager class
description: Create a class report_monitor\subscription_manager that lets you Create subscriptions Delete subscriptions Get subscription Get subscriptions for course Get subscriptions for an event With unit tests
4.summary: Event monitor: Create a class to generate eventlist
description: Create a class to find and list all events with caching
5.summary: Event monitor: Sort out navigation
description: We basically are going to provide three main entry points Subscription management page Rules management page Sort out where these nodes needs to be present in the navigation
6.summary: Event monitor: Create rule class
description: We need a class that represents a rule in the database. It might have the following methods get_module_select delete_rule copy_rule get_plugin_name get_description get_name get_filters_description get_event_name unsubscribe_user subscribe_user If it seems some of these methods can be reused by the subscription class, consider abstraction of those.
7.summary: Event monitor: Create a form to edit/add a new rule
description: We need a form to add/edit a new rule. This issue includes:- The mform with proper validations and such Edit.php to handel forum submissions A yui module to update the select drop downs dynamically (consider creating a mform dependent select element instead? )
8.summary: Event monitor: Create renderables/renderers to display the rule managment page
description: Write a renderer to display rule management interface.
9.summary: Event monitor: Create renderables/renderers to display the subscription managment page
description: Write a renderer to display subscription management interface.
10.summary: Event monitor: Handle creating/deleting subscriptions
description: Write a renderer to display subscription management interface.
11.summary: Event monitor: Handle rule managment
description: Write yui modules to handle the managment of rules Deleting a rule copying a rule
12.summary: Event monitor: Implement the event observer
description: Implement an event observer that populates tool_monitor_events, as needed
13.summary: Event monitor: Implement cron task to send notifications
description: Implement a cron task to check if rule has happened or not and send notifications as required. This will also include creating a new message type.
14.summary: Event monitor: Create a subscription instance class
description: Create a class that represents a subscription instance
15.summary: Event monitor: Write behat tests for the tool
description: Write behat tests for the tool
16.summary: Event monitor: Delete rules when course is deleted
description: We need an observer to delete rules and subscriptions when a course is deleted
17.summary: Event monitor: Add help icon on subscriptions manage page
description: On subscriptions manage page, there should be a help icon which provide further details on each rule. This should be present in both the tables. This can possibly include information such as event name, module name, description, etc. Up to the assignee to decide the best amount of info. Since our help icon infrastructure only supports static content at this point, this might involve writing some yui code to generate custom panels for displaying the help content.
18.summary: Event monitor: Write QA tests for the tool
description: Write QA tests for the tool
19.summary: Event monitor: Remove dependency on
description: Either remove dependency on , or get integrated
20.summary: Event monitor: Handle module and user deletion
description: When a user is deleted all related subscriptions should be deleted. When a module is deleted all related subscriptions should be deleted. (also consider priority of the observers while creating this)
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic Create an Event Monitor tool
description: Create a report that lets users subscribe to various events happening in Moodle.
### Response:
1.summary: Event monitor: Finalise the basic file and database structure
description: Commit the basic file structure with the following:- Directory structure xmldb files permissions (db/access.php)
2.summary: Event monitor: Create a rule manager class with unit tests
description: Create a class report_monitor\rule_manager that lets you Create rules Edit rules Delete rules get rules Get rule With unit tests
3.summary: Event monitor: Create a subscription manager class
description: Create a class report_monitor\subscription_manager that lets you Create subscriptions Delete subscriptions Get subscription Get subscriptions for course Get subscriptions for an event With unit tests
4.summary: Event monitor: Create a class to generate eventlist
description: Create a class to find and list all events with caching
5.summary: Event monitor: Sort out navigation
description: We basically are going to provide three main entry points Subscription management page Rules management page Sort out where these nodes needs to be present in the navigation
6.summary: Event monitor: Create rule class
description: We need a class that represents a rule in the database. It might have the following methods get_module_select delete_rule copy_rule get_plugin_name get_description get_name get_filters_description get_event_name unsubscribe_user subscribe_user If it seems some of these methods can be reused by the subscription class, consider abstraction of those.
7.summary: Event monitor: Create a form to edit/add a new rule
description: We need a form to add/edit a new rule. This issue includes:- The mform with proper validations and such Edit.php to handel forum submissions A yui module to update the select drop downs dynamically (consider creating a mform dependent select element instead? )
8.summary: Event monitor: Create renderables/renderers to display the rule managment page
description: Write a renderer to display rule management interface.
9.summary: Event monitor: Create renderables/renderers to display the subscription managment page
description: Write a renderer to display subscription management interface.
10.summary: Event monitor: Handle creating/deleting subscriptions
description: Write a renderer to display subscription management interface.
11.summary: Event monitor: Handle rule managment
description: Write yui modules to handle the managment of rules Deleting a rule copying a rule
12.summary: Event monitor: Implement the event observer
description: Implement an event observer that populates tool_monitor_events, as needed
13.summary: Event monitor: Implement cron task to send notifications
description: Implement a cron task to check if rule has happened or not and send notifications as required. This will also include creating a new message type.
14.summary: Event monitor: Create a subscription instance class
description: Create a class that represents a subscription instance
15.summary: Event monitor: Write behat tests for the tool
description: Write behat tests for the tool
16.summary: Event monitor: Delete rules when course is deleted
description: We need an observer to delete rules and subscriptions when a course is deleted
17.summary: Event monitor: Add help icon on subscriptions manage page
description: On subscriptions manage page, there should be a help icon which provide further details on each rule. This should be present in both the tables. This can possibly include information such as event name, module name, description, etc. Up to the assignee to decide the best amount of info. Since our help icon infrastructure only supports static content at this point, this might involve writing some yui code to generate custom panels for displaying the help content.
18.summary: Event monitor: Write QA tests for the tool
description: Write QA tests for the tool
19.summary: Event monitor: Remove dependency on
description: Either remove dependency on , or get integrated
20.summary: Event monitor: Handle module and user deletion
description: When a user is deleted all related subscriptions should be deleted. When a module is deleted all related subscriptions should be deleted. (also consider priority of the observers while creating this)
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Initial release of user-specific page
description: Initial release of user-specific page
| Unsolvable | 1.summary: Give user control of whats shown in My feed
description: As reported on Changemap| a user has suggested more control of the My feed timeline on the home page. At the moment, this is just a feed of everything on the instance, but eventually it should be a feed of updates around: Communities the user is part of Collections theyre following People theyre following As weve discussed before, this is separate from the _notifications_ around these. To discuss in more detail!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Initial release of user-specific page
description: Initial release of user-specific page
### Response:
1.summary: Give user control of whats shown in My feed
description: As reported on Changemap| a user has suggested more control of the My feed timeline on the home page. At the moment, this is just a feed of everything on the instance, but eventually it should be a feed of updates around: Communities the user is part of Collections theyre following People theyre following As weve discussed before, this is separate from the _notifications_ around these. To discuss in more detail!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.6.3 upgrade
description: Moodle 3.6.3 was released on Monday 11 March 2019.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.6.3
description:
2.summary: Upgrade learn.moodle.net to 3.6.3
description:
3.summary: Upgrade lang.moodle.org to 3.6.3
description:
4.summary: Upgrade school.demo.moodle.net to 3.6.3
description:
5.summary: Upgrade demo.moodle.net to 3.6.3
description:
6.summary: Upgrade moodle.net to 3.6.3
description:
7.summary: Upgrade download.moodle.org to 3.5.5
description:
8.summary: Upgrade dev.moodle.org to 3.6.3
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.6.3 upgrade
description: Moodle 3.6.3 was released on Monday 11 March 2019.
### Response:
1.summary: Upgrade moodle.org to 3.6.3
description:
2.summary: Upgrade learn.moodle.net to 3.6.3
description:
3.summary: Upgrade lang.moodle.org to 3.6.3
description:
4.summary: Upgrade school.demo.moodle.net to 3.6.3
description:
5.summary: Upgrade demo.moodle.net to 3.6.3
description:
6.summary: Upgrade moodle.net to 3.6.3
description:
7.summary: Upgrade download.moodle.org to 3.5.5
description:
8.summary: Upgrade dev.moodle.org to 3.6.3
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Gradebook push from HQ in 2014
description: These are a list of some of the important Grade issues that we are looking at in 2.8.
| Unsolvable | 1.summary: Grade Scales - Currently, only integers can be specified as letter grade boundaries when creating a grade scale. Provide the ability to specify a real number.
description: When creating a grading scale, the letter grade boundary is chosen from a drop-down list box and only an integer can be chosen. For example. I chose 89 as the letter grade boundary for an A-. As a result, any grade over 89, example 89.1 displays as an A-. I want only an 89.5 or higher to display as an A-. I am requesting a way to specify any number as a letter grade boundary in addtion to the integer choices currently in the drop-down list box, example 89.49 as the letter grade boundary for A-. Perhaps a "combo-box" instead of a "drop-down list box" in the interface would work.
2.summary: Grade - Add an option to export the total in letters
description: In gradebook, when we try to export the grades, we want to add an option that will add an new column at the end that is the total in letter (based on the grades-letters setting of the course.
3.summary: Add events for when a grade has been created/updated
description: It would be nice to be able to register for course final grade updates.
4.summary: Shift controls to category/item settings page and consolidate "Simple" and "Full" grade setup pages
description: This came about during a review of the prototype for the Natural Weighting aggregation method, but it will effect the grade settings page and all aggregation methods generally. Currently there a number of controls on the grade setup pages (formerly the "Categories and items pages") for categories and grade items which could be shifted to the settings page for each. This would simplify the grade settings interface and focus attention on commonly used controls (hiding the potentially confusing ones). Also, we currently present two pages "Simple view" and "Full view". These can be consolidated into a single "Setup" page, with the difference between the pages being accommodated in the settings page for each item. Currently there are columns for: Name (as text) Aggregation (categories) Extra credit (grade items) Exclude empty grades (categories) Aggregate including subcategories (possibly to be removed altogether) Include outcomes in aggregation (categories) Drop the lowest (categories) Multiplicator (grade items) Offset (grade items) Actions... Edit Move (grade items) Hide Lock Select (for moving between categories) It was felt that the minimum set required on the setup page was: Move (to the left of grade item name) Name Aggregation (as text, to the right of category name) Weight (with a + next to it to indicate extra credit items) Max grade Contributed value Actions (converted to an action menu for easier control on touch devices) Edit Hide Lock (is this really needed) Select (but only when categories are used) The remaining controls should be moved to the category/item settings page. This will also help us control these settings more easily, when there are dependencies involved. This work may need to be broken into sub-tasks. Mock-ups and/or a prototype of the new interface needs to be created
5.summary: Nest weightings within categories
description: At the moment, on the Gradebook setup pages (Simple and Full), where weights are used, the weights are all lined up in one column. It is difficult to determine what weights belong to grade items, categories and nested grade items. The weights should be nested to indicate they are within a category.
6.summary: Gradebook terminology improvements
description: As defined by the Gradebook working group: "en" pack: "Aggregate Only Non-Empty Grades" "Exclude empty grades" "Categories & Items" "Setup" "Marks/Marking" "Grades/Grading" (whenever referring to gradebook stuff) "en_us" pack: "Marks Points" (for quiz) Swap string: "Update" on grader report "Save changes" New terms: "Natural weighting"
7.summary: Add option to conditionally aggregate hidden grades
description: The hidden grades are now always aggregated together with all other grades. The problem is that users might calculate the value of hidden grades from the totals. There is a workaround in 1.9, it should be fixed properly in 2.0 (needs db changes) 1/ add field aggregatehidden into grade_items 2/ add field unhideafter into grade_items and grade_grades 3/ add hiding switching logic into regrading 4/ tweak forms and patch the hiding logic
8.summary: User report and Grader report are inconsistent for the grade that is hidden. Allow teacher to toggle to/from "user view"
description: If I am a grader and I decided to hide the grade for one student for an assignment, I can still see it in the Grader report (but the font is gray). If I (again as a grader) go to the user report for this user I: - CAN see the assignment - CAN NOT see any grade, not even gray, in the columns Grade, Percentage, Rank - CAN see the grade in the column Letter grade (I enabled it in settings) As a student I dont see this assignment in the user report at all. There should be a clear policy, what User report shows if it is viewed by a grader: 1) it shows the same as Grader report but for a particular user or 2) it shows the same as what this user would see in his User report Depending on this policy the hidden grades should be shown or the whole line with module should not be shown at all. ---- Regarding Rank: there should be also a policy whether to include the hidden grades in rank or not. At the moment they are included, so for other students the rank is calculated as if hidden grades were normal grades. But for student whose grade is hidden, rank is not displayed (although exists) The column Average displays the average only for grades that are not hidden. So for other users it looks strange: "Rank 2/4, Average 30.00 (3)" So I would suggest that Rank should not include hidden grades
9.summary: Add grade item and student grades quick edit feature to the grader report
description: Add grade item and student grades quick edit feature to the grader report to enable editing for each grade item and for each student: Grades and feedback Grade overrides Excluded grades Thanks to developers at the LSU for this feature - see for more details.
10.summary: Define the desirements for the grade history report
description: The primary goal of integrating the Grade History report is covered in and its sub-tasks. Stage 2 of this will be the potential enhancement of the report. This issue is a placeholder that will act as a collecting point for extensions to the existing report after it has been introduced. Ideas should be well described and documented in order for mockups, specs, and code development to happen. The following ideas have already been suggested. - Diffs (showing differences between two points in time) - Finding editing periods (what does this mean?) - Include grade history in backups - Restore grade history from backups - more ideas from you... Once ideas have been defined and speced, improvement issues will need to be created.
11.summary: Allow categories to be collapsed in the Gradebook setup page
description: The setup page(s) for the gradebook can get long and complicated when there are numerous grade items and categories. One way of potentially reducing the complexity is by allowing the categories to be collapsed on this page, much like settings pages allow sections of settings to be collapsed.
12.summary: Allow the page size in the Single view report to be configurable or remove pagination
description: As an enhancement to the current pagination in the Single view report, the number of items/users shown per-page should be configurable, similar to the method used in the Assignment grading page.
13.summary: Need to decide menu/tab items for Setup items
description: We decided to reduce the categories and items screen down to one page called Setup, but never really sorted out how the new "Setup" page was going to be implemented in navigation. We need to sort out a neat way to organise "Grade settings" and "Setup" in the menus and tabs. Decision: Set up grades layout
14.summary: Consolidate design of recently altered Gradebook pages
description: A number of changes have been made to the interface of certain Gradebook changes. The CSS used to present these interfaces should be reviewed and consolidated. The setup page () The single view report () The user report () Advise on how to best show nesting within the Gradebook setup page is also needed ().
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Gradebook push from HQ in 2014
description: These are a list of some of the important Grade issues that we are looking at in 2.8.
### Response:
1.summary: Grade Scales - Currently, only integers can be specified as letter grade boundaries when creating a grade scale. Provide the ability to specify a real number.
description: When creating a grading scale, the letter grade boundary is chosen from a drop-down list box and only an integer can be chosen. For example. I chose 89 as the letter grade boundary for an A-. As a result, any grade over 89, example 89.1 displays as an A-. I want only an 89.5 or higher to display as an A-. I am requesting a way to specify any number as a letter grade boundary in addtion to the integer choices currently in the drop-down list box, example 89.49 as the letter grade boundary for A-. Perhaps a "combo-box" instead of a "drop-down list box" in the interface would work.
2.summary: Grade - Add an option to export the total in letters
description: In gradebook, when we try to export the grades, we want to add an option that will add an new column at the end that is the total in letter (based on the grades-letters setting of the course.
3.summary: Add events for when a grade has been created/updated
description: It would be nice to be able to register for course final grade updates.
4.summary: Shift controls to category/item settings page and consolidate "Simple" and "Full" grade setup pages
description: This came about during a review of the prototype for the Natural Weighting aggregation method, but it will effect the grade settings page and all aggregation methods generally. Currently there a number of controls on the grade setup pages (formerly the "Categories and items pages") for categories and grade items which could be shifted to the settings page for each. This would simplify the grade settings interface and focus attention on commonly used controls (hiding the potentially confusing ones). Also, we currently present two pages "Simple view" and "Full view". These can be consolidated into a single "Setup" page, with the difference between the pages being accommodated in the settings page for each item. Currently there are columns for: Name (as text) Aggregation (categories) Extra credit (grade items) Exclude empty grades (categories) Aggregate including subcategories (possibly to be removed altogether) Include outcomes in aggregation (categories) Drop the lowest (categories) Multiplicator (grade items) Offset (grade items) Actions... Edit Move (grade items) Hide Lock Select (for moving between categories) It was felt that the minimum set required on the setup page was: Move (to the left of grade item name) Name Aggregation (as text, to the right of category name) Weight (with a + next to it to indicate extra credit items) Max grade Contributed value Actions (converted to an action menu for easier control on touch devices) Edit Hide Lock (is this really needed) Select (but only when categories are used) The remaining controls should be moved to the category/item settings page. This will also help us control these settings more easily, when there are dependencies involved. This work may need to be broken into sub-tasks. Mock-ups and/or a prototype of the new interface needs to be created
5.summary: Nest weightings within categories
description: At the moment, on the Gradebook setup pages (Simple and Full), where weights are used, the weights are all lined up in one column. It is difficult to determine what weights belong to grade items, categories and nested grade items. The weights should be nested to indicate they are within a category.
6.summary: Gradebook terminology improvements
description: As defined by the Gradebook working group: "en" pack: "Aggregate Only Non-Empty Grades" "Exclude empty grades" "Categories & Items" "Setup" "Marks/Marking" "Grades/Grading" (whenever referring to gradebook stuff) "en_us" pack: "Marks Points" (for quiz) Swap string: "Update" on grader report "Save changes" New terms: "Natural weighting"
7.summary: Add option to conditionally aggregate hidden grades
description: The hidden grades are now always aggregated together with all other grades. The problem is that users might calculate the value of hidden grades from the totals. There is a workaround in 1.9, it should be fixed properly in 2.0 (needs db changes) 1/ add field aggregatehidden into grade_items 2/ add field unhideafter into grade_items and grade_grades 3/ add hiding switching logic into regrading 4/ tweak forms and patch the hiding logic
8.summary: User report and Grader report are inconsistent for the grade that is hidden. Allow teacher to toggle to/from "user view"
description: If I am a grader and I decided to hide the grade for one student for an assignment, I can still see it in the Grader report (but the font is gray). If I (again as a grader) go to the user report for this user I: - CAN see the assignment - CAN NOT see any grade, not even gray, in the columns Grade, Percentage, Rank - CAN see the grade in the column Letter grade (I enabled it in settings) As a student I dont see this assignment in the user report at all. There should be a clear policy, what User report shows if it is viewed by a grader: 1) it shows the same as Grader report but for a particular user or 2) it shows the same as what this user would see in his User report Depending on this policy the hidden grades should be shown or the whole line with module should not be shown at all. ---- Regarding Rank: there should be also a policy whether to include the hidden grades in rank or not. At the moment they are included, so for other students the rank is calculated as if hidden grades were normal grades. But for student whose grade is hidden, rank is not displayed (although exists) The column Average displays the average only for grades that are not hidden. So for other users it looks strange: "Rank 2/4, Average 30.00 (3)" So I would suggest that Rank should not include hidden grades
9.summary: Add grade item and student grades quick edit feature to the grader report
description: Add grade item and student grades quick edit feature to the grader report to enable editing for each grade item and for each student: Grades and feedback Grade overrides Excluded grades Thanks to developers at the LSU for this feature - see for more details.
10.summary: Define the desirements for the grade history report
description: The primary goal of integrating the Grade History report is covered in and its sub-tasks. Stage 2 of this will be the potential enhancement of the report. This issue is a placeholder that will act as a collecting point for extensions to the existing report after it has been introduced. Ideas should be well described and documented in order for mockups, specs, and code development to happen. The following ideas have already been suggested. - Diffs (showing differences between two points in time) - Finding editing periods (what does this mean?) - Include grade history in backups - Restore grade history from backups - more ideas from you... Once ideas have been defined and speced, improvement issues will need to be created.
11.summary: Allow categories to be collapsed in the Gradebook setup page
description: The setup page(s) for the gradebook can get long and complicated when there are numerous grade items and categories. One way of potentially reducing the complexity is by allowing the categories to be collapsed on this page, much like settings pages allow sections of settings to be collapsed.
12.summary: Allow the page size in the Single view report to be configurable or remove pagination
description: As an enhancement to the current pagination in the Single view report, the number of items/users shown per-page should be configurable, similar to the method used in the Assignment grading page.
13.summary: Need to decide menu/tab items for Setup items
description: We decided to reduce the categories and items screen down to one page called Setup, but never really sorted out how the new "Setup" page was going to be implemented in navigation. We need to sort out a neat way to organise "Grade settings" and "Setup" in the menus and tabs. Decision: Set up grades layout
14.summary: Consolidate design of recently altered Gradebook pages
description: A number of changes have been made to the interface of certain Gradebook changes. The CSS used to present these interfaces should be reviewed and consolidated. The setup page () The single view report () The user report () Advise on how to best show nesting within the Gradebook setup page is also needed ().
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Users on MoodleNet servers should be able to interact across instances
description: Users on MoodleNet servers should be able to interact across instances
| Unsolvable | 1.summary: UX for following remote community/collection via search
description: .
2.summary: Set up another MoodleNet instance for initial testing
description: Mayel to ask DevOps to set up.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Users on MoodleNet servers should be able to interact across instances
description: Users on MoodleNet servers should be able to interact across instances
### Response:
1.summary: UX for following remote community/collection via search
description: .
2.summary: Set up another MoodleNet instance for initial testing
description: Mayel to ask DevOps to set up.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Performance tool for finding performance regressions
description: We already have moodle-performance-comparison| for finding performance regression, then why a new tool? With current tool, we have hit some bottleneck issues and they were discussed in iTeam meeting| As per proposal| this tool will try to achieve following: Following metrics should be comparable Request/sec Throughput Memory usage Session size (Allow tolerance) Fails (For tuning) Content size db read/write/(querytime) filesincluded (This has direct impact on memory consumption etc.) timeused serverload (Will include this param and evaluate the need. If useful then keep it else discard) Comparison should be possible for big data. Multiple test plans support (including easy to add/remove) Able to compare different runs Specialised expectations/tolerances for every case. This will be done by following 4 tools: Data generator (This will use existing behat data generators and help create site with required data set for testing) Behat feature to JMX (We will have some basic templates as admin/teacher/student, navigating the site,, but dev can create there own scenarios and convert them to jmx using this tool) JMeter + logging (Logging will be enhanced to push data to multiple backend for comparison and analysis) Analysis tool (This will help analyse moodle performance over time and show how and when things got fixed or decisions about performance variation took place.)
| Unsolvable | 1.summary: Data generator for performance tool
description: Data generator is a very important aspect of performance tool, as it create a target site against which the performance metrics will be generated. Target site should not be changed, if data needs to be compared over the period. Current data generator for performance tool doesn t provide much information on actual state of moodle site. Tools should be able to do following: User select/see what activities/resources/users will be created for test site. There will be 6 default generators (XS, S, M, L, XL, XXL) which will be bundled with tool and moodle code (Adding this to moodle code will help dev s initialize there dev env.) Use behat steps, so it gives better visibility. noformat Given I have x courses And each course having x students And each course having x | activity name noformat Target site should be able to identify itself with user/courses/activities etc. so they can be passed to run and logged properly. Tool implementation:
2.summary: Behat feature to JMX
description: This is 2nd tool needed for performance tool. This will facilitate devs and users to write/read test plan by using existing gherkin language (behat), which is much easy to understand and moodle devs use it for acceptance testing. This tools will work with BrowserMobProxy| and should be able to: Create a new proxy port Capture required get/post request from the proxy in HAR format Convert HAR to JMX
3.summary: jMeter Logging
description: Current moodle-performance-comparison tool record runs and push it in php as array. It is later used by comparison tool. This tool will use monolog with interfaces to push data to different stores for analysis.
4.summary: Comparison and analysis tool
description: Current performance comparison tool will be improved to give following results: Compare weekly runs on basis of tolerance Comparison of results overtime Record modified tolerances overtime, with details of decision.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Performance tool for finding performance regressions
description: We already have moodle-performance-comparison| for finding performance regression, then why a new tool? With current tool, we have hit some bottleneck issues and they were discussed in iTeam meeting| As per proposal| this tool will try to achieve following: Following metrics should be comparable Request/sec Throughput Memory usage Session size (Allow tolerance) Fails (For tuning) Content size db read/write/(querytime) filesincluded (This has direct impact on memory consumption etc.) timeused serverload (Will include this param and evaluate the need. If useful then keep it else discard) Comparison should be possible for big data. Multiple test plans support (including easy to add/remove) Able to compare different runs Specialised expectations/tolerances for every case. This will be done by following 4 tools: Data generator (This will use existing behat data generators and help create site with required data set for testing) Behat feature to JMX (We will have some basic templates as admin/teacher/student, navigating the site,, but dev can create there own scenarios and convert them to jmx using this tool) JMeter + logging (Logging will be enhanced to push data to multiple backend for comparison and analysis) Analysis tool (This will help analyse moodle performance over time and show how and when things got fixed or decisions about performance variation took place.)
### Response:
1.summary: Data generator for performance tool
description: Data generator is a very important aspect of performance tool, as it create a target site against which the performance metrics will be generated. Target site should not be changed, if data needs to be compared over the period. Current data generator for performance tool doesn t provide much information on actual state of moodle site. Tools should be able to do following: User select/see what activities/resources/users will be created for test site. There will be 6 default generators (XS, S, M, L, XL, XXL) which will be bundled with tool and moodle code (Adding this to moodle code will help dev s initialize there dev env.) Use behat steps, so it gives better visibility. noformat Given I have x courses And each course having x students And each course having x | activity name noformat Target site should be able to identify itself with user/courses/activities etc. so they can be passed to run and logged properly. Tool implementation:
2.summary: Behat feature to JMX
description: This is 2nd tool needed for performance tool. This will facilitate devs and users to write/read test plan by using existing gherkin language (behat), which is much easy to understand and moodle devs use it for acceptance testing. This tools will work with BrowserMobProxy| and should be able to: Create a new proxy port Capture required get/post request from the proxy in HAR format Convert HAR to JMX
3.summary: jMeter Logging
description: Current moodle-performance-comparison tool record runs and push it in php as array. It is later used by comparison tool. This tool will use monolog with interfaces to push data to different stores for analysis.
4.summary: Comparison and analysis tool
description: Current performance comparison tool will be improved to give following results: Compare weekly runs on basis of tolerance Comparison of results overtime Record modified tolerances overtime, with details of decision.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Learn Moodle MOOC Jan 2017
description:
| Unsolvable | 1.summary: Create a sign-up enrolment plugin for Learn Moodle
description: Needs to cater for user-friendly enrolment to the upcoming MOOC for both new and returning users including mobile app users. In the Sept 2013 MOOC we used the standard self-enrolment plugin, however it proved a problem for people to click a link to enrol in the course and then on the next page have to click an Enrol me in this course button. Thus we searched for a one-step enrolment solution and came up with the enrol_autoenrol plugin (). This has been fine for subsequent MOOCs apart from not being able to sign up via the mobile app. Note: Up to now weve also had guest access enabled; from Jan 2017 we wont.
2.summary: Create badges for the 2017 Learn Moodle MOOC
description: Husveen we need our 3 Learn Moodle MOOC badges updating for 2017 with the date changed from 2016 to 2017 (no other changes required) Are you able to do these on January 3rd at all, please, so we can award the Participants badge as soon as possible once the course begins? I am linking to the original tracker issue where barbararamiro made the original badges - we use the orange versions. Many thanks!
3.summary: Enable the Learn Moodle front page text to be editable
description: Since upgrading the site to 3.2 with the Boost theme, the text Welcome to the official Moodle MOOC site. Our next course will start on 2 January 2017. is no longer editable.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Learn Moodle MOOC Jan 2017
description:
### Response:
1.summary: Create a sign-up enrolment plugin for Learn Moodle
description: Needs to cater for user-friendly enrolment to the upcoming MOOC for both new and returning users including mobile app users. In the Sept 2013 MOOC we used the standard self-enrolment plugin, however it proved a problem for people to click a link to enrol in the course and then on the next page have to click an Enrol me in this course button. Thus we searched for a one-step enrolment solution and came up with the enrol_autoenrol plugin (). This has been fine for subsequent MOOCs apart from not being able to sign up via the mobile app. Note: Up to now weve also had guest access enabled; from Jan 2017 we wont.
2.summary: Create badges for the 2017 Learn Moodle MOOC
description: Husveen we need our 3 Learn Moodle MOOC badges updating for 2017 with the date changed from 2016 to 2017 (no other changes required) Are you able to do these on January 3rd at all, please, so we can award the Participants badge as soon as possible once the course begins? I am linking to the original tracker issue where barbararamiro made the original badges - we use the orange versions. Many thanks!
3.summary: Enable the Learn Moodle front page text to be editable
description: Since upgrading the site to 3.2 with the Boost theme, the text Welcome to the official Moodle MOOC site. Our next course will start on 2 January 2017. is no longer editable.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Analytics 3.8 improvements
description: List of improvements / relevant bug fixes for Moodle 3.8
| Unsolvable | 1.summary: Analytics models may be restricted to category or course contexts
description: is scheduled for 3.7, it will allow people to create as many prediction models as they want, reusing the same target. A new "Restrict model to the following contexts" option would allow people to set up separate predictive models for different course categories or courses. A model restricted to a set of contexts (just CONTEXT_COURSE and CONTEXT_COURSECAT) would limit the analysable elements used by the model to analysable elements whose context is equal to, or a child of, any of the contexts specified in "Restrict to the following contexts". The required changes to core could be summarized here: A new field to models db table (e.g. contexts) A new field in the edit model form (e.g. an autocomplete field with a list of courses and course categories) A new \core_analytics\local\analyser\base::supports_context_filtering() method to show/hide the new field (the point right above this one) Modifications to the analytics API to pre-fill optionsfilter with the list of contexts Modifications to cores get_analysables_iterator() implementations (core_analytics\local\analyser\by_course and core\analytics\analyser\users) to receive $this->optionsfilter as a parameter and take it into account A new helper method somewhere in core_analytics to return an SQL that joins with the context table and uses the ctx.path value of the provided context to filter out analysables that do not fit into the restricted list of contexts for the model. This method will be called by get_analysables() implementations where supports_context_filtering == true A modification to the current evaluation process, which supports a filter by course option. I would vote to just replace this filter by course for the filter by contextid/s A review of the analytics caching system to ensure we dont break anything Unit tests should be added to test everything. Specially helpful to detect possible issues in the point right above this one I may be missing extra stuff, but those are the most critical points we need to cover.
2.summary: Report on the actions executed by users on predictions
description: We have been storing which of the suggested actions are executed by users. We should report on it. Some filtering capabilities should be added. Context filtering is a requirement. Other filters like start and end dates can also be included as part of this issue or as a separate issue. The generation of charts in time-series can also be included if it does not require significant resources.
3.summary: Insights about students who have not logged in recently
description: I propose two new insights for teachers: Students who have not accessed the course recently Periodic insights (e.g. weekly, monthly...) Students who have not started the course since its start date Just 1 insight generated after X days (e.g. 15 days, 1 month...) The model can extend from the course_enrolment base and reuse an existing read_actions indicator as any course view generates a read event. The suggested actions would include the usual Send message + View details + Acknowledge + Not useful. I would not include the "Outline report" here though. These models have great value for the resources we have to dedicate to them.
4.summary: Allow targets to limit the analysis interval to a specific interface or parent class.
description: The list of time-splitting methods you can select for a model includes all the time-splitting methods in the system. Some time-splitting methods do not make sense for some targets and our UI still allow these combinations. This is confusing and leads to wrong uses of the system A possible solution for this is to allow targets to specify a set of time-splitting method interfaces or parent classes so the choices in the time-splitting select menu are limited to the ones that match the specified interfaces. The important point to discuss is the upgrade path. i.e. what should we do with models in the database whose time-splitting method will be invalid according to these new limitations imposed by the model targets? My best proposal is to disable them and remove the existing time-splitting method value as their state will be incorrect according to the new limitations. This proposal is based on the assumption that most models will not work anyway using incorrect time-splitting methods. Most (if not all) the time-splitting methods in core already extend different base classes so this issue should be quite simple. A review and classification of the existing time-splitting methods and also potential new time-splitting methods should be part of this issue as one of the riskswe have is that we could limit too much what people can do. For example, if we limit students at risk to time-splitting methods that split the course in parts we wont allow someone to write a new time-splitting method that generates predictions for students at risk targets 34 days after the course start.
5.summary: Rename Time-splitting to Analysis interval + other wording improvements
description: This issue involves 3 different aspects. Time-splitting method in the UI Time-splitting method is not a nice name, it is not even nice to type. It sounds like something very complex and weird and it does not even reflect what it really is as not all time-splitting methods split the duration of an analysable element in parts. To update all the internal references to time-splitting method would be hell, but we can change the references in the UI by something more user-friendly. After asking for suggestions emdalton1 proposed "Prediction interval" or "Analysis interval". I personally like "analysis interval" because those same intervals are also used to generate training data. The name of the time-splitting methods in core Naming specific time-splitting methods has also been challenging because: We talk about "the start" or about "the end" without mentioning the start or the end of what. The name of the target helps here, but still, it is not 100 clear. This is the price for having reusable elements in this API... We need to inform users of too many things in just 1 line How many predictions (i.e. intervals for analysis) will be generated? When will the system generate predictions? What interval will be used during each of the analysis? Therefore, as part of this change we should also review the names we have been using to describe the time-splitting methods we have in core as these options would not directly make sense when put next to a field named "Analysis interval". I propose to use the help link to clearly explain 1, 2.1, 2.2 and 2.3. I am writing a proposal for this that will be also useful for . This is the draft image. !Types of time-splitting methods (2).png|thumbnail! The "Get predictions" action is not a get predictions on-demand I can imagine someone that does not know much about this system expecting a model to generate predictions every time a user clicks on "Get predictions". This is not how time-splitting methods work and it is related with the point 2.2 in The name of the time-splitting methods in core. A model that uses a time-splitting method that only generates 1 prediction for each sample will calculate the indicators and generate the prediction the first time the "Get prediction" action is executed. The second time it is executed we will detect that this model already generated a prediction for that sample and will return a No new predictions yet message. The same happens with time-splitting methods that generate predictions after each quarter of the course. After the first quarter of the course a prediction will be generated when "Get predictions" is executed or when the cron executes it automatically. If a site manager manually executes "Get predictions" the following day, the No new predictions yet message will be displayed again and no new predictions will be generated until the next quarter of the course is over. We either need to rename the Get predictions action or to reword the No new predictions yet message.
6.summary: Extra garbage collection for analytics
description: Further testing for revealed that a chunk of data was not removed by PHPs garbage collector. After several days investigating the issue I ended up identifying a late initialisation of the CLI renderer as the root cause for the memory leak. $PAGE is not initialised until the grades API (required by one of the indicators used in the model) is called, moodle_page::_wherethemewasinitialised is then set to debug_backtrace() which contains the indicator instance so the instance is not garbage collected until the end of the script, when moodle_page is destroyed, blocking that chunk of data allocated in PHPs memory until the end of the script. PHP instances are not removed from memory when there are references to them, even when calling unset($instance) and this is what was happening in this case. The provided patch includes a couple of performance improvements to free memory back to the OS as soon as possible,
7.summary: Require enrolments to be active for most of the analysis interval
description: In we attempted to discard enrolments whose start date is after the course start so that the new enrolments added halfway through the course would not get incorrect predictions. The analytics API will identify a new sample and will analyse it the first time the cron runs. They may get false negatives (incorrect at-risk predictions) because the indicators will be calculated since the start of the course (for example) and they would not have much activity logged up to that point in time. I suggest to require user enrolments to span through most of the analysis interval (e.g. a 70 of the interval). Example of what would happen with this issues patch in in the following scenario: Course starts on the 1st June, we analyse the course on the 10th June with an analysis interval from the 1st June to the 10th June. New enrolments 5 mins after the course start -> All the enrolments will be analysed New enrolment on the 2nd June -> It will be analysed New enrolment on the 7th June -> It will not be analysed For analysis intervals with fixed start and end dates like "Past quarter", where the start and end dates are fixed and depend on the course start and end date, the student in case 3 will not get a prediction until the predictions for the next quarter of the course are generated. For analysis intervals with variable start and end dates like the ones added in , where the end date is now, the student in case 3 will get a prediction on the 24th June, that is 17 days after the enrolment (17/24 = 0.7083, which is higher than the 70 in the example above)
8.summary: Add behat tests for the new students at risk models in 3.8
description: Two new models have been added to core in . They help teachers easily identify students who have not logged in for large periods. We need to cover these models with behat tests.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Analytics 3.8 improvements
description: List of improvements / relevant bug fixes for Moodle 3.8
### Response:
1.summary: Analytics models may be restricted to category or course contexts
description: is scheduled for 3.7, it will allow people to create as many prediction models as they want, reusing the same target. A new "Restrict model to the following contexts" option would allow people to set up separate predictive models for different course categories or courses. A model restricted to a set of contexts (just CONTEXT_COURSE and CONTEXT_COURSECAT) would limit the analysable elements used by the model to analysable elements whose context is equal to, or a child of, any of the contexts specified in "Restrict to the following contexts". The required changes to core could be summarized here: A new field to models db table (e.g. contexts) A new field in the edit model form (e.g. an autocomplete field with a list of courses and course categories) A new \core_analytics\local\analyser\base::supports_context_filtering() method to show/hide the new field (the point right above this one) Modifications to the analytics API to pre-fill optionsfilter with the list of contexts Modifications to cores get_analysables_iterator() implementations (core_analytics\local\analyser\by_course and core\analytics\analyser\users) to receive $this->optionsfilter as a parameter and take it into account A new helper method somewhere in core_analytics to return an SQL that joins with the context table and uses the ctx.path value of the provided context to filter out analysables that do not fit into the restricted list of contexts for the model. This method will be called by get_analysables() implementations where supports_context_filtering == true A modification to the current evaluation process, which supports a filter by course option. I would vote to just replace this filter by course for the filter by contextid/s A review of the analytics caching system to ensure we dont break anything Unit tests should be added to test everything. Specially helpful to detect possible issues in the point right above this one I may be missing extra stuff, but those are the most critical points we need to cover.
2.summary: Report on the actions executed by users on predictions
description: We have been storing which of the suggested actions are executed by users. We should report on it. Some filtering capabilities should be added. Context filtering is a requirement. Other filters like start and end dates can also be included as part of this issue or as a separate issue. The generation of charts in time-series can also be included if it does not require significant resources.
3.summary: Insights about students who have not logged in recently
description: I propose two new insights for teachers: Students who have not accessed the course recently Periodic insights (e.g. weekly, monthly...) Students who have not started the course since its start date Just 1 insight generated after X days (e.g. 15 days, 1 month...) The model can extend from the course_enrolment base and reuse an existing read_actions indicator as any course view generates a read event. The suggested actions would include the usual Send message + View details + Acknowledge + Not useful. I would not include the "Outline report" here though. These models have great value for the resources we have to dedicate to them.
4.summary: Allow targets to limit the analysis interval to a specific interface or parent class.
description: The list of time-splitting methods you can select for a model includes all the time-splitting methods in the system. Some time-splitting methods do not make sense for some targets and our UI still allow these combinations. This is confusing and leads to wrong uses of the system A possible solution for this is to allow targets to specify a set of time-splitting method interfaces or parent classes so the choices in the time-splitting select menu are limited to the ones that match the specified interfaces. The important point to discuss is the upgrade path. i.e. what should we do with models in the database whose time-splitting method will be invalid according to these new limitations imposed by the model targets? My best proposal is to disable them and remove the existing time-splitting method value as their state will be incorrect according to the new limitations. This proposal is based on the assumption that most models will not work anyway using incorrect time-splitting methods. Most (if not all) the time-splitting methods in core already extend different base classes so this issue should be quite simple. A review and classification of the existing time-splitting methods and also potential new time-splitting methods should be part of this issue as one of the riskswe have is that we could limit too much what people can do. For example, if we limit students at risk to time-splitting methods that split the course in parts we wont allow someone to write a new time-splitting method that generates predictions for students at risk targets 34 days after the course start.
5.summary: Rename Time-splitting to Analysis interval + other wording improvements
description: This issue involves 3 different aspects. Time-splitting method in the UI Time-splitting method is not a nice name, it is not even nice to type. It sounds like something very complex and weird and it does not even reflect what it really is as not all time-splitting methods split the duration of an analysable element in parts. To update all the internal references to time-splitting method would be hell, but we can change the references in the UI by something more user-friendly. After asking for suggestions emdalton1 proposed "Prediction interval" or "Analysis interval". I personally like "analysis interval" because those same intervals are also used to generate training data. The name of the time-splitting methods in core Naming specific time-splitting methods has also been challenging because: We talk about "the start" or about "the end" without mentioning the start or the end of what. The name of the target helps here, but still, it is not 100 clear. This is the price for having reusable elements in this API... We need to inform users of too many things in just 1 line How many predictions (i.e. intervals for analysis) will be generated? When will the system generate predictions? What interval will be used during each of the analysis? Therefore, as part of this change we should also review the names we have been using to describe the time-splitting methods we have in core as these options would not directly make sense when put next to a field named "Analysis interval". I propose to use the help link to clearly explain 1, 2.1, 2.2 and 2.3. I am writing a proposal for this that will be also useful for . This is the draft image. !Types of time-splitting methods (2).png|thumbnail! The "Get predictions" action is not a get predictions on-demand I can imagine someone that does not know much about this system expecting a model to generate predictions every time a user clicks on "Get predictions". This is not how time-splitting methods work and it is related with the point 2.2 in The name of the time-splitting methods in core. A model that uses a time-splitting method that only generates 1 prediction for each sample will calculate the indicators and generate the prediction the first time the "Get prediction" action is executed. The second time it is executed we will detect that this model already generated a prediction for that sample and will return a No new predictions yet message. The same happens with time-splitting methods that generate predictions after each quarter of the course. After the first quarter of the course a prediction will be generated when "Get predictions" is executed or when the cron executes it automatically. If a site manager manually executes "Get predictions" the following day, the No new predictions yet message will be displayed again and no new predictions will be generated until the next quarter of the course is over. We either need to rename the Get predictions action or to reword the No new predictions yet message.
6.summary: Extra garbage collection for analytics
description: Further testing for revealed that a chunk of data was not removed by PHPs garbage collector. After several days investigating the issue I ended up identifying a late initialisation of the CLI renderer as the root cause for the memory leak. $PAGE is not initialised until the grades API (required by one of the indicators used in the model) is called, moodle_page::_wherethemewasinitialised is then set to debug_backtrace() which contains the indicator instance so the instance is not garbage collected until the end of the script, when moodle_page is destroyed, blocking that chunk of data allocated in PHPs memory until the end of the script. PHP instances are not removed from memory when there are references to them, even when calling unset($instance) and this is what was happening in this case. The provided patch includes a couple of performance improvements to free memory back to the OS as soon as possible,
7.summary: Require enrolments to be active for most of the analysis interval
description: In we attempted to discard enrolments whose start date is after the course start so that the new enrolments added halfway through the course would not get incorrect predictions. The analytics API will identify a new sample and will analyse it the first time the cron runs. They may get false negatives (incorrect at-risk predictions) because the indicators will be calculated since the start of the course (for example) and they would not have much activity logged up to that point in time. I suggest to require user enrolments to span through most of the analysis interval (e.g. a 70 of the interval). Example of what would happen with this issues patch in in the following scenario: Course starts on the 1st June, we analyse the course on the 10th June with an analysis interval from the 1st June to the 10th June. New enrolments 5 mins after the course start -> All the enrolments will be analysed New enrolment on the 2nd June -> It will be analysed New enrolment on the 7th June -> It will not be analysed For analysis intervals with fixed start and end dates like "Past quarter", where the start and end dates are fixed and depend on the course start and end date, the student in case 3 will not get a prediction until the predictions for the next quarter of the course are generated. For analysis intervals with variable start and end dates like the ones added in , where the end date is now, the student in case 3 will get a prediction on the 24th June, that is 17 days after the enrolment (17/24 = 0.7083, which is higher than the 70 in the example above)
8.summary: Add behat tests for the new students at risk models in 3.8
description: Two new models have been added to core in . They help teachers easily identify students who have not logged in for large periods. We need to cover these models with behat tests.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Remove Assignment 2.2
description: Remove mod_assignment (NOT mod_assign) from the platform. This activity has been disabled by default since version 2.2 (2012) and has been long replaced by mod_assign. It It s important to remove things like this to reduce technical debt and the ongoing support burden, so we can focus on future initiatives. mod_assignment will still be available as a backup from the Moodle HQ github repo, but it wont be updated further by Moodle. From 4.2 onwards someone wishing to restore a backup containing instances of mod_assignment will need to install the plugin. Otherwise the course will restore without mod_assignment instances.
| Unsolvable | 1.summary: Remove Assignment 2.2 (mod_assignment) from core
description: The Assignment 2.2 activity module has been disabled by default since 2012 but was kept to enable pre-2.2 backups to be restored and have the assignments auto-converted to new assignments. Lets remove it from Moodle 4.2 and add it to the git repository for anyone who still needs to restore pre-2.2 backups. Link to the plugin:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Remove Assignment 2.2
description: Remove mod_assignment (NOT mod_assign) from the platform. This activity has been disabled by default since version 2.2 (2012) and has been long replaced by mod_assign. It It s important to remove things like this to reduce technical debt and the ongoing support burden, so we can focus on future initiatives. mod_assignment will still be available as a backup from the Moodle HQ github repo, but it wont be updated further by Moodle. From 4.2 onwards someone wishing to restore a backup containing instances of mod_assignment will need to install the plugin. Otherwise the course will restore without mod_assignment instances.
### Response:
1.summary: Remove Assignment 2.2 (mod_assignment) from core
description: The Assignment 2.2 activity module has been disabled by default since 2012 but was kept to enable pre-2.2 backups to be restored and have the assignments auto-converted to new assignments. Lets remove it from Moodle 4.2 and add it to the git repository for anyone who still needs to restore pre-2.2 backups. Link to the plugin:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: META: Downloads reboot
description: Download sites to have green colour-scheme and a better design covering all the downloads we have including mobile in nice clear pages.
| Solvable | 1.summary: Plugins redesign
description:
2.summary: Downloads site makeover
description: From Martins notes: bq. Re-make Download site as a simple web page and update it with new theme.
3.summary: Switch download.moodle.org from CVS to git
description: With CVS being abandoned completely in January 2013, its time to switch all the dependent stuff @ download.moodle.org to it. This involves: 1) Create one packager that, given one commit/tag/branch is able to build the corresponding package using git as source. 2) Switch from current nightly/daily executed scripts to better git hook based solution. 3) Modify the generation of windows and windows_wpi packages from CVS to git. 4) Modify the detection of available moodle versions in the updates API from CVS to git. 5) Verify all the scripts @ download.moodle.org, switching any use from CVS to git. 6) Cleanup unused scripts. 7) Improve the sync with sourceforge. 8) Improve the download/index.php page generation to dynamically change based on available/supported packages. 9) Document how everything is done (scripts, cron, uses...) once implemented. 10) Modify/adjust the minor & major releases Moodle Docs / mdlrelease process to define the git packaging system. Thats all I can imagine for now. Subtasks will be created to keep the process clear. Ciao :-)
4.summary: Create a downloads index page
description: Page (green colour scheme) should list all standard packages as on and have links to
5.summary: Add black sites bar to downloads pages
description:
6.summary: Show plugin announcements on moodle.org/plugins
description: Similar to the announcements bar on the front page of moodle.org, showing posts from a plugins news forum in the Moodle in English course. The plugins news forum could be in a blog-like format, like Integration, exposed It could also allow replies, and then only discussions (not replies) are shown on moodle.org/plugins.
7.summary: Style language pack download pages
description: etc Language pack download pages should have a green colour-scheme.
8.summary: Convert downloads2history2summary.php to Moodle 2.7 APIs
description: /var/www/vhosts/download.moodle.org/html/downloads2history2summary.php is currently running in crontab and emailing martin and eloy
9.summary: Verify entry point pages
description: Make sure all these subdirs all keep working: And these (without fancy index pages):
10.summary: Deal with serverscripts deployed php scripts
description: Files here get auto-deployed by the serversscripts stuff The distinction between these scripts and those which im going to be keeping in local_downloadmoodleorg should be made and adjustments ill need to be made to the actual deployed scritps (i.e. Moodle 2.4isms)
11.summary: Split Mac downloads metadata from index.php
description: For the new 2.7-based downloads site, the php script which generated the mac index page for dispaly will be part of the local_moodleorg plugin. As such well need to split the metadata away from the current index.php file. I suggest for the first step, we just move the $versions array into a seperate file which can be included by the old index page and the new one.
12.summary: Navigation to the windows/mac build pages
description: At the moment we have links to the mac/windows builds from the main download page. Its just this text: "We also have some special installer packages for Mac OS X and Windows.". We are getting rid of that wall of text from the top of So we need to replace it with some way to navigate to these pages.. Maybe a block or something.. NOTE: IMO these builds are not recommended, wed prefer people to use the standard downloads - especially large institutions. So they shouldnt be especially prominent links.
13.summary: Create a download.moodle.org/mobile page
description: For listing links to download the Moodle mobile app for Android, iOS and Windows, also other relevant links such as Moodle for mobile forum also a screenshot of the app. For similar page see
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: META: Downloads reboot
description: Download sites to have green colour-scheme and a better design covering all the downloads we have including mobile in nice clear pages.
### Response:
1.summary: Plugins redesign
description:
2.summary: Downloads site makeover
description: From Martins notes: bq. Re-make Download site as a simple web page and update it with new theme.
3.summary: Switch download.moodle.org from CVS to git
description: With CVS being abandoned completely in January 2013, its time to switch all the dependent stuff @ download.moodle.org to it. This involves: 1) Create one packager that, given one commit/tag/branch is able to build the corresponding package using git as source. 2) Switch from current nightly/daily executed scripts to better git hook based solution. 3) Modify the generation of windows and windows_wpi packages from CVS to git. 4) Modify the detection of available moodle versions in the updates API from CVS to git. 5) Verify all the scripts @ download.moodle.org, switching any use from CVS to git. 6) Cleanup unused scripts. 7) Improve the sync with sourceforge. 8) Improve the download/index.php page generation to dynamically change based on available/supported packages. 9) Document how everything is done (scripts, cron, uses...) once implemented. 10) Modify/adjust the minor & major releases Moodle Docs / mdlrelease process to define the git packaging system. Thats all I can imagine for now. Subtasks will be created to keep the process clear. Ciao :-)
4.summary: Create a downloads index page
description: Page (green colour scheme) should list all standard packages as on and have links to
5.summary: Add black sites bar to downloads pages
description:
6.summary: Show plugin announcements on moodle.org/plugins
description: Similar to the announcements bar on the front page of moodle.org, showing posts from a plugins news forum in the Moodle in English course. The plugins news forum could be in a blog-like format, like Integration, exposed It could also allow replies, and then only discussions (not replies) are shown on moodle.org/plugins.
7.summary: Style language pack download pages
description: etc Language pack download pages should have a green colour-scheme.
8.summary: Convert downloads2history2summary.php to Moodle 2.7 APIs
description: /var/www/vhosts/download.moodle.org/html/downloads2history2summary.php is currently running in crontab and emailing martin and eloy
9.summary: Verify entry point pages
description: Make sure all these subdirs all keep working: And these (without fancy index pages):
10.summary: Deal with serverscripts deployed php scripts
description: Files here get auto-deployed by the serversscripts stuff The distinction between these scripts and those which im going to be keeping in local_downloadmoodleorg should be made and adjustments ill need to be made to the actual deployed scritps (i.e. Moodle 2.4isms)
11.summary: Split Mac downloads metadata from index.php
description: For the new 2.7-based downloads site, the php script which generated the mac index page for dispaly will be part of the local_moodleorg plugin. As such well need to split the metadata away from the current index.php file. I suggest for the first step, we just move the $versions array into a seperate file which can be included by the old index page and the new one.
12.summary: Navigation to the windows/mac build pages
description: At the moment we have links to the mac/windows builds from the main download page. Its just this text: "We also have some special installer packages for Mac OS X and Windows.". We are getting rid of that wall of text from the top of So we need to replace it with some way to navigate to these pages.. Maybe a block or something.. NOTE: IMO these builds are not recommended, wed prefer people to use the standard downloads - especially large institutions. So they shouldnt be especially prominent links.
13.summary: Create a download.moodle.org/mobile page
description: For listing links to download the Moodle mobile app for Android, iOS and Windows, also other relevant links such as Moodle for mobile forum also a screenshot of the app. For similar page see
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: META: Events 2
description: Major overhaul of the current event system. Specification doc:
| Unsolvable | 1.summary: Pre and post performance profiling
description: Decide and implement performance tests, to measure the impact of the changes.
2.summary: Check coverage of unit tests for new events API
description: Write unit tests for anything that was not covered in previous issues. Create new event handler management class that deals with installation and upgrades of both legacy and new handlers.
3.summary: Define new event dispatcher behaviour and implement it
description: 1/ Describe new event dispatcher 2/ Implement new event dispatching 3/ Add phpunit support for event observation
4.summary: Remove deprecated calls to get_plugin_types(), get_plugin_list() etc
description: After is integrated we need to: Get rid of the deprecated calls in core. Add much more docs about the deprecations, including in upgrade.txt
5.summary: Define and implement the event base class
description: Define the base class for the event system.
6.summary: check usage of class_exists to avoid usage of autoloading
description: Currently class_exits is not passing second parameter as false, in blocklib.php and pluginlib.php, because of which autoloader is called and hence can hit performance with autoloader functionality. Look at other usage of class_exists function and pass second param as false, where appropriate.
7.summary: Define the new observers API
description: Describe new observer definition - just few new flags in current db/events.php
8.summary: Decide how to deal with legacy events
description: See: The requirements are: 1/ 100 backwards compatibility - all existing events are triggered with the same data 2/ easy migration - the migration process should be easy for developers 3/ performance - in future we may way to disable legacy events completely with simple setting, there should not be any overhead when legacy events disabled
9.summary: Automatic class loading
description: It would be nice to have an official class loader for Frankenstyle based class names in Moodle core. See
10.summary: change observer priority handling
description: At present we calculate the priority of "" and observers of individual events together, I would like to propose to always first execute all "" ordered by priority and then all other observers sorted separately by priority. benefits: 1/ tiny bit faster when constructing the nested array of observers 2/ tiny less memory used because the cached list of handlers would be smaller ( would not be repeated) 3/ this would allow us to introduce observing of parent class events without breaking BC (if we ever want that in the future) problems: 1/ specific observers could not be executed first and could not be last The priority was introduced in order to allow the logging subsystems to process events as the first observer to eliminate data modifications from previous handlers. So far we did not find any other major use cases for the priority flag in observers - ideas?
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: META: Events 2
description: Major overhaul of the current event system. Specification doc:
### Response:
1.summary: Pre and post performance profiling
description: Decide and implement performance tests, to measure the impact of the changes.
2.summary: Check coverage of unit tests for new events API
description: Write unit tests for anything that was not covered in previous issues. Create new event handler management class that deals with installation and upgrades of both legacy and new handlers.
3.summary: Define new event dispatcher behaviour and implement it
description: 1/ Describe new event dispatcher 2/ Implement new event dispatching 3/ Add phpunit support for event observation
4.summary: Remove deprecated calls to get_plugin_types(), get_plugin_list() etc
description: After is integrated we need to: Get rid of the deprecated calls in core. Add much more docs about the deprecations, including in upgrade.txt
5.summary: Define and implement the event base class
description: Define the base class for the event system.
6.summary: check usage of class_exists to avoid usage of autoloading
description: Currently class_exits is not passing second parameter as false, in blocklib.php and pluginlib.php, because of which autoloader is called and hence can hit performance with autoloader functionality. Look at other usage of class_exists function and pass second param as false, where appropriate.
7.summary: Define the new observers API
description: Describe new observer definition - just few new flags in current db/events.php
8.summary: Decide how to deal with legacy events
description: See: The requirements are: 1/ 100 backwards compatibility - all existing events are triggered with the same data 2/ easy migration - the migration process should be easy for developers 3/ performance - in future we may way to disable legacy events completely with simple setting, there should not be any overhead when legacy events disabled
9.summary: Automatic class loading
description: It would be nice to have an official class loader for Frankenstyle based class names in Moodle core. See
10.summary: change observer priority handling
description: At present we calculate the priority of "" and observers of individual events together, I would like to propose to always first execute all "" ordered by priority and then all other observers sorted separately by priority. benefits: 1/ tiny bit faster when constructing the nested array of observers 2/ tiny less memory used because the cached list of handlers would be smaller ( would not be repeated) 3/ this would allow us to introduce observing of parent class events without breaking BC (if we ever want that in the future) problems: 1/ specific observers could not be executed first and could not be last The priority was introduced in order to allow the logging subsystems to process events as the first observer to eliminate data modifications from previous handlers. So far we did not find any other major use cases for the priority flag in observers - ideas?
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Create a Moodle overview video that cleanly shows anyone what Moodle actually does
description: We really need one clean, professionally-designed overview video that really explains how the Moodle software works. I imagine a slick quality entertaining video not more than 5 minutes long. If possible the video should not use English examples so it can be translated more easily with alternate soundtracks and text overlays.
| Unsolvable | 1.summary: Develop storyboard for Moodle software overview video
description: Final Storyboard (subject to modifications during production): (SHOTS run under the text that follows them.) SHOT: intro titles SHOT: animated or talking head or both Moodle is a course management system. Moodle runs on a web server, and by customising it you can make it into the perfect private place for your educators and students to collaborate. SHOT: Pan across categories structure showing typical school departments SHOT: Pan across a participant listing in a course, including use of the roles menu A Moodle site mostly consists of courses, which can be organised into categories and users, who can be given roles within the courses and categories, such as teacher, or student. SHOT: Show an admin changing categories SHOT: Show roles list, and an admin adding new role for Supervisor . A Moodle administrator can create and modify roles and categories to any structure they like, to adapt it for all kinds of educational situations. SHOT: Pan across some different course formats, including contrib plugins like Grid SHOT: Show some adding of blocks and moving them around at a sped-up speed As a teacher in my private Moodle course, I can choose the course format that suits my learners, organised by week, by topic, or all kinds of other layouts that the Moodle community has created. I can further customise my pages with blocks that show different information. SHOT: Show a student self-enrolling into a course SHOT: Pan across screen with a variety of enrolment methods SHOT: Show a person being manually enrolled as a Guest I can decide how people will enrol in my course. They can sign up themselves; I can enrol them manually or have them automatically added to my course. I can decide what roles and permissions they will have in my course, allowing me to bring in a colleague just to look, if I want to. SHOT: Show Group enrolment screen with two groups already created and a 3rd being added I can also put them into groups, allowing them to work together, or separately if I want them to. SHOT: Click add menu, show add dialog, pan across the list. My course content consists of resources and activities, arranged in a sequence. SHOT: Pan across plain course page with activities and resources SHOT: Morph to same activities list but with conditions set on them all. I can choose to enforce that sequence or let students navigate as they wish, SHOT: Show a file being dragged in from desktop SHOT: Show instructions being typed into Atto editor Resources are the basic information I want my students to see. I can drag files in from my desktop, or create them in Moodle using a text editor. SHOT: Show filepicker, fully configured, pan down repository list. SHOT: Show a nice Wikipedia page embedded in a resource page. I can also access a wide range of internet repositories (eg Google Drive, Dropbox, or many others) or use a link to bring any web page into my course. SHOT: Dragging a SCORM zip into the course SHOT: Show a good SCORM activity in its player, with flash etc. Moodle also has full support for standard SCORM and IMS packages, meaning that I can bring in content packages from other places if I need to. SHOT: Pan down the Add activity dialog contents. Activities are Moodle s main strength - it has a huge range of activities that encourage students to learn by collaborating with each other or creating things in a number of ways. SHOT: Show close up of a useful forum thread with someone clicking to rate Forums allow learners to discuss issues and share resources. I can rate their posts or let them rate each other. SHOT: Show a student pdf being annotated SHOT: Show a rubric in use Assignments allow me to grade texts and files that the students send to me. I can grade them online, adding comments and feedback if I wish, perhaps using rubrics or a marking guide. SHOT: Show an interesting question being answered with feedback SHOT: Show/Scroll down selected responses and feedback in a quiz (including CBM score?) The quiz gives very powerful formative or summative assessment. I can give feedback every step of the way and even have grades altered according to how confident my learners are of their responses. SHOT: Show a wiki page being edited with a link being added. SHOT: Show click on the link to a new page SHOT: Show the history page With a wiki, I can have my learners building a document collaboratively with every edit recorded. Or I can let them have their own pages for personal use. SHOT: Show a good example of a glossary with lots of jargon being defined SHOT: Someone clicking on the approve link SHOT: A forum post with highlighted terms in it, and the a click on one to show the popup A glossary can contain key terms and definitions which everyone can contribute to. I can moderate the entries and allow comments. These words become hyperlinks throughout my course. SHOT: Show a good example of a database with pictures, geolocations etc A database lets your students create a bank of information in any format you can imagine. SHOT: Student making a choice (with a good example choice), with anonymous results being shown to the student. SHOT: Pan across detailed survey results showing each user If I want to take a quick poll I use the Choice activity, while learners responses in a Survey gives me valuable detailed feedback on how the course is going from their point of view. SHOT: Show couple of steps in a lesson with content pages containing video/images, eg health & safety scenario With the lesson module, I can develop personalised, self-paced pathways for students to explore. SHOT: Moving from one stage to another in workshop set up screen SHOT: Show student being prompted to review a submission, and then getting a form to fill in. SHOT: Pan down the results grid. The innovative workshop tool allows all my students to assess their peers in a structured way, helping with their learning but also providing grades that I can trust to be part of their final grades for my course. SHOT: Plugins directory And lots lots more. The Moodle community has created hundreds of different activities, all for free, that I can add to my Moodle if I want to. SHOT: The new Restrict access interface, adding some conditions. I generally let my students access these activities and resources any time they like, but if I want to I have powerful conditional activity controls so that they only see some things once they have completed other things in certain ways. SHOT: Panning across detailed gradebook, groups, categories etc, different reports Any grades that are generated by activities end up in the gradebook. Here I can always add or edit grades manually if needed. I can also organise my grades and do full calculations on them if I need to. If I have grades outside of Moodle, I can import them.. and I can export my Moodle grades out into a spreadsheet. Students can also track their own grades. SHOT: Pan across Logs/course participation/Activity completion SHOT: Badges screen showing awarded badges (need some good badges) At any time I can see detailed reports on their participation, activity and progress and I can reward them with badges or certificates (manually or automatically!) SHOT: Show same page on a desktop, on a tablet, and on a phone (including the devices being held in hands). Moodle s responsive design works great for me and my students on browsers on all my devices, SHOT: Show a Moodle Mobile notification of a message popping up on a tablet with an appropriate default ding noise. There is also a Moodle Mobile app with features for offline content and message notifications. SHOT: Quickly flashing through a lot of screenshots like frames in a movie reel SHOT: Recording some audio in the File picker interface as an upload There s more in Moodle than I need, but it s good to know that when I need it, it s already there. SHOT: A teacher smiling and doing something on a computer, mixed with SHOT: Moodle graphics and end stuff Moodle - open source software for collaborative learning, built for you so that you can build the ideal learning space for your students.
2.summary: Create a good demo course with realistic data
description: Barbara would help here too I guess. We could re-purpose learn.moodle.net theme maybe or other.
3.summary: Create the raw screen recordings for each feature
description:
4.summary: Edit final video from raw footage
description: This task includes all the editing as well as creation of titles, animations, sound design around everything. Feel free to create subtasks if you like.
5.summary: Record English voiceover and music
description:
6.summary: Create 3 demo badges for overview video
description: Please could we have 3 simple badges for the short video clip showing awarded badges in the overview video? I would like: "Subject knowledge" "Analysis" "Collaboration" They are for the School demo and so dont have to be like Moodle.org, but need to be consistent for one course (for young adults) Please dont spend more than a few minutes on them, because they will only be shown for a few seconds - it is just that if I make them, I would spend an hour and come up with terrible badges, whereas you could spend ten minutes and have three great-looking ones!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Create a Moodle overview video that cleanly shows anyone what Moodle actually does
description: We really need one clean, professionally-designed overview video that really explains how the Moodle software works. I imagine a slick quality entertaining video not more than 5 minutes long. If possible the video should not use English examples so it can be translated more easily with alternate soundtracks and text overlays.
### Response:
1.summary: Develop storyboard for Moodle software overview video
description: Final Storyboard (subject to modifications during production): (SHOTS run under the text that follows them.) SHOT: intro titles SHOT: animated or talking head or both Moodle is a course management system. Moodle runs on a web server, and by customising it you can make it into the perfect private place for your educators and students to collaborate. SHOT: Pan across categories structure showing typical school departments SHOT: Pan across a participant listing in a course, including use of the roles menu A Moodle site mostly consists of courses, which can be organised into categories and users, who can be given roles within the courses and categories, such as teacher, or student. SHOT: Show an admin changing categories SHOT: Show roles list, and an admin adding new role for Supervisor . A Moodle administrator can create and modify roles and categories to any structure they like, to adapt it for all kinds of educational situations. SHOT: Pan across some different course formats, including contrib plugins like Grid SHOT: Show some adding of blocks and moving them around at a sped-up speed As a teacher in my private Moodle course, I can choose the course format that suits my learners, organised by week, by topic, or all kinds of other layouts that the Moodle community has created. I can further customise my pages with blocks that show different information. SHOT: Show a student self-enrolling into a course SHOT: Pan across screen with a variety of enrolment methods SHOT: Show a person being manually enrolled as a Guest I can decide how people will enrol in my course. They can sign up themselves; I can enrol them manually or have them automatically added to my course. I can decide what roles and permissions they will have in my course, allowing me to bring in a colleague just to look, if I want to. SHOT: Show Group enrolment screen with two groups already created and a 3rd being added I can also put them into groups, allowing them to work together, or separately if I want them to. SHOT: Click add menu, show add dialog, pan across the list. My course content consists of resources and activities, arranged in a sequence. SHOT: Pan across plain course page with activities and resources SHOT: Morph to same activities list but with conditions set on them all. I can choose to enforce that sequence or let students navigate as they wish, SHOT: Show a file being dragged in from desktop SHOT: Show instructions being typed into Atto editor Resources are the basic information I want my students to see. I can drag files in from my desktop, or create them in Moodle using a text editor. SHOT: Show filepicker, fully configured, pan down repository list. SHOT: Show a nice Wikipedia page embedded in a resource page. I can also access a wide range of internet repositories (eg Google Drive, Dropbox, or many others) or use a link to bring any web page into my course. SHOT: Dragging a SCORM zip into the course SHOT: Show a good SCORM activity in its player, with flash etc. Moodle also has full support for standard SCORM and IMS packages, meaning that I can bring in content packages from other places if I need to. SHOT: Pan down the Add activity dialog contents. Activities are Moodle s main strength - it has a huge range of activities that encourage students to learn by collaborating with each other or creating things in a number of ways. SHOT: Show close up of a useful forum thread with someone clicking to rate Forums allow learners to discuss issues and share resources. I can rate their posts or let them rate each other. SHOT: Show a student pdf being annotated SHOT: Show a rubric in use Assignments allow me to grade texts and files that the students send to me. I can grade them online, adding comments and feedback if I wish, perhaps using rubrics or a marking guide. SHOT: Show an interesting question being answered with feedback SHOT: Show/Scroll down selected responses and feedback in a quiz (including CBM score?) The quiz gives very powerful formative or summative assessment. I can give feedback every step of the way and even have grades altered according to how confident my learners are of their responses. SHOT: Show a wiki page being edited with a link being added. SHOT: Show click on the link to a new page SHOT: Show the history page With a wiki, I can have my learners building a document collaboratively with every edit recorded. Or I can let them have their own pages for personal use. SHOT: Show a good example of a glossary with lots of jargon being defined SHOT: Someone clicking on the approve link SHOT: A forum post with highlighted terms in it, and the a click on one to show the popup A glossary can contain key terms and definitions which everyone can contribute to. I can moderate the entries and allow comments. These words become hyperlinks throughout my course. SHOT: Show a good example of a database with pictures, geolocations etc A database lets your students create a bank of information in any format you can imagine. SHOT: Student making a choice (with a good example choice), with anonymous results being shown to the student. SHOT: Pan across detailed survey results showing each user If I want to take a quick poll I use the Choice activity, while learners responses in a Survey gives me valuable detailed feedback on how the course is going from their point of view. SHOT: Show couple of steps in a lesson with content pages containing video/images, eg health & safety scenario With the lesson module, I can develop personalised, self-paced pathways for students to explore. SHOT: Moving from one stage to another in workshop set up screen SHOT: Show student being prompted to review a submission, and then getting a form to fill in. SHOT: Pan down the results grid. The innovative workshop tool allows all my students to assess their peers in a structured way, helping with their learning but also providing grades that I can trust to be part of their final grades for my course. SHOT: Plugins directory And lots lots more. The Moodle community has created hundreds of different activities, all for free, that I can add to my Moodle if I want to. SHOT: The new Restrict access interface, adding some conditions. I generally let my students access these activities and resources any time they like, but if I want to I have powerful conditional activity controls so that they only see some things once they have completed other things in certain ways. SHOT: Panning across detailed gradebook, groups, categories etc, different reports Any grades that are generated by activities end up in the gradebook. Here I can always add or edit grades manually if needed. I can also organise my grades and do full calculations on them if I need to. If I have grades outside of Moodle, I can import them.. and I can export my Moodle grades out into a spreadsheet. Students can also track their own grades. SHOT: Pan across Logs/course participation/Activity completion SHOT: Badges screen showing awarded badges (need some good badges) At any time I can see detailed reports on their participation, activity and progress and I can reward them with badges or certificates (manually or automatically!) SHOT: Show same page on a desktop, on a tablet, and on a phone (including the devices being held in hands). Moodle s responsive design works great for me and my students on browsers on all my devices, SHOT: Show a Moodle Mobile notification of a message popping up on a tablet with an appropriate default ding noise. There is also a Moodle Mobile app with features for offline content and message notifications. SHOT: Quickly flashing through a lot of screenshots like frames in a movie reel SHOT: Recording some audio in the File picker interface as an upload There s more in Moodle than I need, but it s good to know that when I need it, it s already there. SHOT: A teacher smiling and doing something on a computer, mixed with SHOT: Moodle graphics and end stuff Moodle - open source software for collaborative learning, built for you so that you can build the ideal learning space for your students.
2.summary: Create a good demo course with realistic data
description: Barbara would help here too I guess. We could re-purpose learn.moodle.net theme maybe or other.
3.summary: Create the raw screen recordings for each feature
description:
4.summary: Edit final video from raw footage
description: This task includes all the editing as well as creation of titles, animations, sound design around everything. Feel free to create subtasks if you like.
5.summary: Record English voiceover and music
description:
6.summary: Create 3 demo badges for overview video
description: Please could we have 3 simple badges for the short video clip showing awarded badges in the overview video? I would like: "Subject knowledge" "Analysis" "Collaboration" They are for the School demo and so dont have to be like Moodle.org, but need to be consistent for one course (for young adults) Please dont spend more than a few minutes on them, because they will only be shown for a few seconds - it is just that if I make them, I would spend an hour and come up with terrible badges, whereas you could spend ten minutes and have three great-looking ones!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: New Theme and Navigation changes for Moodle 3.2
description: This epic collects together the issues related to the new theme and navigation changes for Moodle 3.2. For more information see the specification: The prototype site for this theme is and the login is admin / test.
| Unsolvable | 1.summary: Add some info to the performance footer when theme designer mode is on
description: Ive almost started investigating performance issues a few times because ive been tripped up by being in theme designer mode and using the more theme and wondered why things are going so slow. (The reason which I am well aware of is because of the slow dynamic compiling of less). It would be good to add something obvious to the performance info footer to make it obvious that this is impacting the responsiveness of the page. Today when I experienced it I only twigged why it was happening because I saw the themedesignermode adhoc cache (and im really familiar this problem). To someone who doesnt know about this gotcha it would be less obvious. I am not sure if its possible to work out from the php page that less is being compiled on the fly, so perhaps theme designer mode is the best we can do (I still think thats useful because itll warn you that normal caching isnt taking place). But itd be great if we could indicate that a less compilation is happening too (it helps explain when slower than normal after a theme setting change)
2.summary: Set TEXT and TEXTAREA form fields directionality to LTR and alignment to left in special LTR form fields, when in RTL mode
description: Some form fields should always be left aligned and their directionality set to LTR. The following, is a list of INPUT fields of type TEXT and TEXTAREA that needs to be using directionality LTR and alignment LEFT when displayed in RTL UI. as the input data needs to be treated as LTR content. (URLs, OS level Folders & apps, theme hex colors, English DB field names, emails, English text, numbers, regular expression patterns, symbols) I was going throughout the entire admin menu and getting each setting page name and list of fields that are relevant for this fix. In general, I would suggest we add a new class to reflect situations when input text & textarea form fields needs not to be RTL aligned and directionality be set to RTL when in RTL mode. so we can put together a loooong CSS selector that left align them all, when in RTL mode. (Unless there is a better idea) We should remove all current RTL selectors that partially fix some of the form fields on the list (those that are marked as so) and add new special selectors at the end of all cascaded CSS files so it overrides whatever RTL selectors that might generally (and not explicitly) improperly right align the UI when it is not needed.
3.summary: New "Boost" Bootstrap 4 theme
description: Based on bootstrap4 with enhancements for accessibility, rtl support and tied into our grunt builder.
4.summary: Upgrades to Behat so it can work with different themes
description: Change behat infrastructure so steps can be overridden by themes. Should allow whole suite to pass on different themes even with different navigation etc.
5.summary: Block and Navigation changes for Boost.
description: Each element in the navbar should be a drop down menu allowing access to the sibling nodes from the nav tree.
6.summary: Add unique visual styling to new theme for 3.2
description: The new theme, based on bootstrap 4 will already look visually different to the previous moodle themes. We should review the styles and create a distinctive default look for the new theme that looks modern and fresh.
7.summary: Use a settings gear icon in top right for all pages with settings
description: We need to create a new renderable for a settings link that will take you to the settings for any page in moodle with settings. It should appear as a gear icon in the top right of the page.
8.summary: Add lots of settings to the new theme so it can be used for many sites without installing a child-theme
description: The new theme for 3.2 should be usable out of the box without installing additional themes. This is similar to the "more" theme for 3.1.
9.summary: Create a PHP post processing tool to flip CSS for RTL
description: One of the requirements for the new theme is to allow customisation from the admin, so we will have to post-process the CSS from PHP, that to leverage the flexibility of SCSS variables. After generating the CSS a few things will happen, a new one will be to generate (on-demand) the RTL version. This will mimix existing solutions such as rtlcss and css-flip. This issue is about porting one of the existing tools, agnostic of Moodle codebase, to PHP. Bootstrap have talked about supporting RTL for years but they arent there yet. Theyve also mentioned that they will not have any RTL support for v4.0 but that it may come in a minor release. It goes without saying that we need to support RTL. This will also have to flip _.dir-rtl_ to _.dir-ltr_ and vice-versa, except when flagged to be _ignored_.
10.summary: Include scssphp in Moodle core
description: That is required to compile SCSS from PHP.
11.summary: Allow themes to compile SCSS to CSS on demand
description: Just like we did for LESS, themes should be able to compile SCSS on demand.
12.summary: Create a settings page to customise the new theme
description: That includes an advanced option to dump pure SCSS.
13.summary: Update theme/upgrade.txt to reflect all recent changes
description: ^
14.summary: Add scaffolding for new theme basic layout files, version.php etc
description: This is just the starting point so we can start adding things.
15.summary: Convert bootstrapbase less to sass and import bootstrap4 sass
description: Convert bootstrapbase less to sass and import bootstrap4 sass
16.summary: Add bootstrap4 js files to new theme
description: Convert to AMD etc.
17.summary: Apply Bootstrap 4 styles to blocks and remove dock
description: Apply Bootstrap 4 styles to blocks and remove dock
18.summary: Use bootstrap styles for modals
description: Use bootstrap styles for modals
19.summary: Apply default bootstrap4 button styles
description: Apply default bootstrap4 button styles
20.summary: Use bootstrap 4 custom menus
description: Use bootstrap 4 custom menus
21.summary: Style the filepicker for bootstrap 4
description: Style the filepicker for bootstrap 4
22.summary: Use bootstrap 4 styles for tabs
description: Use bootstrap 4 styles for tabs (use templates)
23.summary: Convert action menus to templates / bootstrap 4
description: Convert action menus to templates / bootstrap 4
24.summary: Convert preferences page to templates
description: And add bootstrap 4 styles.
25.summary: Update new theme to bootstrap 4 alpha 3
description: This is more about making sure we can compile the new version with our tools.
26.summary: Update mforms to use bootstrap 4 DOM structures and classes
description: This needs templates etc.
27.summary: Add ability to add small and large logos into core
description: The logo and other branding assets should not be added to specific themes, they should be added in core so that themes can use them at will.
28.summary: Create theme presets for an admin to pick from
description: We will add a few presets in the new theme, those will globally change the look of the site. Example of possible presents: - Default - Dark - Green - Compact Keeping in mind that this will be used by users in conjunction with another setting "branding colour", which would be set to "orange" for Moodle sites for instance.
29.summary: Use template for help icons
description: ^ as summary says.
30.summary: Use template for single select
description: ^
31.summary: Fix conflict between bootstrap2 JS and bootstrap4 js
description: Fix conflict between bootstrap2 JS and bootstrap4 js
32.summary: Use a template for the admin settings search form
description: ^
33.summary: Convert forum search block to use templates
description: ^
34.summary: Make single_button use templates
description: ^
35.summary: Make url_select use templates
description: ^
36.summary: Convert paging bar to use templates
description: ^
37.summary: Convert forum quick search form to renderers
description: ^
38.summary: Fix the styling of the assignment grading interface
description: ^
39.summary: Add a renderer / templates for the login page.
description: Add a renderer / templates for the login page.
40.summary: Convert admin settings to templates
description: ^
41.summary: Adjustments in Course > Grades for the new theme
description: ^
42.summary: Customise the default preset for the new theme
description: The default preset should contain variables that make the new theme look good out of the box. Requirements for the default preset are: Neutral, Not boring, Modern The branch to work from is -master The file to modify is theme/noname/scss/preset-default.scss Some restrictions on modifying the default preset: Limit the customisation to changing the sass variables used for bootstrap 4 (see _variables.scss in the bootstrap folder). Avoid additional CSS rules - if there are additional tweaks required - make a new issue in the Epic and we will try and make the changes by modifying a template instead.
43.summary: Convert forum "big" search form to template
description: ^
44.summary: Clean up the iconsmall / smallicon / action-icon / icon classes in the new theme.
description: We have too many variations of icons. Try and come up with a single class that will work in all the cases icons are used. Some things to consider: icons in an anchor should not be underlined icons can be used before / after text icons can be used before / after more icons icons can be floated right all icons should be the same size (avoid small icons being scaled up etc)
45.summary: All passwords are acting as passwordunmask
description: Both password, and passwordunmask share the theme/noname/templates/core_form/element-password.mustache template. The JS in that template converts a standard password element to a passwordunmask field and currently does so unconditionally. Either this should be conditional, or should be moved to a separate template. Note: seeks to rewrite passwordunmask so you may wish to just remove the existing content, or defer til that issue.
46.summary: url_select handles nothingvalue incorrectly.
description: See enrol method page. The url_select is using similar code to single_select but is wrong. Its trying to compare the array key to a string, rather than the value.
47.summary: Breadcrumbs without URLs have non-functional links
description: View a page with breadcrumbs Observe that the breadcrumbs which dont have a URL value still have links pointing to the wwwroot
48.summary: Missing template in mod/forum/templates/quick_search_form.mustache
description: Just to let you know that this is causing fatals on the clean theme: Template is in mod/forum/templates/quick_search_form.mustache It includes a call to: code + helpicon + >core/help_icon + /helpicon code help_icon is only available in the noname theme.
49.summary: Profile page breaks cards in-between columns in new theme
description: Multi column layout is broken on this page.
50.summary: Behat custom selectors and template changes
description: Make behat work with the new theme (big issue...)
51.summary: Rename new theme to "Boost"
description: Suitable use of mv + grep required to rename the theme before integration.
52.summary: Update to bootstrap 4 alpha 4
description:
53.summary: Add common bootstrap 4 classes to bootstrapbase
description: The rational is to make it easy to write simple HTML in plugins / core etc that targets bootstrap 4 and have it fallback gracefully in bootstrap 2 themes. There is a subset of common things that would be simple to backport (hopefully). I suggest: card, col-, p-, m-, d-, tag
54.summary: Make "Boost" the default theme for new installs of Moodle
description: I havent done this right away because we need to confirm with Rajesh how this will impact testing in CI. We will need to end up with CI testing both themes.
55.summary: Update the default screenshot of the new theme "Boost"
description: The default screen shot is currently the one from bootstrapbase, it needs updating to look like the new theme.
56.summary: Add a "plain" preset that is just "bootstrap" with no extra styles.
description: This is useful for theme designers wanting to customize without having to undo extra overrides from the presets. Rationale (courtesy of Damyon): quote My reason for this preset is that the "default" preset is bootstrap + a bunch of styles and other changes that we think look good, but probably some people dont like. If they are used to styling things for bootstrap, and they use the "default" preset + the scss settings on the advanced tab - the first thing they need to do is start "undoing" our extra changes from our default preset. quote
57.summary: Add support for docking blocks in theme "boost"
description: This theme was created without support for docking blocks, because we intended to do something else entirely with blocks. We should add this functionality before release or it will be a regression from "clean".
58.summary: Add support for drag and drop blocks in boost
description: This was not initially done because we are experimenting with blocks in this theme.
59.summary: Review and edit of upgrade.txts following theme branch integration
description: Following the integration of the final theme branch, some upgrade.txt notes have become outdated over time. Also some inline phpdocs. This issue is to rationalise it. e.g. the removed classes: code git grep admin_setting_localised admin/upgrade.txt: Use the php class admin_setting_localisedtext for text inputs; admin/upgrade.txt: Use the php class admin_setting_localisedtextarea for larger text inputs. lib/adminlib.php: provided with admin_setting_localisedtext. lib/adminlib.php: provided with the class admin_setting_localisedtext. lib/adminlib.php: please refer to admin_setting_localisedtext. code
60.summary: Typo in the theme_boost readme
description: In theme/boost/lang/en/theme_boost.php, string choosereadme, I assume the bq. This theme is intended to used directly ... is supposed to be bq. This theme is intended to be used directly ...
61.summary: Boost: theme preview image overflows at the theme selector page
description: See the attached screenshot.
62.summary: Boost: Filepicker styling broken
description: See attachment.
63.summary: theme_boost: enrol users modals garishly out of style
description: This is existing, but IMO should try and fix to go with boost. Reported by David and Raj. !Screen Shot 2016-09-29 at 11.37.48.png|thumbnail! !Screen Shot 2016-09-29 at 11.38.06.png|thumbnail! !Screen Shot 2016-09-29 at 11.39.44.png|thumbnail!
64.summary: Remove the "Turn editing on" buttons from the course page.
description: Put them back into the nav tree (sorry I removed them in because I understood Martin wrongly).
65.summary: Add settings for all of the "brand" bootstrap colors to the settings page for boost
description: Several people have asked for more color settings for boost - so they can customise the colors without the complication of using SASS. E.g.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: New Theme and Navigation changes for Moodle 3.2
description: This epic collects together the issues related to the new theme and navigation changes for Moodle 3.2. For more information see the specification: The prototype site for this theme is and the login is admin / test.
### Response:
1.summary: Add some info to the performance footer when theme designer mode is on
description: Ive almost started investigating performance issues a few times because ive been tripped up by being in theme designer mode and using the more theme and wondered why things are going so slow. (The reason which I am well aware of is because of the slow dynamic compiling of less). It would be good to add something obvious to the performance info footer to make it obvious that this is impacting the responsiveness of the page. Today when I experienced it I only twigged why it was happening because I saw the themedesignermode adhoc cache (and im really familiar this problem). To someone who doesnt know about this gotcha it would be less obvious. I am not sure if its possible to work out from the php page that less is being compiled on the fly, so perhaps theme designer mode is the best we can do (I still think thats useful because itll warn you that normal caching isnt taking place). But itd be great if we could indicate that a less compilation is happening too (it helps explain when slower than normal after a theme setting change)
2.summary: Set TEXT and TEXTAREA form fields directionality to LTR and alignment to left in special LTR form fields, when in RTL mode
description: Some form fields should always be left aligned and their directionality set to LTR. The following, is a list of INPUT fields of type TEXT and TEXTAREA that needs to be using directionality LTR and alignment LEFT when displayed in RTL UI. as the input data needs to be treated as LTR content. (URLs, OS level Folders & apps, theme hex colors, English DB field names, emails, English text, numbers, regular expression patterns, symbols) I was going throughout the entire admin menu and getting each setting page name and list of fields that are relevant for this fix. In general, I would suggest we add a new class to reflect situations when input text & textarea form fields needs not to be RTL aligned and directionality be set to RTL when in RTL mode. so we can put together a loooong CSS selector that left align them all, when in RTL mode. (Unless there is a better idea) We should remove all current RTL selectors that partially fix some of the form fields on the list (those that are marked as so) and add new special selectors at the end of all cascaded CSS files so it overrides whatever RTL selectors that might generally (and not explicitly) improperly right align the UI when it is not needed.
3.summary: New "Boost" Bootstrap 4 theme
description: Based on bootstrap4 with enhancements for accessibility, rtl support and tied into our grunt builder.
4.summary: Upgrades to Behat so it can work with different themes
description: Change behat infrastructure so steps can be overridden by themes. Should allow whole suite to pass on different themes even with different navigation etc.
5.summary: Block and Navigation changes for Boost.
description: Each element in the navbar should be a drop down menu allowing access to the sibling nodes from the nav tree.
6.summary: Add unique visual styling to new theme for 3.2
description: The new theme, based on bootstrap 4 will already look visually different to the previous moodle themes. We should review the styles and create a distinctive default look for the new theme that looks modern and fresh.
7.summary: Use a settings gear icon in top right for all pages with settings
description: We need to create a new renderable for a settings link that will take you to the settings for any page in moodle with settings. It should appear as a gear icon in the top right of the page.
8.summary: Add lots of settings to the new theme so it can be used for many sites without installing a child-theme
description: The new theme for 3.2 should be usable out of the box without installing additional themes. This is similar to the "more" theme for 3.1.
9.summary: Create a PHP post processing tool to flip CSS for RTL
description: One of the requirements for the new theme is to allow customisation from the admin, so we will have to post-process the CSS from PHP, that to leverage the flexibility of SCSS variables. After generating the CSS a few things will happen, a new one will be to generate (on-demand) the RTL version. This will mimix existing solutions such as rtlcss and css-flip. This issue is about porting one of the existing tools, agnostic of Moodle codebase, to PHP. Bootstrap have talked about supporting RTL for years but they arent there yet. Theyve also mentioned that they will not have any RTL support for v4.0 but that it may come in a minor release. It goes without saying that we need to support RTL. This will also have to flip _.dir-rtl_ to _.dir-ltr_ and vice-versa, except when flagged to be _ignored_.
10.summary: Include scssphp in Moodle core
description: That is required to compile SCSS from PHP.
11.summary: Allow themes to compile SCSS to CSS on demand
description: Just like we did for LESS, themes should be able to compile SCSS on demand.
12.summary: Create a settings page to customise the new theme
description: That includes an advanced option to dump pure SCSS.
13.summary: Update theme/upgrade.txt to reflect all recent changes
description: ^
14.summary: Add scaffolding for new theme basic layout files, version.php etc
description: This is just the starting point so we can start adding things.
15.summary: Convert bootstrapbase less to sass and import bootstrap4 sass
description: Convert bootstrapbase less to sass and import bootstrap4 sass
16.summary: Add bootstrap4 js files to new theme
description: Convert to AMD etc.
17.summary: Apply Bootstrap 4 styles to blocks and remove dock
description: Apply Bootstrap 4 styles to blocks and remove dock
18.summary: Use bootstrap styles for modals
description: Use bootstrap styles for modals
19.summary: Apply default bootstrap4 button styles
description: Apply default bootstrap4 button styles
20.summary: Use bootstrap 4 custom menus
description: Use bootstrap 4 custom menus
21.summary: Style the filepicker for bootstrap 4
description: Style the filepicker for bootstrap 4
22.summary: Use bootstrap 4 styles for tabs
description: Use bootstrap 4 styles for tabs (use templates)
23.summary: Convert action menus to templates / bootstrap 4
description: Convert action menus to templates / bootstrap 4
24.summary: Convert preferences page to templates
description: And add bootstrap 4 styles.
25.summary: Update new theme to bootstrap 4 alpha 3
description: This is more about making sure we can compile the new version with our tools.
26.summary: Update mforms to use bootstrap 4 DOM structures and classes
description: This needs templates etc.
27.summary: Add ability to add small and large logos into core
description: The logo and other branding assets should not be added to specific themes, they should be added in core so that themes can use them at will.
28.summary: Create theme presets for an admin to pick from
description: We will add a few presets in the new theme, those will globally change the look of the site. Example of possible presents: - Default - Dark - Green - Compact Keeping in mind that this will be used by users in conjunction with another setting "branding colour", which would be set to "orange" for Moodle sites for instance.
29.summary: Use template for help icons
description: ^ as summary says.
30.summary: Use template for single select
description: ^
31.summary: Fix conflict between bootstrap2 JS and bootstrap4 js
description: Fix conflict between bootstrap2 JS and bootstrap4 js
32.summary: Use a template for the admin settings search form
description: ^
33.summary: Convert forum search block to use templates
description: ^
34.summary: Make single_button use templates
description: ^
35.summary: Make url_select use templates
description: ^
36.summary: Convert paging bar to use templates
description: ^
37.summary: Convert forum quick search form to renderers
description: ^
38.summary: Fix the styling of the assignment grading interface
description: ^
39.summary: Add a renderer / templates for the login page.
description: Add a renderer / templates for the login page.
40.summary: Convert admin settings to templates
description: ^
41.summary: Adjustments in Course > Grades for the new theme
description: ^
42.summary: Customise the default preset for the new theme
description: The default preset should contain variables that make the new theme look good out of the box. Requirements for the default preset are: Neutral, Not boring, Modern The branch to work from is -master The file to modify is theme/noname/scss/preset-default.scss Some restrictions on modifying the default preset: Limit the customisation to changing the sass variables used for bootstrap 4 (see _variables.scss in the bootstrap folder). Avoid additional CSS rules - if there are additional tweaks required - make a new issue in the Epic and we will try and make the changes by modifying a template instead.
43.summary: Convert forum "big" search form to template
description: ^
44.summary: Clean up the iconsmall / smallicon / action-icon / icon classes in the new theme.
description: We have too many variations of icons. Try and come up with a single class that will work in all the cases icons are used. Some things to consider: icons in an anchor should not be underlined icons can be used before / after text icons can be used before / after more icons icons can be floated right all icons should be the same size (avoid small icons being scaled up etc)
45.summary: All passwords are acting as passwordunmask
description: Both password, and passwordunmask share the theme/noname/templates/core_form/element-password.mustache template. The JS in that template converts a standard password element to a passwordunmask field and currently does so unconditionally. Either this should be conditional, or should be moved to a separate template. Note: seeks to rewrite passwordunmask so you may wish to just remove the existing content, or defer til that issue.
46.summary: url_select handles nothingvalue incorrectly.
description: See enrol method page. The url_select is using similar code to single_select but is wrong. Its trying to compare the array key to a string, rather than the value.
47.summary: Breadcrumbs without URLs have non-functional links
description: View a page with breadcrumbs Observe that the breadcrumbs which dont have a URL value still have links pointing to the wwwroot
48.summary: Missing template in mod/forum/templates/quick_search_form.mustache
description: Just to let you know that this is causing fatals on the clean theme: Template is in mod/forum/templates/quick_search_form.mustache It includes a call to: code + helpicon + >core/help_icon + /helpicon code help_icon is only available in the noname theme.
49.summary: Profile page breaks cards in-between columns in new theme
description: Multi column layout is broken on this page.
50.summary: Behat custom selectors and template changes
description: Make behat work with the new theme (big issue...)
51.summary: Rename new theme to "Boost"
description: Suitable use of mv + grep required to rename the theme before integration.
52.summary: Update to bootstrap 4 alpha 4
description:
53.summary: Add common bootstrap 4 classes to bootstrapbase
description: The rational is to make it easy to write simple HTML in plugins / core etc that targets bootstrap 4 and have it fallback gracefully in bootstrap 2 themes. There is a subset of common things that would be simple to backport (hopefully). I suggest: card, col-, p-, m-, d-, tag
54.summary: Make "Boost" the default theme for new installs of Moodle
description: I havent done this right away because we need to confirm with Rajesh how this will impact testing in CI. We will need to end up with CI testing both themes.
55.summary: Update the default screenshot of the new theme "Boost"
description: The default screen shot is currently the one from bootstrapbase, it needs updating to look like the new theme.
56.summary: Add a "plain" preset that is just "bootstrap" with no extra styles.
description: This is useful for theme designers wanting to customize without having to undo extra overrides from the presets. Rationale (courtesy of Damyon): quote My reason for this preset is that the "default" preset is bootstrap + a bunch of styles and other changes that we think look good, but probably some people dont like. If they are used to styling things for bootstrap, and they use the "default" preset + the scss settings on the advanced tab - the first thing they need to do is start "undoing" our extra changes from our default preset. quote
57.summary: Add support for docking blocks in theme "boost"
description: This theme was created without support for docking blocks, because we intended to do something else entirely with blocks. We should add this functionality before release or it will be a regression from "clean".
58.summary: Add support for drag and drop blocks in boost
description: This was not initially done because we are experimenting with blocks in this theme.
59.summary: Review and edit of upgrade.txts following theme branch integration
description: Following the integration of the final theme branch, some upgrade.txt notes have become outdated over time. Also some inline phpdocs. This issue is to rationalise it. e.g. the removed classes: code git grep admin_setting_localised admin/upgrade.txt: Use the php class admin_setting_localisedtext for text inputs; admin/upgrade.txt: Use the php class admin_setting_localisedtextarea for larger text inputs. lib/adminlib.php: provided with admin_setting_localisedtext. lib/adminlib.php: provided with the class admin_setting_localisedtext. lib/adminlib.php: please refer to admin_setting_localisedtext. code
60.summary: Typo in the theme_boost readme
description: In theme/boost/lang/en/theme_boost.php, string choosereadme, I assume the bq. This theme is intended to used directly ... is supposed to be bq. This theme is intended to be used directly ...
61.summary: Boost: theme preview image overflows at the theme selector page
description: See the attached screenshot.
62.summary: Boost: Filepicker styling broken
description: See attachment.
63.summary: theme_boost: enrol users modals garishly out of style
description: This is existing, but IMO should try and fix to go with boost. Reported by David and Raj. !Screen Shot 2016-09-29 at 11.37.48.png|thumbnail! !Screen Shot 2016-09-29 at 11.38.06.png|thumbnail! !Screen Shot 2016-09-29 at 11.39.44.png|thumbnail!
64.summary: Remove the "Turn editing on" buttons from the course page.
description: Put them back into the nav tree (sorry I removed them in because I understood Martin wrongly).
65.summary: Add settings for all of the "brand" bootstrap colors to the settings page for boost
description: Several people have asked for more color settings for boost - so they can customise the colors without the complication of using SASS. E.g.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Collection of issues to be fixed from the findings of the accessibility audit
description: This epic contains the list of accessibility issues raised during the Moodle accessibility audit.
| Unsolvable | 1.summary: Improve UI accessibility on small viewports
description: From the audit results: . Issue Some user interfaces are not usable when text is zoomed to 200 or the UI is zoomed to 400 . Impact on users Screen reader users can call up a list of headings. Empty headings can cause confusion. . Guidelines affected Resize Text: 1.4.4 Except for captions and images of text, text can be resized without assistive technology up to 200 percent without loss of content or functionality. Reflow: 1.4.10 Content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions for: Vertical scrolling content at a width equivalent to 320 CSS pixels; Horizontal scrolling content at a height equivalent to 256 CSS pixels. Except for parts of the content which require two-dimensional layout for usage or meaning. . Recommendation When zooming in to 400 reduce the font sizes by 50. Reduce paddings and borders theme layouts
2.summary: Create an accessibleChange event
description: This was initially included as part of the fix for but it has been decided to move it to a separate issue, and for master only . Issues . A At the bottom of the table there is a dropdown menu. If you press the down arrow, it will automatically open a dialogue window for "Send message to 1 person". . Affected guidelines . A On Input: 3.2.2 Changing the setting of any user interface component does not automatically cause a change of context unless the user has been advised of the behaviour before using the component
3.summary: Limit the image description length and improve the alt text string
description: The Atto image plugin needs the textbox for submitting alt text description to be changed to a textarea with a maximum of 125 characters. Should have a character count visible whilst typing. The checkbox for ignoring alt text or not, Description not necessary should be This image is decorative only . This is to help meet accessibility rules. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
4.summary: Change the bold plugin to use instead of for accessibility
description: Accessibility rules require that bold text use the tag. Currently the bold atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
5.summary: Change the italics plugin to use instead of for accessibility
description: Accessibility rules require that italics text use the tag. Currently the italics atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
6.summary: Change the strikethrough plugin to use instead of for accessibility
description: Accessibility rules require that strikethrough text use the tag. Currently the strikethrough atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Collection of issues to be fixed from the findings of the accessibility audit
description: This epic contains the list of accessibility issues raised during the Moodle accessibility audit.
### Response:
1.summary: Improve UI accessibility on small viewports
description: From the audit results: . Issue Some user interfaces are not usable when text is zoomed to 200 or the UI is zoomed to 400 . Impact on users Screen reader users can call up a list of headings. Empty headings can cause confusion. . Guidelines affected Resize Text: 1.4.4 Except for captions and images of text, text can be resized without assistive technology up to 200 percent without loss of content or functionality. Reflow: 1.4.10 Content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions for: Vertical scrolling content at a width equivalent to 320 CSS pixels; Horizontal scrolling content at a height equivalent to 256 CSS pixels. Except for parts of the content which require two-dimensional layout for usage or meaning. . Recommendation When zooming in to 400 reduce the font sizes by 50. Reduce paddings and borders theme layouts
2.summary: Create an accessibleChange event
description: This was initially included as part of the fix for but it has been decided to move it to a separate issue, and for master only . Issues . A At the bottom of the table there is a dropdown menu. If you press the down arrow, it will automatically open a dialogue window for "Send message to 1 person". . Affected guidelines . A On Input: 3.2.2 Changing the setting of any user interface component does not automatically cause a change of context unless the user has been advised of the behaviour before using the component
3.summary: Limit the image description length and improve the alt text string
description: The Atto image plugin needs the textbox for submitting alt text description to be changed to a textarea with a maximum of 125 characters. Should have a character count visible whilst typing. The checkbox for ignoring alt text or not, Description not necessary should be This image is decorative only . This is to help meet accessibility rules. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
4.summary: Change the bold plugin to use instead of for accessibility
description: Accessibility rules require that bold text use the tag. Currently the bold atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
5.summary: Change the italics plugin to use instead of for accessibility
description: Accessibility rules require that italics text use the tag. Currently the italics atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
6.summary: Change the strikethrough plugin to use instead of for accessibility
description: Accessibility rules require that strikethrough text use the tag. Currently the strikethrough atto plugin uses the tag if the browser forces it. Change the plugin to ensure only the tag is used. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.10 upgrade
description: Moodle 3.10 is scheduled for release on Monday 9 November 2020.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.10
description:
2.summary: Upgrade learn.moodle.org to 3.10
description:
3.summary: Upgrade school.moodledemo.net to 3.10
description:
4.summary: Upgrade sandbox.moodledemo.net to 3.10
description:
5.summary: Upgrade archive.moodle.net to 3.10
description:
6.summary: Upgrade stats.moodle.org to 3.10
description:
7.summary: Upgrade lang.moodle.org to 3.10
description:
8.summary: Upgrade download.moodle.org to 3.5.15
description:
9.summary: Upgrade moodleassociation.org to 3.10
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.10 upgrade
description: Moodle 3.10 is scheduled for release on Monday 9 November 2020.
### Response:
1.summary: Upgrade moodle.org to 3.10
description:
2.summary: Upgrade learn.moodle.org to 3.10
description:
3.summary: Upgrade school.moodledemo.net to 3.10
description:
4.summary: Upgrade sandbox.moodledemo.net to 3.10
description:
5.summary: Upgrade archive.moodle.net to 3.10
description:
6.summary: Upgrade stats.moodle.org to 3.10
description:
7.summary: Upgrade lang.moodle.org to 3.10
description:
8.summary: Upgrade download.moodle.org to 3.5.15
description:
9.summary: Upgrade moodleassociation.org to 3.10
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Review third party libraries for new versions (3.9)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
| Unsolvable | 1.summary: Upgrade VideoJS to 7.7.6, 2.6.1, 2.2.1 and 5.4.2
description: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.6.5 --> 7.7.6: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.6.5 --> 7.7.6: VideoJS support files (/media/player/videojs/videojs/) 7.6.5 --> 7.7.6: The Flash tech for video.js (/media/player/videojs/amd/src/videojs-flash-lazy.js) 2.2.0 --> 2.2.1: Custom Flash Player for VideoJS (/media/player/videojs/video-js.swf) 5.4.1 --> 5.4.2:
2.summary: Upgrade ReCaptcha v2 to use v3 API
description: ReCaptcha v3 is now out, we should look at upgrading now, rather than before v2 ceases to work.
3.summary: Upgrade ADODB to 5.20.15
description: AdoDB (/lib/adodb/) 5.20.14 --> 5.20.15:
4.summary: Upgrade HTML Purifier to 4.12.0
description: HTML Purifier (/lib/htmlpurifier/) 4.10.0 --> 4.12.0:
5.summary: Upgrade PHPMailer to 6.1.3
description: PHPMailer (/lib/phpmailer/) 6.0.7 --> 6.1.3:
6.summary: Upgrade SimplePie to 1.5.3
description: SimplePie (/lib/simplepie/) 1.5.2 --> 1.5.3:
7.summary: Upgrade TCPDF to 6.3.2
description: TCPDF (/lib/tcpdf/) 6.2.26 --> 6.3.2:
8.summary: Upgrade loglevel.js to 1.6.6
description: loglevel.js (/lib/amd/src/loglevel.js) 1.6.2 --> 1.6.6:
9.summary: Upgrade mustache.js to latest version
description: Mustache.js (/lib/amd/src/mustache.js) 3.0.1 --> 3.1.0:
10.summary: Upgrade SCSSPHP to 1.0.6
description: scssphp (/lib/scssphp) 1.0.2 --> 1.0.6:
11.summary: Upgrade GeoIP2 and MaxMind DB reader to 2.10.0 and 1.5.1
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.9.0 --> 2.10.0: MaxMind DB Reader API (/lib/maxmind/MaxMind/) 1.4.1 --> 1.5.1:
12.summary: Upgrade WebRTC to 7.3.0
description: WebRTC adapter (/lib/amd/src/adapter.js) 6.4.0 --> 7.3.0:
13.summary: Upgrade phpCAS to 1.3.8
description: CAS (/auth/cas/CAS/) 1.3.7 --> 1.3.8:
14.summary: Upgrade jQuery EU Cookie Law popups to latest version
description: jQuery EU Cookie Law popups (/admin/tool/policy/amd/src/jquery-eu-cookie-law-popup.js) 1.1.2 --> 1.1.3:
15.summary: Upgrade MongoDB PHP Library to 1.5.1
description: MongoDB PHP Library (/cache/stores/mongodb/MongoDB/) 1.4.2 --> 1.5.1: Note: This upgrade, upgrades the mongodb extension requirement to 1.6.0
16.summary: Upgrade boost to use Bootstrap v4.5.0
description: Twitter Bootstrap (/theme/boost/scss/bootstrap/) 4.3.1 --> 4.4.0:
17.summary: Upgrade PHPSpreadsheet to 1.10.1
description: PhpSpreadsheet (/lib/phpspreadsheet/) 1.07.0 --> -1.10.0- 1.10.1:
18.summary: Upgrade babel-polyfill to latest version
description: babel-polyfill (/lib/babel-polyfill) 6.26.0 --> 7.7.0:
19.summary: Upgrade tether.js to latest version
description: tether (/theme/boost/amd/src/tether.js) 1.3.3 --> 1.4.7:
20.summary: Upgrade emoji-data to the latest version
description: Were currently using version 4.1.0 which was released in July 2018. Theres no new release yet as of this issues writing, but might be worth checking for new releases| from time to time when working on our library upgrades epic.
21.summary: Upgrade CodeMirror to 5.49.2
description: codemirror /lib/editor/atto/plugins/html/yui/src/codemirror/ 5.37.0 5.49.2 Yes
22.summary: Upgrade Mustache.php to 2.13.0
description: Mustache (/lib/mustache/) 2.12.0 --> 2.13.0:
23.summary: Upgrade ADODB to a more later version (v5.20.16)
description: We just upgraded to ADOBDB v5.20.15, but v5.20.16 has just been released early this year. -The latest version also fixes the ADODBs PostgreSQL12 compatibility| Just realised that the fix for PostgreSQL 12 compatibility has already been fixed in v5.20.15. :P
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Review third party libraries for new versions (3.9)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
### Response:
1.summary: Upgrade VideoJS to 7.7.6, 2.6.1, 2.2.1 and 5.4.2
description: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.6.5 --> 7.7.6: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.6.5 --> 7.7.6: VideoJS support files (/media/player/videojs/videojs/) 7.6.5 --> 7.7.6: The Flash tech for video.js (/media/player/videojs/amd/src/videojs-flash-lazy.js) 2.2.0 --> 2.2.1: Custom Flash Player for VideoJS (/media/player/videojs/video-js.swf) 5.4.1 --> 5.4.2:
2.summary: Upgrade ReCaptcha v2 to use v3 API
description: ReCaptcha v3 is now out, we should look at upgrading now, rather than before v2 ceases to work.
3.summary: Upgrade ADODB to 5.20.15
description: AdoDB (/lib/adodb/) 5.20.14 --> 5.20.15:
4.summary: Upgrade HTML Purifier to 4.12.0
description: HTML Purifier (/lib/htmlpurifier/) 4.10.0 --> 4.12.0:
5.summary: Upgrade PHPMailer to 6.1.3
description: PHPMailer (/lib/phpmailer/) 6.0.7 --> 6.1.3:
6.summary: Upgrade SimplePie to 1.5.3
description: SimplePie (/lib/simplepie/) 1.5.2 --> 1.5.3:
7.summary: Upgrade TCPDF to 6.3.2
description: TCPDF (/lib/tcpdf/) 6.2.26 --> 6.3.2:
8.summary: Upgrade loglevel.js to 1.6.6
description: loglevel.js (/lib/amd/src/loglevel.js) 1.6.2 --> 1.6.6:
9.summary: Upgrade mustache.js to latest version
description: Mustache.js (/lib/amd/src/mustache.js) 3.0.1 --> 3.1.0:
10.summary: Upgrade SCSSPHP to 1.0.6
description: scssphp (/lib/scssphp) 1.0.2 --> 1.0.6:
11.summary: Upgrade GeoIP2 and MaxMind DB reader to 2.10.0 and 1.5.1
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.9.0 --> 2.10.0: MaxMind DB Reader API (/lib/maxmind/MaxMind/) 1.4.1 --> 1.5.1:
12.summary: Upgrade WebRTC to 7.3.0
description: WebRTC adapter (/lib/amd/src/adapter.js) 6.4.0 --> 7.3.0:
13.summary: Upgrade phpCAS to 1.3.8
description: CAS (/auth/cas/CAS/) 1.3.7 --> 1.3.8:
14.summary: Upgrade jQuery EU Cookie Law popups to latest version
description: jQuery EU Cookie Law popups (/admin/tool/policy/amd/src/jquery-eu-cookie-law-popup.js) 1.1.2 --> 1.1.3:
15.summary: Upgrade MongoDB PHP Library to 1.5.1
description: MongoDB PHP Library (/cache/stores/mongodb/MongoDB/) 1.4.2 --> 1.5.1: Note: This upgrade, upgrades the mongodb extension requirement to 1.6.0
16.summary: Upgrade boost to use Bootstrap v4.5.0
description: Twitter Bootstrap (/theme/boost/scss/bootstrap/) 4.3.1 --> 4.4.0:
17.summary: Upgrade PHPSpreadsheet to 1.10.1
description: PhpSpreadsheet (/lib/phpspreadsheet/) 1.07.0 --> -1.10.0- 1.10.1:
18.summary: Upgrade babel-polyfill to latest version
description: babel-polyfill (/lib/babel-polyfill) 6.26.0 --> 7.7.0:
19.summary: Upgrade tether.js to latest version
description: tether (/theme/boost/amd/src/tether.js) 1.3.3 --> 1.4.7:
20.summary: Upgrade emoji-data to the latest version
description: Were currently using version 4.1.0 which was released in July 2018. Theres no new release yet as of this issues writing, but might be worth checking for new releases| from time to time when working on our library upgrades epic.
21.summary: Upgrade CodeMirror to 5.49.2
description: codemirror /lib/editor/atto/plugins/html/yui/src/codemirror/ 5.37.0 5.49.2 Yes
22.summary: Upgrade Mustache.php to 2.13.0
description: Mustache (/lib/mustache/) 2.12.0 --> 2.13.0:
23.summary: Upgrade ADODB to a more later version (v5.20.16)
description: We just upgraded to ADOBDB v5.20.15, but v5.20.16 has just been released early this year. -The latest version also fixes the ADODBs PostgreSQL12 compatibility| Just realised that the fix for PostgreSQL 12 compatibility has already been fixed in v5.20.15. :P
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle.net/OER set-up
description: We need an attractive and inviting page, with URL say (to be confirmed) listing Moodle courses and content to download The page should have: A list of latest OER added to the site A welcome / intro sentence or paragraph A search Links to elsewhere on Moodle.net Social media links (perhaps in the footer?) Footer containing Moodle is a registered trademark. and Contact link The page should be a Moodle page i.e. it should show You are not logged in or You are logged in as ... and include the languages dropdown menu, as on moodle.org.
| Solvable | 1.summary: Create wireframe for Moodle.net/oer
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle.net/OER set-up
description: We need an attractive and inviting page, with URL say (to be confirmed) listing Moodle courses and content to download The page should have: A list of latest OER added to the site A welcome / intro sentence or paragraph A search Links to elsewhere on Moodle.net Social media links (perhaps in the footer?) Footer containing Moodle is a registered trademark. and Contact link The page should be a Moodle page i.e. it should show You are not logged in or You are logged in as ... and include the languages dropdown menu, as on moodle.org.
### Response:
1.summary: Create wireframe for Moodle.net/oer
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Quiz and Question bank in Moodle 4.2
description: Further improvements to Quiz and question bank in Moodle 4.2 Docs (TBA)
| Unsolvable | 1.summary: Create configurable question bank view
description: TBA
2.summary: Create configurable question bank view for qbank_history
description: TBA
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Quiz and Question bank in Moodle 4.2
description: Further improvements to Quiz and question bank in Moodle 4.2 Docs (TBA)
### Response:
1.summary: Create configurable question bank view
description: TBA
2.summary: Create configurable question bank view for qbank_history
description: TBA
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: MoodleMoot Australia 2015 issues
description: This is the collection of tracker issues related to MootAu15.
| Unsolvable | 1.summary: Design appropriate background/theme for AU MoodleMoot site
description: Currently the Au and US MoodleMoot sites are using relatively generic background images. Before the sites are used in earnest, adding a more appropriate background for each would give the sites a greater identity. There are no specific themes beyond the countries relevant to the Moots. One difference to past Moots will be the emphasis on involving people in the development of Moodle and that were hoping to involve a greater number of educational sectors. If its necessary to complement the background, we could also modify the colour scheme used. Were only bound by the limits of the More theme. If more than one idea comes to mind, thats fine as we can use others for later years. Site links:
2.summary: Headshots
description: Resupplied as grayscale edit only - no background changes. This has been decided as the best option for all head shots for the two events, with the volume of speakers, making it a consistent and time-saving option
3.summary: Determine the need for a charging station
description: At the MoodleMoot venue, it would be worth knowing whether there are sufficient powerpoints in and around the main theatre for people to charge their various devices. If there does not appear to be sufficient powerpoints, we can possibly add a table with powerboards to multiply the possibilities. However, there is a downside in that such powerboards would need to be tagged and checked by the local venue facilities people.
4.summary: MoodleMoot Overview Video for Closing Statements
description: Create a template prior to the Moot to make a short overview video from collected footage to be played at the closing statements on Wed 8th July. This issue requires: outline of tasks (to be included in brief) video template, ready for footage music track - suggest Johns
5.summary: Create Site Block to Sell Delegate t-Shirts
description: As per the request from Merrin - she has suggested that while schools, organisations and "uncle Tony" may cover registration prices, they wont cover additionals such as t-shirts. Create a block on the site for delegates to purchase the shirts using their own credit cards and then create a news item on the site for it to notify.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: MoodleMoot Australia 2015 issues
description: This is the collection of tracker issues related to MootAu15.
### Response:
1.summary: Design appropriate background/theme for AU MoodleMoot site
description: Currently the Au and US MoodleMoot sites are using relatively generic background images. Before the sites are used in earnest, adding a more appropriate background for each would give the sites a greater identity. There are no specific themes beyond the countries relevant to the Moots. One difference to past Moots will be the emphasis on involving people in the development of Moodle and that were hoping to involve a greater number of educational sectors. If its necessary to complement the background, we could also modify the colour scheme used. Were only bound by the limits of the More theme. If more than one idea comes to mind, thats fine as we can use others for later years. Site links:
2.summary: Headshots
description: Resupplied as grayscale edit only - no background changes. This has been decided as the best option for all head shots for the two events, with the volume of speakers, making it a consistent and time-saving option
3.summary: Determine the need for a charging station
description: At the MoodleMoot venue, it would be worth knowing whether there are sufficient powerpoints in and around the main theatre for people to charge their various devices. If there does not appear to be sufficient powerpoints, we can possibly add a table with powerboards to multiply the possibilities. However, there is a downside in that such powerboards would need to be tagged and checked by the local venue facilities people.
4.summary: MoodleMoot Overview Video for Closing Statements
description: Create a template prior to the Moot to make a short overview video from collected footage to be played at the closing statements on Wed 8th July. This issue requires: outline of tasks (to be included in brief) video template, ready for footage music track - suggest Johns
5.summary: Create Site Block to Sell Delegate t-Shirts
description: As per the request from Merrin - she has suggested that while schools, organisations and "uncle Tony" may cover registration prices, they wont cover additionals such as t-shirts. Create a block on the site for delegates to purchase the shirts using their own credit cards and then create a news item on the site for it to notify.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle parallel development support
description: After Moodle 3.9 release, its being planned to start working in parallel with 2 lines of development, each one leading to different major releases. This implies changing some assumptions, about versions, branches, the names of both, and whats allowed or not on each development line. This epic is about, at very least: - Explain which the plan is, with all the details. - Detect and add, as issues of this epic, all the points to be taken into consideration. - Modify all the tools (mdlrelease, downloads, version checkers, tracker, CI...) which previous assumptions about versions, branches and names my be affected. - Modify all the processes (releasing, tagging, branching, version "reservation"...) and their corresponding docs. - Ensure that the effects of the change to the proposed are under control (new or adjust checks). - Guarantee that CI is covering both development lines. - Document and much as possible all the above.. panel:title=Instructions for future parallel development periods - branch creation|borderStyle=dashed|borderColor=cccccc|titleBGColor=f7d6c1|bgColor=ffffceNote that in it has been documented the complete process to get a new parallel development branch created and supported. Both when starting new parallel periods (like for 3.10) or when continuing existing ones (like for 3.11).panel
| Unsolvable | 1.summary: Update composer.json with the new moodlehq/behat-extension tag for 4.0dev (and exceptionally, 3.10dev)
description: Special notes (for this issue only): Note: This must be done for as many dev branches still not having their corresponding tags. Normally its only master, but under parallel development periods, when it could be (together with or alternatively) an XXX_STABLE dev branch. Of course it requires the dev branches to exist, cannot be done before that. ---- ^^^ In this case, its together with the 311_STABLE branch, master too. ---- After releasing XY we should update composer.json in master to point to a new tag (from master branch) according to the moodle development version (3.310.0 for Behat 3 and Moodle 3.10dev for example - and 3.400.0 for Behat 3 and Moodle 4.0dev - this issue). Detailed process: After creating the branch & tag and pushing it upstream... verify the new version has been released in packagist (it happens automatically - hooks are enabled since v3.36.x - or under demand if a package maintainer is asked). Link: Then, in the master branch, edit composer.json and bump the "moodlehq/behat-extension" to the newly created tag. To regenerate the composer.lock file, follow the instructions available @ Moodle Docs| Ensure changes related to the extension are ok in the .lock file (version, pointing to moodlehq repo...). It will come also with updates to many of the dependencies. Run behat tests and phpunit tests to confirm they work ok.
2.summary: Ensure external testers environment is ready for the parallel development
description: Whenever new branches are created, like right now 310 one external testers may need to: - Perform some actions in their testing environment. - Clearly comment about the existence of the new branches. And we may need to: - Roll a new version of the testing environment containing current branches/versions... This issue is just to ensure that we dont miss that whenever a new "parallel development" period begins.
3.summary: Plan and implement how to manage QA sites under parallel development
description: Now that we have a couple of development branches, its time to plan how to better provide QA support for them. Basically there are 3 possibilities: a) -We do nothing and just keep master as only QA site- This seems to be discarded because we are going to need a site for the next release (3.10, in November) QA cycle. b) We only keep ONE QA site, for the very next version to be released (3.10 right now). c) We keep QA sites for ALL development versions (3.10 and 4.0 right now, with the former becoming 3.11 after November). Whichever is the decided approach the sites will need to be created (public and master), documented and so on, this issue is about that.
4.summary: Change all comments in code pointing to 4.0, to 3.10
description: Any existing comment (deprecations mainly) in codebase pointing to 4.0 should be moved to 3.10. Similarly 4.1 => 3.11, 4.2 => 4.0 and 4.3 => 4.1 This is really parallel with the very same change performed in the tracker where all the deprecation epics where rearranged that way. To be done in both MOODLE_310_STABLE and master. And in order to avoid any overlapping (one commit each and in strict order). 1) 4.0 => 3.10 2) 4.1 => 3.11 3) 4.2 => 4.0 4) 4.3 => 4.1 5) 4.4 => 4.2 6) 4.5 => 4.3 (there isnt any) The regular expression used to find occurrences, ignoring some false positives (not all), replace "X" by the desired version, is: code ag \b(todo|mdl|deprecate|remove|moodle).\b4\.X --ignore=\ .map,.json,.ser,build,jquery,\ install/lang,lib/adodb,mongodb/MongoDB,\ horde/framework,joubel/editor,chartjs-lazy.js,\ tiny_mce.js,axe.min.js code
5.summary: download.moodle.org backend scripts
description: Verify that all the scripts at download.moodle.org work ok under parallel development and, more specifically, with the new 3-digits branch schema (310, 400...). This includes (incomplete list): - packaging scripts. - releasing scripts. - updates api. - windows builds. - mac builds. - download stats. - ...
6.summary: download.moodle.org frontend scripts
description: Verify that all the scripts (mostly moodle plugins) at download.moodle.org are working ok, with all the information being shown in place for the new 3-digit dev branches (310, 400...).
7.summary: Plan for 3.10 user docs and related redirects
description: We need to decide on a URL for the 3.10 docs wikis e.g. docs.moodle.org/310 ?
8.summary: Ensure that all the upgrade savepoints are using correct/allowed versions
description: In we enabled the versions checker to be able to verify if all versions are within a defined interval. This is specially critical under parallel development periods, ensuring that all versions are diverged and overlapping doesnt happen ever. See: This issue can be considered parallel to that one, implementing the very same in the upgrade save-points checker| Note that, in theory, this is not strictly needed because the versions used in upgrade must match the version in version.php, that is already being checked. But its not impossible to forget that in some upgrade step, so better we verify all them are within the constraints. At very least the max allowed version must be checked (surely its not possible to check the lower limit). Note: Dont forget to update the release process to modify the job each time a new branch is created.
9.summary: Run the release process towards the creation of all the 311_STABLE stuff
description: panel:title=Important note|borderStyle=dashed|borderColor=cccccc|titleBGColor=f7d6c1|bgColor=ffffceThis issue includes the information to both start (like for 3.10) and continue (like for 3.11) a new parallel development cycle. Please keep it updated with any extra information. And use it (clone) for future cases.panel This is a clone of , where the same (or similar) actions were performed to the creation of the MOODLE_310_STABLE branch. In this case, here well be creating the MOODLE_311_STABLE branch (generically named MOODLE_XYZ along the document for easier future cloning). . Goal The goal of this issue is to end with all the systems (git, tracker, jenkins, codebase...) ready for working with the new MOODLE_XYZ_STABLE development branch (despite its name). . Requirements: Wait for the on-sync period of the previous release to be finished. Then, ASAP, proceed to create the new branch. Base branch to split from: When starting the parallel development period (with MOODLE_XY(Z-1)_STABLE) we branched from master. Thats the branch from which, now, to continue with the parallel development period, well be creating the new MOODLE_XYZ_STABLE branch. To be able to perform the whole process, some permissions are needed: Write access to various moodlehq repositories (gitlab and github) are needed. Integration permissions to be able to handle versions in the tracker. Filter creation (filter_manager credentials required). Admin permissions in the tracker to be able to create new fields and assign them to various screens and, finally, reindex. . Process: Note that some of the tasks listed below are not always needed, some are only required when the initial parallel development period was started). The list below aims to be complete (as a reference for future parallel dev periods), and will include comments about when each task was applied for current 311 or no. . A) Run a good part of the release process| (always). This step is the one effectively creating the git branches, track fields, CI new jobs, adjusting everything for the branch being created (MOODLE_XYZ_STABLE). Note that it excludes any step related with releasing any version, because we arent doing that now, we are just creating a new branch. Here there is a complete list of all the actions to perform (when an action corresponds to some exact step in the release process doc, its referenced): . Initial steps integration.git Ensure that weeklies have been already released (their windows packages generated... @ 09:00 AU aprox - all integrators receive notifications about that). Fetch and merge / pull all changes to local integration.git clone. In local integration.git clone, create the new MOODLE_XYZ_STABLE branch, branching from the "base branch to split from" decided in the requirements. Push the the new branch to origin integration.git security git: Fetch and merge / pull all changes to local security.git clone. Follow exactly the same steps than the integration.git ones, but with these 2 branches: MOODLE_XYZ_STABLE and lastbased-MOODLE_XYZ_STABLE (each one branching from its own - and different - "base branch to split from". Verify that any security issue that may exist in the previous base branch is also in the new MOODLE_XYZ_STABLE one. Push the the new branch to origin security . Steps from "a week prior" Logged in as filter_manager, in the Tracker, review all the filters and duplicate as many as needed to point to the new created branch. (step 1 in the release process). Create the needed PRs for CI repositories (nightlyjobs and moodle-ci-runner), as stated in the process. (step 13) . Steps from "Packaging" Configure mdlrelease locally to know about the new development branch). Push changes upstream. Ask all the team to update their mdlrelease clones. (step 4). Update the old CI server jobs as stated in the process. (step 4). Configure the "05. Check version files" jobs to define the interval of allowed versions for each branch (310 - now fixed to release date, 311 - interval since branch day till release day and master - fixed to 2w after last parallel release date ). (step 4). Configure the "25. Compare databases ..." master job to verify upgrade from the just created XYZ branch. (step 4). Merge the needed PRs for CI repos, as stated in the process. Note that the 4th PR (enable langupgrade tests) cannot be merged until the new language packs are available, see section E) below. (step 4). In new CI infrastructure, clone all jobs from master to new view as stated in the process.(step 4). Share with workplace and mobile about the new branch, in case they want jobs running against it. Create the corresponding windows packager (@ downloads) and modify stats.php as stated in the process. (step 8). Create the new "Pull branch" and "Pull diff" fields in the tracker and add them to all screens and CI jobs (step 10). Edit all the jobs commented in that step (10) to meet the new fields and new branch just created. Create an MDL issue to integrate the minimal changes needed for the new branch to work. Note that its different if we are continuing an existing parallel cycle (like this issue case is) or if we are starting a new parallel development cycle: For an existing cycle, see (really simple, just a few changes in version, backup and travis are needed). For a new cycle, see (it needs all the changes applied for an existing PLUS plan a mega-bump of all master versions to avoid any overlapping of versions). Once the issue in the previous point has been integrated and all tests are passing... run the mdlrelease process (prerelease and release) only for that new branch (--branch MOODLE_XYZ_STABLE), that will create the branch @ moodle.git and other upstream clones. Protect the new branch in github interface. (step 14) Enable the new development branch @ downloads, see the changes to cfg.php performed by c1450db & 246ed79 @ serverscripts.git (optional) To force the generation of the first packages for the branch to be built, run, as vh-downloadmoodleorg the /var/www/vhosts/download.moodle.org/bin/moodle-package-update-local script at downloads, check output. Note1: If not executed, packages will be generated when rolling next weeklies, together with the rest of branches. Note2: You can check that they have been created @ (zip, tgz and checksums) Note3: Important! The packages (normal and windows) wont show @ downloads.moodle.org yet, thats normal, they are made visible - aka, released - by the release automatic execution script (see next point). . Steps from "Release day" The execution @ 09:00 AU (any day, because they correspond to a dev branch) will process the new branch and downloads for it should be prepared automatically. (1) Verify all looks in place (as a development version). (2) . Steps from "2 weeks after release" moodle-behat-extension (1) Create the new branch (MOODLE_XYZ_STABLE) @ moodle-behat-extension. Tag its HEAD with 3.XYZ, verify its auto-deployed @ packagist. Create an issue (like for 311_STABLE), to make core to point to it. . Final steps Announce the creation of the new branch @ HQ and general dev chats. Announce the creation the new branch, explaining versions and some basic rules in the next integration exposed post (311 example| . B) Some details to confirm, so everything is ready (always). Some of them need to be run always, others only sometimes (or partially). Create clones and link them here when they need to be run for the new MOODLE_XYZ_STABLE branch just created. Here there is a list (still, please check all them): : Ensure that mdk is ready for the new branch. Always needs to be checked. For 3.11, changes were already done, so no new issue. The linked issue corresponds to 3.10. : Ensure that external testers have their environment ready. Always needs to be checked. Nothing especial for 3.11, the work was done, for 3.10, in the linked issue. . C) Versions handling in the tracker (not always, only when new parallel cycle begins). These steps dont need to be run when a parallel development period continues (like now, for 311), but only when such a period begins (like it was for 310). Its important to perform all the following actions together, so nothing is created/edited by anyone else while proceeding with them. Following list details them with links to the issue where they were performed: In the tracker, rename current version in master to parallel development created (example 4.0 => 3.10). Both MDL and CONTRIB. That way, everything scheduled for 4.0 was reassigned automatically to 3.10. Together with the above, create the new real master version (scheduled for when the parallel period ends (example new 4.0 created, for Nov. 2021). That way we get a new 4.0 version where issues really targeting it can be created. Immediately after previous point, modify all the issues that are commenting about the original master version just rename to comment about its replacement (and also next versions, especially deprecation epics rearrange). For example, for 3.10 we did modify 4.0 => 3.10, 4.1 => 3.11, 4.2 => 4.0, 4.3 => 4.1... all future cases. Here you can find more details| about the searches performed . Verify that the affect and fix version match the new comments. . D) Other changes to core (not always, only when new parallel cycle begins). These steps dont need to be run when a parallel development period continues (like now, for 311), but only when such a period begins (like it was for 310). They are changes in core, corresponding/following all the changes performed in the Tracker around versions. Following list details them with links to the issue where they were performed: : Change all the existing upgrade notes to the new branches (example 4.0 => 3.10). That way everything that originally was changed for 4.0 now will point to 3.10, matching the changes in the tracker (C1 above). : Change all the comments in core to the new branches (4.0 => 3.10, 4.1 => 3.11, 4.2 => 4.0, 4.3 => 4.1... all future cases). That way everything will match the moved versions in the tracker (C3 above). . E) Other tasks (always) Ask for the XYZ language packs to be created ASAP. Once the language packs are available the "lang upgrade" tests can be enabled back in the CI servers by merging the 4th pull request created in section A).
10.summary: Minimum changes in code to continue working with parallel branches (3.11)
description: This is done as part of . This issue include all the changes needed in core to continue working with parallel branches, aka. when a parallel development period is already in effect and we are creating a new XXX_STABLE (311 in this case) development branch. Note that the changes in this case are minimal, basically: - Update .travis.yml (or other CI configuration files) to meet the new 311_STABLE dev. branch. - Make backup release to match the new dev. branch. - Change main version.php version, release, branch and maturity to match the new dev. branch and diverge from previous one. Only in the new development branch, thats all! Its important to comment that this case is way simpler than the changes needed to start working with parallel branches (see ). In that case, apart from the changes commented here, its needed to, also, carefully plan to which number (in the future) all the master versions will be bumped to (avoiding any overlapping). See commits in that issue for more information.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle parallel development support
description: After Moodle 3.9 release, its being planned to start working in parallel with 2 lines of development, each one leading to different major releases. This implies changing some assumptions, about versions, branches, the names of both, and whats allowed or not on each development line. This epic is about, at very least: - Explain which the plan is, with all the details. - Detect and add, as issues of this epic, all the points to be taken into consideration. - Modify all the tools (mdlrelease, downloads, version checkers, tracker, CI...) which previous assumptions about versions, branches and names my be affected. - Modify all the processes (releasing, tagging, branching, version "reservation"...) and their corresponding docs. - Ensure that the effects of the change to the proposed are under control (new or adjust checks). - Guarantee that CI is covering both development lines. - Document and much as possible all the above.. panel:title=Instructions for future parallel development periods - branch creation|borderStyle=dashed|borderColor=cccccc|titleBGColor=f7d6c1|bgColor=ffffceNote that in it has been documented the complete process to get a new parallel development branch created and supported. Both when starting new parallel periods (like for 3.10) or when continuing existing ones (like for 3.11).panel
### Response:
1.summary: Update composer.json with the new moodlehq/behat-extension tag for 4.0dev (and exceptionally, 3.10dev)
description: Special notes (for this issue only): Note: This must be done for as many dev branches still not having their corresponding tags. Normally its only master, but under parallel development periods, when it could be (together with or alternatively) an XXX_STABLE dev branch. Of course it requires the dev branches to exist, cannot be done before that. ---- ^^^ In this case, its together with the 311_STABLE branch, master too. ---- After releasing XY we should update composer.json in master to point to a new tag (from master branch) according to the moodle development version (3.310.0 for Behat 3 and Moodle 3.10dev for example - and 3.400.0 for Behat 3 and Moodle 4.0dev - this issue). Detailed process: After creating the branch & tag and pushing it upstream... verify the new version has been released in packagist (it happens automatically - hooks are enabled since v3.36.x - or under demand if a package maintainer is asked). Link: Then, in the master branch, edit composer.json and bump the "moodlehq/behat-extension" to the newly created tag. To regenerate the composer.lock file, follow the instructions available @ Moodle Docs| Ensure changes related to the extension are ok in the .lock file (version, pointing to moodlehq repo...). It will come also with updates to many of the dependencies. Run behat tests and phpunit tests to confirm they work ok.
2.summary: Ensure external testers environment is ready for the parallel development
description: Whenever new branches are created, like right now 310 one external testers may need to: - Perform some actions in their testing environment. - Clearly comment about the existence of the new branches. And we may need to: - Roll a new version of the testing environment containing current branches/versions... This issue is just to ensure that we dont miss that whenever a new "parallel development" period begins.
3.summary: Plan and implement how to manage QA sites under parallel development
description: Now that we have a couple of development branches, its time to plan how to better provide QA support for them. Basically there are 3 possibilities: a) -We do nothing and just keep master as only QA site- This seems to be discarded because we are going to need a site for the next release (3.10, in November) QA cycle. b) We only keep ONE QA site, for the very next version to be released (3.10 right now). c) We keep QA sites for ALL development versions (3.10 and 4.0 right now, with the former becoming 3.11 after November). Whichever is the decided approach the sites will need to be created (public and master), documented and so on, this issue is about that.
4.summary: Change all comments in code pointing to 4.0, to 3.10
description: Any existing comment (deprecations mainly) in codebase pointing to 4.0 should be moved to 3.10. Similarly 4.1 => 3.11, 4.2 => 4.0 and 4.3 => 4.1 This is really parallel with the very same change performed in the tracker where all the deprecation epics where rearranged that way. To be done in both MOODLE_310_STABLE and master. And in order to avoid any overlapping (one commit each and in strict order). 1) 4.0 => 3.10 2) 4.1 => 3.11 3) 4.2 => 4.0 4) 4.3 => 4.1 5) 4.4 => 4.2 6) 4.5 => 4.3 (there isnt any) The regular expression used to find occurrences, ignoring some false positives (not all), replace "X" by the desired version, is: code ag \b(todo|mdl|deprecate|remove|moodle).\b4\.X --ignore=\ .map,.json,.ser,build,jquery,\ install/lang,lib/adodb,mongodb/MongoDB,\ horde/framework,joubel/editor,chartjs-lazy.js,\ tiny_mce.js,axe.min.js code
5.summary: download.moodle.org backend scripts
description: Verify that all the scripts at download.moodle.org work ok under parallel development and, more specifically, with the new 3-digits branch schema (310, 400...). This includes (incomplete list): - packaging scripts. - releasing scripts. - updates api. - windows builds. - mac builds. - download stats. - ...
6.summary: download.moodle.org frontend scripts
description: Verify that all the scripts (mostly moodle plugins) at download.moodle.org are working ok, with all the information being shown in place for the new 3-digit dev branches (310, 400...).
7.summary: Plan for 3.10 user docs and related redirects
description: We need to decide on a URL for the 3.10 docs wikis e.g. docs.moodle.org/310 ?
8.summary: Ensure that all the upgrade savepoints are using correct/allowed versions
description: In we enabled the versions checker to be able to verify if all versions are within a defined interval. This is specially critical under parallel development periods, ensuring that all versions are diverged and overlapping doesnt happen ever. See: This issue can be considered parallel to that one, implementing the very same in the upgrade save-points checker| Note that, in theory, this is not strictly needed because the versions used in upgrade must match the version in version.php, that is already being checked. But its not impossible to forget that in some upgrade step, so better we verify all them are within the constraints. At very least the max allowed version must be checked (surely its not possible to check the lower limit). Note: Dont forget to update the release process to modify the job each time a new branch is created.
9.summary: Run the release process towards the creation of all the 311_STABLE stuff
description: panel:title=Important note|borderStyle=dashed|borderColor=cccccc|titleBGColor=f7d6c1|bgColor=ffffceThis issue includes the information to both start (like for 3.10) and continue (like for 3.11) a new parallel development cycle. Please keep it updated with any extra information. And use it (clone) for future cases.panel This is a clone of , where the same (or similar) actions were performed to the creation of the MOODLE_310_STABLE branch. In this case, here well be creating the MOODLE_311_STABLE branch (generically named MOODLE_XYZ along the document for easier future cloning). . Goal The goal of this issue is to end with all the systems (git, tracker, jenkins, codebase...) ready for working with the new MOODLE_XYZ_STABLE development branch (despite its name). . Requirements: Wait for the on-sync period of the previous release to be finished. Then, ASAP, proceed to create the new branch. Base branch to split from: When starting the parallel development period (with MOODLE_XY(Z-1)_STABLE) we branched from master. Thats the branch from which, now, to continue with the parallel development period, well be creating the new MOODLE_XYZ_STABLE branch. To be able to perform the whole process, some permissions are needed: Write access to various moodlehq repositories (gitlab and github) are needed. Integration permissions to be able to handle versions in the tracker. Filter creation (filter_manager credentials required). Admin permissions in the tracker to be able to create new fields and assign them to various screens and, finally, reindex. . Process: Note that some of the tasks listed below are not always needed, some are only required when the initial parallel development period was started). The list below aims to be complete (as a reference for future parallel dev periods), and will include comments about when each task was applied for current 311 or no. . A) Run a good part of the release process| (always). This step is the one effectively creating the git branches, track fields, CI new jobs, adjusting everything for the branch being created (MOODLE_XYZ_STABLE). Note that it excludes any step related with releasing any version, because we arent doing that now, we are just creating a new branch. Here there is a complete list of all the actions to perform (when an action corresponds to some exact step in the release process doc, its referenced): . Initial steps integration.git Ensure that weeklies have been already released (their windows packages generated... @ 09:00 AU aprox - all integrators receive notifications about that). Fetch and merge / pull all changes to local integration.git clone. In local integration.git clone, create the new MOODLE_XYZ_STABLE branch, branching from the "base branch to split from" decided in the requirements. Push the the new branch to origin integration.git security git: Fetch and merge / pull all changes to local security.git clone. Follow exactly the same steps than the integration.git ones, but with these 2 branches: MOODLE_XYZ_STABLE and lastbased-MOODLE_XYZ_STABLE (each one branching from its own - and different - "base branch to split from". Verify that any security issue that may exist in the previous base branch is also in the new MOODLE_XYZ_STABLE one. Push the the new branch to origin security . Steps from "a week prior" Logged in as filter_manager, in the Tracker, review all the filters and duplicate as many as needed to point to the new created branch. (step 1 in the release process). Create the needed PRs for CI repositories (nightlyjobs and moodle-ci-runner), as stated in the process. (step 13) . Steps from "Packaging" Configure mdlrelease locally to know about the new development branch). Push changes upstream. Ask all the team to update their mdlrelease clones. (step 4). Update the old CI server jobs as stated in the process. (step 4). Configure the "05. Check version files" jobs to define the interval of allowed versions for each branch (310 - now fixed to release date, 311 - interval since branch day till release day and master - fixed to 2w after last parallel release date ). (step 4). Configure the "25. Compare databases ..." master job to verify upgrade from the just created XYZ branch. (step 4). Merge the needed PRs for CI repos, as stated in the process. Note that the 4th PR (enable langupgrade tests) cannot be merged until the new language packs are available, see section E) below. (step 4). In new CI infrastructure, clone all jobs from master to new view as stated in the process.(step 4). Share with workplace and mobile about the new branch, in case they want jobs running against it. Create the corresponding windows packager (@ downloads) and modify stats.php as stated in the process. (step 8). Create the new "Pull branch" and "Pull diff" fields in the tracker and add them to all screens and CI jobs (step 10). Edit all the jobs commented in that step (10) to meet the new fields and new branch just created. Create an MDL issue to integrate the minimal changes needed for the new branch to work. Note that its different if we are continuing an existing parallel cycle (like this issue case is) or if we are starting a new parallel development cycle: For an existing cycle, see (really simple, just a few changes in version, backup and travis are needed). For a new cycle, see (it needs all the changes applied for an existing PLUS plan a mega-bump of all master versions to avoid any overlapping of versions). Once the issue in the previous point has been integrated and all tests are passing... run the mdlrelease process (prerelease and release) only for that new branch (--branch MOODLE_XYZ_STABLE), that will create the branch @ moodle.git and other upstream clones. Protect the new branch in github interface. (step 14) Enable the new development branch @ downloads, see the changes to cfg.php performed by c1450db & 246ed79 @ serverscripts.git (optional) To force the generation of the first packages for the branch to be built, run, as vh-downloadmoodleorg the /var/www/vhosts/download.moodle.org/bin/moodle-package-update-local script at downloads, check output. Note1: If not executed, packages will be generated when rolling next weeklies, together with the rest of branches. Note2: You can check that they have been created @ (zip, tgz and checksums) Note3: Important! The packages (normal and windows) wont show @ downloads.moodle.org yet, thats normal, they are made visible - aka, released - by the release automatic execution script (see next point). . Steps from "Release day" The execution @ 09:00 AU (any day, because they correspond to a dev branch) will process the new branch and downloads for it should be prepared automatically. (1) Verify all looks in place (as a development version). (2) . Steps from "2 weeks after release" moodle-behat-extension (1) Create the new branch (MOODLE_XYZ_STABLE) @ moodle-behat-extension. Tag its HEAD with 3.XYZ, verify its auto-deployed @ packagist. Create an issue (like for 311_STABLE), to make core to point to it. . Final steps Announce the creation of the new branch @ HQ and general dev chats. Announce the creation the new branch, explaining versions and some basic rules in the next integration exposed post (311 example| . B) Some details to confirm, so everything is ready (always). Some of them need to be run always, others only sometimes (or partially). Create clones and link them here when they need to be run for the new MOODLE_XYZ_STABLE branch just created. Here there is a list (still, please check all them): : Ensure that mdk is ready for the new branch. Always needs to be checked. For 3.11, changes were already done, so no new issue. The linked issue corresponds to 3.10. : Ensure that external testers have their environment ready. Always needs to be checked. Nothing especial for 3.11, the work was done, for 3.10, in the linked issue. . C) Versions handling in the tracker (not always, only when new parallel cycle begins). These steps dont need to be run when a parallel development period continues (like now, for 311), but only when such a period begins (like it was for 310). Its important to perform all the following actions together, so nothing is created/edited by anyone else while proceeding with them. Following list details them with links to the issue where they were performed: In the tracker, rename current version in master to parallel development created (example 4.0 => 3.10). Both MDL and CONTRIB. That way, everything scheduled for 4.0 was reassigned automatically to 3.10. Together with the above, create the new real master version (scheduled for when the parallel period ends (example new 4.0 created, for Nov. 2021). That way we get a new 4.0 version where issues really targeting it can be created. Immediately after previous point, modify all the issues that are commenting about the original master version just rename to comment about its replacement (and also next versions, especially deprecation epics rearrange). For example, for 3.10 we did modify 4.0 => 3.10, 4.1 => 3.11, 4.2 => 4.0, 4.3 => 4.1... all future cases. Here you can find more details| about the searches performed . Verify that the affect and fix version match the new comments. . D) Other changes to core (not always, only when new parallel cycle begins). These steps dont need to be run when a parallel development period continues (like now, for 311), but only when such a period begins (like it was for 310). They are changes in core, corresponding/following all the changes performed in the Tracker around versions. Following list details them with links to the issue where they were performed: : Change all the existing upgrade notes to the new branches (example 4.0 => 3.10). That way everything that originally was changed for 4.0 now will point to 3.10, matching the changes in the tracker (C1 above). : Change all the comments in core to the new branches (4.0 => 3.10, 4.1 => 3.11, 4.2 => 4.0, 4.3 => 4.1... all future cases). That way everything will match the moved versions in the tracker (C3 above). . E) Other tasks (always) Ask for the XYZ language packs to be created ASAP. Once the language packs are available the "lang upgrade" tests can be enabled back in the CI servers by merging the 4th pull request created in section A).
10.summary: Minimum changes in code to continue working with parallel branches (3.11)
description: This is done as part of . This issue include all the changes needed in core to continue working with parallel branches, aka. when a parallel development period is already in effect and we are creating a new XXX_STABLE (311 in this case) development branch. Note that the changes in this case are minimal, basically: - Update .travis.yml (or other CI configuration files) to meet the new 311_STABLE dev. branch. - Make backup release to match the new dev. branch. - Change main version.php version, release, branch and maturity to match the new dev. branch and diverge from previous one. Only in the new development branch, thats all! Its important to comment that this case is way simpler than the changes needed to start working with parallel branches (see ). In that case, apart from the changes commented here, its needed to, also, carefully plan to which number (in the future) all the master versions will be bumped to (avoiding any overlapping). See commits in that issue for more information.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Merge Participants and Enrolled Users page follow-up
description: These are a list of issues related to the merging of the two pages in .
| Unsolvable | 1.summary: Add ability to download the Participants table
description: There is a Moodle 2.3 plugin by Kirill Astashov: that does the trick but is restricted to PostgreSQL. It is a useful feature for user mgmt that has been left aside..
2.summary: Allow multiple same type filters on Participants page
description: It would be very helpful and necessary for us to be able to filter the Participants list for both: role:teacher and role:XXX (xxx = other roles...)
3.summary: Incorrect pagetype for enrol-users
description: Now that the Participants and Enrolled users pages () have been merged, the pagetype for the merged page should be something like "enrol-users" (as enrol/users.php was) rather than the course format view. There is some CSS for page-enrol-users in Boost and boostrapbase that may need removing.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Merge Participants and Enrolled Users page follow-up
description: These are a list of issues related to the merging of the two pages in .
### Response:
1.summary: Add ability to download the Participants table
description: There is a Moodle 2.3 plugin by Kirill Astashov: that does the trick but is restricted to PostgreSQL. It is a useful feature for user mgmt that has been left aside..
2.summary: Allow multiple same type filters on Participants page
description: It would be very helpful and necessary for us to be able to filter the Participants list for both: role:teacher and role:XXX (xxx = other roles...)
3.summary: Incorrect pagetype for enrol-users
description: Now that the Participants and Enrolled users pages () have been merged, the pagetype for the merged page should be something like "enrol-users" (as enrol/users.php was) rather than the course format view. There is some CSS for page-enrol-users in Boost and boostrapbase that may need removing.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Review third party libraries for new versions (4.3 release)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Run the new task to get the libraries that need to be updated (it might take a few minutes to finish): codenpm install grunt upgradablelibs > result.txtcode Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
| Unsolvable | 1.summary: Upgrade phpxmlrpc to 4.10.1
description: phpxmlrpc phpxmlrpc 4.8.1 --> 4.10.1
2.summary: Upgrade XHProf to 2.3.9
description: XHProf (/lib/xhprof/) 2.3.5 --> 2.3.9 :
3.summary: Upgrade Tiny to 6.6.2
description: Tiny lib/editor/tiny/ 6.3.2 --> 6.6.0 Changelog:
4.summary: Upgrade ogv.js to 1.8.9
description: ogv.js amd/src/local/ogv/ogv.js 1.8.4 --> 1.8.9 ogv.js support files ogvjs 1.8.4 --> 1.8.9
5.summary: Upgrade ogv.js tech plugin for VideoJS to 0.2.1
description: ogv.js tech plugin for VideoJS (amd/src/videojs-ogvjs-lazy.js) 0.1.2 --> 0.2.1
6.summary: Upgrade VideoJS and friends to 8.3.0
description: - VideoJS media/player/videojs/amd/src/video-lazy.js 7.20.3 --> 8.3.0 - VideoJS support files media/player/videojs/videojs/ 7.20.3 --> 8.3.0 - YouTube Playback Technology for Video.js media/player/videojs/amd/src/Youtube-lazy.js 2.6.1 --> 3.0.1 - ogv.js amd/src/local/ogv/ogv.js 1.8.4 --> 1.8.9 - ogv.js support files ogvjs 1.8.4 --> 1.8.9 - ogv.js tech plugin amd/src/videojs-ogvjs-lazy.js 0.2.1 --> 1.0.0
7.summary: Upgrade Chart.js to 4.4.0
description: Chart.js lib/amd/src/chartjs-lazy.js 4.2.1 --> 4.4.0
8.summary: Upgrade PHP-JWT to 6.8.1
description: PHP-JWT lib/php-jwt/ 6.4.0 --> 6.8.1
9.summary: Upgrade axe-core to 4.7.2
description: axe-core behat/axe 4.6.3 --> 4.7.2
10.summary: Upgrade OpenSpout to 4.15.0
description: OpenSpout lib/openspout 4.13.0 --> 4.15.0
11.summary: Upgrade PHP-ML to 0.10.0
description: PHP-ML lib/mlbackend/php/phpml/ 0.9.0 --> 0.10.0
12.summary: Upgrade FPDI to 2.3.7
description: FPDI mod/assign/feedback/editpdf/fpdi/ 2.3.6 --> 2.3.7
13.summary: Upgrade lti1p3 to 5.4.1
description: lti1p3 lib/lti1p3 5.2.6 --> 5.4.1
14.summary: Upgrade ADOdb to 5.22.5
description: ADOdb (/lib/adodb/) 5.22.4 --> 5.22.5
15.summary: Upgrade PHPMailer to 6.8.0
description: PHPMailer lib/phpmailer/ 6.7.1 --> 6.8.0
16.summary: Upgrade PHPSpreadSheet to 1.29.0
description: PhpSpreadsheet lib/phpspreadsheet/ 1.28.0 --> 1.29.0
17.summary: Upgrade Codemirror to 5.65.15
description: codemirror lib/editor/atto/plugins/html/yui/src/codemirror/ 5.65.12 --> 5.65.15
18.summary: Upgrade jQuery to 3.7.1
description: jQuery lib/jquery/ 3.6.4 --> 3.7.1
19.summary: Upgrade emoji-data to 15.0.1
description: emoji-data lib/emoji-data 14.0.1 --> 15.0.1
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Review third party libraries for new versions (4.3 release)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Run the new task to get the libraries that need to be updated (it might take a few minutes to finish): codenpm install grunt upgradablelibs > result.txtcode Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
### Response:
1.summary: Upgrade phpxmlrpc to 4.10.1
description: phpxmlrpc phpxmlrpc 4.8.1 --> 4.10.1
2.summary: Upgrade XHProf to 2.3.9
description: XHProf (/lib/xhprof/) 2.3.5 --> 2.3.9 :
3.summary: Upgrade Tiny to 6.6.2
description: Tiny lib/editor/tiny/ 6.3.2 --> 6.6.0 Changelog:
4.summary: Upgrade ogv.js to 1.8.9
description: ogv.js amd/src/local/ogv/ogv.js 1.8.4 --> 1.8.9 ogv.js support files ogvjs 1.8.4 --> 1.8.9
5.summary: Upgrade ogv.js tech plugin for VideoJS to 0.2.1
description: ogv.js tech plugin for VideoJS (amd/src/videojs-ogvjs-lazy.js) 0.1.2 --> 0.2.1
6.summary: Upgrade VideoJS and friends to 8.3.0
description: - VideoJS media/player/videojs/amd/src/video-lazy.js 7.20.3 --> 8.3.0 - VideoJS support files media/player/videojs/videojs/ 7.20.3 --> 8.3.0 - YouTube Playback Technology for Video.js media/player/videojs/amd/src/Youtube-lazy.js 2.6.1 --> 3.0.1 - ogv.js amd/src/local/ogv/ogv.js 1.8.4 --> 1.8.9 - ogv.js support files ogvjs 1.8.4 --> 1.8.9 - ogv.js tech plugin amd/src/videojs-ogvjs-lazy.js 0.2.1 --> 1.0.0
7.summary: Upgrade Chart.js to 4.4.0
description: Chart.js lib/amd/src/chartjs-lazy.js 4.2.1 --> 4.4.0
8.summary: Upgrade PHP-JWT to 6.8.1
description: PHP-JWT lib/php-jwt/ 6.4.0 --> 6.8.1
9.summary: Upgrade axe-core to 4.7.2
description: axe-core behat/axe 4.6.3 --> 4.7.2
10.summary: Upgrade OpenSpout to 4.15.0
description: OpenSpout lib/openspout 4.13.0 --> 4.15.0
11.summary: Upgrade PHP-ML to 0.10.0
description: PHP-ML lib/mlbackend/php/phpml/ 0.9.0 --> 0.10.0
12.summary: Upgrade FPDI to 2.3.7
description: FPDI mod/assign/feedback/editpdf/fpdi/ 2.3.6 --> 2.3.7
13.summary: Upgrade lti1p3 to 5.4.1
description: lti1p3 lib/lti1p3 5.2.6 --> 5.4.1
14.summary: Upgrade ADOdb to 5.22.5
description: ADOdb (/lib/adodb/) 5.22.4 --> 5.22.5
15.summary: Upgrade PHPMailer to 6.8.0
description: PHPMailer lib/phpmailer/ 6.7.1 --> 6.8.0
16.summary: Upgrade PHPSpreadSheet to 1.29.0
description: PhpSpreadsheet lib/phpspreadsheet/ 1.28.0 --> 1.29.0
17.summary: Upgrade Codemirror to 5.65.15
description: codemirror lib/editor/atto/plugins/html/yui/src/codemirror/ 5.65.12 --> 5.65.15
18.summary: Upgrade jQuery to 3.7.1
description: jQuery lib/jquery/ 3.6.4 --> 3.7.1
19.summary: Upgrade emoji-data to 15.0.1
description: emoji-data lib/emoji-data 14.0.1 --> 15.0.1
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle sites upgrade to 2.7
description: Following the release of Moodle 2.7, all Moodle community sites need to be upgraded. Target completion date: Monday 19th May.
| Unsolvable | 1.summary: Reinstall School demo site
description: The School demo has been observed to have a number of database issues over the last couple of years, and most recently when attempting to upgrade to 2.6.2 as part of It is therefore planned to reinstall the site
2.summary: Upgrade moodle.org to 2.7
description: Moodle.org is currently on 2.7.0-rc 1 Upgrade checklist:
3.summary: Upgrade demo.moodle.net to 2.7
description: Sandbox upgrade checklist:
4.summary: Upgrade dev.moodle.org to 2.7
description: Dev courses upgrade checklist:
5.summary: Upgrade moodle.net to 2.7
description:
6.summary: Upgrade courses.moodle.com to 2.7
description:
7.summary: Upgrade research.moodle.net to 2.7
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle sites upgrade to 2.7
description: Following the release of Moodle 2.7, all Moodle community sites need to be upgraded. Target completion date: Monday 19th May.
### Response:
1.summary: Reinstall School demo site
description: The School demo has been observed to have a number of database issues over the last couple of years, and most recently when attempting to upgrade to 2.6.2 as part of It is therefore planned to reinstall the site
2.summary: Upgrade moodle.org to 2.7
description: Moodle.org is currently on 2.7.0-rc 1 Upgrade checklist:
3.summary: Upgrade demo.moodle.net to 2.7
description: Sandbox upgrade checklist:
4.summary: Upgrade dev.moodle.org to 2.7
description: Dev courses upgrade checklist:
5.summary: Upgrade moodle.net to 2.7
description:
6.summary: Upgrade courses.moodle.com to 2.7
description:
7.summary: Upgrade research.moodle.net to 2.7
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.2
description: In 3.2 we can remove functionality that was deprecated in 2.9 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.2. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Allow only to upload files to draft area in core_files_upload
description: There is currently a debugging message there saying that upload files to the user private area is deprecated.
2.summary: Remove deprecated course/category.php
description: was deprecated in Moodle 2.5, and is due for removal. Unfortunately this was not added with a version number as it preceded our stricter deprecation policy. As such, there is no version number in the file, and no mention in upgrade.txt files that I can see. We can either remove it entirely now in Moodle 3.0 (its had 5 versions), or we can reset the deprecation timer and add the appropriate notes.
3.summary: Migrate to Dropbox API v2
description: Dropbox have release a new API increment, we probably should update to v2 before we get caught out when they drop v1: quote At some point well likely deprecate the previous API v1, but we dont have specific plans to share now. Well be sure to give developers plenty of warning. quote
4.summary: Properly deprecate unzip_file/zip_file
description: Sam - Related to your recent commit for , I did a grep of 2.0 code base and found a couple more instances of where the deprecated unzip_file/zip_file is being used: /question/format/blackboard_six/format.php /lib/componentlib.php Peace - Anthony p.s. - Perhaps we should create a meta issue to grep for deprecated functions as part of code clean up
5.summary: Move alfresco repository to plugins DB
description: It relies on a no longer maintained php library that does not work against current versions of alfresco.
6.summary: Deprecate old boxnet v1 API
description: Just noticed this in a TODO from fred, any chance we can do this for 2.9? Cheers code / Migrate the references to local files. As the APIv1 is reaching its end of life on the 14th of Dec 2013, and we cannot convert the existing references to new references, we need to convert them to real files. Deprecate/remove this function after the 14th of December 2013. void / code
7.summary: Make sure all functions in lib/deprecatedlib.php have debugging message
description: Go through all functions in lib/deprecatedlib.php and make sure they all: display developer debugging message have since X.X phpdocs token If some functions do not do any of that, add since 3.0 and debugging message. AFAIK some of functions are still used in Moodle. Make sure to grep !
8.summary: Remove strings deprecated in 2.9
description: Remove strings from language files under the heading "Deprecated in Moodle 2.9" and the respective lines in deprecated.txt files See also
9.summary: Remove password_compat library
description: Once we have increased our minimum version to PHP 5.5.0, we can drop use of this library in Moodle.
10.summary: Final deprecation / removal of MUC stuff deprecated in 2.6
description: From mr-russ, in devs chat: quote As a current example, the MUC is_persist set of functions was deprecated in 2.6, and is still there. At what point is it possible to remove it? quote It seems that we missed those (have not found them in this epic list), and there are a number of them: code $ ag deprecated since 2. classes/definition.php 251: since 2.9 848: since 2.6 878: since 2.6 classes/store.php 269: since 2.5 classes/loaders.php 954: since 2.6 976: since 2.6 1003: since 2.6 1058: since 2.6 1109: since 2.6 tests/fixtures/lib.php 299: since 2.9 quote Ciao :-)
11.summary: Final deprecation of methods from lib/modinfolib.php
description: I found is_user_access_restricted_by_group(), get_deprecated_group_members_only() and build_section_cache() deprecated in 2.8 Also $standardmethods also refer to deprecated methods (from 2.6)
12.summary: Deprecated get_records_csv() and put_records_csv()
description: While searching for php 7.1 incompatible code I found methods get_record_csv() and put_records_csv() that are never used, have some debug echo and also use \r\n as the line separator.... We need to deprecate them
13.summary: Forum final deprecations to 2.8
description: Perform final deprecations for all forum functions deprecated up to, and including, Moodle 2.8.
14.summary: Deprecate course/lib.php::print_log_.
description: Deprecate course/lib.php::print_log_.. These were used up until , where their usages were converted to the new logging system and they were not deprecated at that time.
15.summary: Final deprecation of get_context_instance()
description: Its been deprecated since 2.2.
16.summary: Properly deprecate update_module_button
description: update_module_button() has been marked as deprecated since 2.0, but it has not really undergone 1st and 2nd stage deprecation since it is still being used in mod_resources resource_print_header() function. There also seems to be no alternative for it (not that I can see from its PHPDoc). Its time that we do something about this.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.2
description: In 3.2 we can remove functionality that was deprecated in 2.9 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.2. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Allow only to upload files to draft area in core_files_upload
description: There is currently a debugging message there saying that upload files to the user private area is deprecated.
2.summary: Remove deprecated course/category.php
description: was deprecated in Moodle 2.5, and is due for removal. Unfortunately this was not added with a version number as it preceded our stricter deprecation policy. As such, there is no version number in the file, and no mention in upgrade.txt files that I can see. We can either remove it entirely now in Moodle 3.0 (its had 5 versions), or we can reset the deprecation timer and add the appropriate notes.
3.summary: Migrate to Dropbox API v2
description: Dropbox have release a new API increment, we probably should update to v2 before we get caught out when they drop v1: quote At some point well likely deprecate the previous API v1, but we dont have specific plans to share now. Well be sure to give developers plenty of warning. quote
4.summary: Properly deprecate unzip_file/zip_file
description: Sam - Related to your recent commit for , I did a grep of 2.0 code base and found a couple more instances of where the deprecated unzip_file/zip_file is being used: /question/format/blackboard_six/format.php /lib/componentlib.php Peace - Anthony p.s. - Perhaps we should create a meta issue to grep for deprecated functions as part of code clean up
5.summary: Move alfresco repository to plugins DB
description: It relies on a no longer maintained php library that does not work against current versions of alfresco.
6.summary: Deprecate old boxnet v1 API
description: Just noticed this in a TODO from fred, any chance we can do this for 2.9? Cheers code / Migrate the references to local files. As the APIv1 is reaching its end of life on the 14th of Dec 2013, and we cannot convert the existing references to new references, we need to convert them to real files. Deprecate/remove this function after the 14th of December 2013. void / code
7.summary: Make sure all functions in lib/deprecatedlib.php have debugging message
description: Go through all functions in lib/deprecatedlib.php and make sure they all: display developer debugging message have since X.X phpdocs token If some functions do not do any of that, add since 3.0 and debugging message. AFAIK some of functions are still used in Moodle. Make sure to grep !
8.summary: Remove strings deprecated in 2.9
description: Remove strings from language files under the heading "Deprecated in Moodle 2.9" and the respective lines in deprecated.txt files See also
9.summary: Remove password_compat library
description: Once we have increased our minimum version to PHP 5.5.0, we can drop use of this library in Moodle.
10.summary: Final deprecation / removal of MUC stuff deprecated in 2.6
description: From mr-russ, in devs chat: quote As a current example, the MUC is_persist set of functions was deprecated in 2.6, and is still there. At what point is it possible to remove it? quote It seems that we missed those (have not found them in this epic list), and there are a number of them: code $ ag deprecated since 2. classes/definition.php 251: since 2.9 848: since 2.6 878: since 2.6 classes/store.php 269: since 2.5 classes/loaders.php 954: since 2.6 976: since 2.6 1003: since 2.6 1058: since 2.6 1109: since 2.6 tests/fixtures/lib.php 299: since 2.9 quote Ciao :-)
11.summary: Final deprecation of methods from lib/modinfolib.php
description: I found is_user_access_restricted_by_group(), get_deprecated_group_members_only() and build_section_cache() deprecated in 2.8 Also $standardmethods also refer to deprecated methods (from 2.6)
12.summary: Deprecated get_records_csv() and put_records_csv()
description: While searching for php 7.1 incompatible code I found methods get_record_csv() and put_records_csv() that are never used, have some debug echo and also use \r\n as the line separator.... We need to deprecate them
13.summary: Forum final deprecations to 2.8
description: Perform final deprecations for all forum functions deprecated up to, and including, Moodle 2.8.
14.summary: Deprecate course/lib.php::print_log_.
description: Deprecate course/lib.php::print_log_.. These were used up until , where their usages were converted to the new logging system and they were not deprecated at that time.
15.summary: Final deprecation of get_context_instance()
description: Its been deprecated since 2.2.
16.summary: Properly deprecate update_module_button
description: update_module_button() has been marked as deprecated since 2.0, but it has not really undergone 1st and 2nd stage deprecation since it is still being used in mod_resources resource_print_header() function. There also seems to be no alternative for it (not that I can see from its PHPDoc). Its time that we do something about this.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Bulk editing of activities completion rules in a course
description: This is part of MUA project MUA-26, to help make the dashboard better mockups more discussion and screenshots on UX-20
| Unsolvable | 1.summary: Create form for bulk editing completion on existing activities
description: Part of the epic this is the form that displays completion rules that are similar between selected activities, allows to modify them and tries to apply to all of them. Updating some activities may result in errors (for example, completion has been locked or we want to require passing grade but not grade to pass is set, etc), the error message should be displayed in this case for the affected activities
2.summary: Create the initial Bulk edit activity page.
description: This is part of the epic This is to create the page that shows all of the activities (that have completion tracking) and allows the user to check the activities they wish to edit (activity completion settings only). This is per REQ 7 of the specification. See for a mockup of this page.
3.summary: Create an api to fetch active completion rule descriptions for activities
description: This is part of epic. Should provide a means to get the description strings for the active completion rules for a given activity, using a cm_info object. should be rebased on top of this.
4.summary: Store and apply defaults for activity completion inside the course
description: Part of epic See second tab of the prototype
5.summary: Add required callbacks to mod_data for bulk completion
description: Following , mod_data should also support data_get_coursemodule_info and mod_data_get_completion_active_rule_descriptions. This issue is rebased on and and should be integrated after both these issues.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Bulk editing of activities completion rules in a course
description: This is part of MUA project MUA-26, to help make the dashboard better mockups more discussion and screenshots on UX-20
### Response:
1.summary: Create form for bulk editing completion on existing activities
description: Part of the epic this is the form that displays completion rules that are similar between selected activities, allows to modify them and tries to apply to all of them. Updating some activities may result in errors (for example, completion has been locked or we want to require passing grade but not grade to pass is set, etc), the error message should be displayed in this case for the affected activities
2.summary: Create the initial Bulk edit activity page.
description: This is part of the epic This is to create the page that shows all of the activities (that have completion tracking) and allows the user to check the activities they wish to edit (activity completion settings only). This is per REQ 7 of the specification. See for a mockup of this page.
3.summary: Create an api to fetch active completion rule descriptions for activities
description: This is part of epic. Should provide a means to get the description strings for the active completion rules for a given activity, using a cm_info object. should be rebased on top of this.
4.summary: Store and apply defaults for activity completion inside the course
description: Part of epic See second tab of the prototype
5.summary: Add required callbacks to mod_data for bulk completion
description: Following , mod_data should also support data_get_coursemodule_info and mod_data_get_completion_active_rule_descriptions. This issue is rebased on and and should be integrated after both these issues.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Translation site improvements part 2
description: Translation site reboot follow-up issues.
| Unsolvable | 1.summary: Display stats on translation site front page
description: As suggested by Martin in : quoteCould we make some basic stats a lot more prominent there? We have translation as a major menu item in our sitebar so it would be nice when anyone clicks on it that they see something on this page about how many languages we have, how many translators and so on.quote
2.summary: AMOS en lang string improvements
description:
3.summary: Translation site front page improvements
description: Since upgrading the site, now uses the moodle.org family theme with 3 large blocks and a footer as on moodle.org. There is no longer a custom top menu, and instead links are listed in the block Quick links. This issue is for tracking suggested improvements to the front page.
4.summary: Create language packs index page
description: The language packs pages on the downloads site, such as provide useful information on the percentage of language strings translated. There was previously a language packs index page on the downloads site, however it was decided in the downloads reboot to link to lang pack downloads pages on the releases pages, such as Thus it would be good to have a lang packs index page on the translation site with links to etc.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Translation site improvements part 2
description: Translation site reboot follow-up issues.
### Response:
1.summary: Display stats on translation site front page
description: As suggested by Martin in : quoteCould we make some basic stats a lot more prominent there? We have translation as a major menu item in our sitebar so it would be nice when anyone clicks on it that they see something on this page about how many languages we have, how many translators and so on.quote
2.summary: AMOS en lang string improvements
description:
3.summary: Translation site front page improvements
description: Since upgrading the site, now uses the moodle.org family theme with 3 large blocks and a footer as on moodle.org. There is no longer a custom top menu, and instead links are listed in the block Quick links. This issue is for tracking suggested improvements to the front page.
4.summary: Create language packs index page
description: The language packs pages on the downloads site, such as provide useful information on the percentage of language strings translated. There was previously a language packs index page on the downloads site, however it was decided in the downloads reboot to link to lang pack downloads pages on the releases pages, such as Thus it would be good to have a lang packs index page on the translation site with links to etc.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle sites 2.9.2 upgrade
description:
| Unsolvable | 1.summary: Upgrade moodle.org to 2.9.2
description:
2.summary: Upgrade learn.moodle.net to 2.9.2
description:
3.summary: Upgrade lang.moodle.org to 2.9.2
description:
4.summary: Upgrade school.demo.moodle.net to 2.9.2
description:
5.summary: Upgrade demo.moodle.net to 2.9.2
description:
6.summary: Upgrade dev.moodle.org to 2.9.2
description:
7.summary: Upgrade moodle.net to 2.9.2
description:
8.summary: Upgrade research.moodle.net to 2.9.2
description:
9.summary: Upgrade moodlemoot.org sites to 2.9.2
description:
10.summary: Upgrade download.moodle.org to 2.9.2
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle sites 2.9.2 upgrade
description:
### Response:
1.summary: Upgrade moodle.org to 2.9.2
description:
2.summary: Upgrade learn.moodle.net to 2.9.2
description:
3.summary: Upgrade lang.moodle.org to 2.9.2
description:
4.summary: Upgrade school.demo.moodle.net to 2.9.2
description:
5.summary: Upgrade demo.moodle.net to 2.9.2
description:
6.summary: Upgrade dev.moodle.org to 2.9.2
description:
7.summary: Upgrade moodle.net to 2.9.2
description:
8.summary: Upgrade research.moodle.net to 2.9.2
description:
9.summary: Upgrade moodlemoot.org sites to 2.9.2
description:
10.summary: Upgrade download.moodle.org to 2.9.2
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Improvement to the quiz reports, especially the statistics
description: This is a set of changes requested by the OU. Jamie Pratt is implementing them.
| Unsolvable | 1.summary: Unit tests for quiz statistics report
description: We want to be able to unit test the quiz reports. This will involve populating the unit test db with test data. Using the data generator we want to be able : Create test instances of each sort of question type. Create a quiz from a set of questions. Supply attempt data for each of those question types. Build entire quiz attempts by supplying attempt data for each question in the quiz, pulling responses from a csv file. Compare the results generated to pre calculated stats for the responses. I will create sub tasks to track these tasks.
2.summary: introduce $form->mock_submit(); method to test form submission
description: A mock_submit method should make the form behave as if a submit button has been pressed and get_data should then return all the values as passed into the form from set_data and setDefault etc. So that we could perform the following integration test for example : code $questiondata = test_question_maker::get_question_data(multichoice, single); $expectedfromform = test_question_maker::get_question_form_data(multichoice, single); $form = new qtype_multichoice_edit_form(...); $form->set_data($questiondata); $form->mock_submit(); $actualfromform = $form->get_data(); $this->assertEquals($expectedfromform, $actualfromform); save_question($actualfromform); $actualquestiondata = question_load_questions(array($actualfromform->id)); $this->assertEquals($questiondata, $actualquestiondata); code
3.summary: move question statistics code and db tables into the question bank so that they can be used by other modules that use questions
description: We will move both the code and db tables for calculating and caching question statistics into the question/engine/ directory.
4.summary: quiz_question_statistics_stats renamed to question_statistics_calculator, separate class question_statistics used to store calculated stats and api changed
description: API should be similar to question_response_analyser. question_statistics stores the stats for each question.
5.summary: consider modules where each usage might have different numbers of slots
description: A big issue is what to do in the general situation, where different usages may have different numbers of slots. (That would be the case if anyone every built a module like and I still hope that they will.) We may be able to calculate useful statisitics in this case.
6.summary: Handling slow question stats calculations
description: "We dont want the back-end code to do UI things like display a progress bar, however, we do want to be able to output progress information during slow calculations." "I think the right way to abstract it is to use the progress_trace class from weblib.php. We need to add a progress_bar_progress_trace subclass. If the slow calculations take a progress_trace (defaulting to a null_progress_trace), then the calling code can decide what sort of output is appropriate."
7.summary: consider making code that makes a flexible table from the data from tables like question_statistics generic
description: "There is a question whether the code that takes the data from tables like question_statistics, and returns a flexible_table (or even a more specific class like quiz_statistics_question_table) can usefully be made generic and shared. Potentially it could be, but I cannot tell off the top of my head. When thinking it through, we should be aware of this possibility."
8.summary: break down question stats by variant in a similar way to a random questions stats are broken down by sub question
description: For questions that have variants we will break down the question statistics by variant as well as showing the overall stats for that question. In the most complex case we will need to break down random questions into the actual question seen and then possibly further break down those results by variant.
9.summary: when breaking down stats for random questions and / or questions with variant we will limit the maximum number of variants or sub questions stats we will show
description: the max number of sub questions and variants combined shown in the report will be controlled by a constant that will default to 10. If more than that are found then we will show the stats for the question with the minimum, median and maximum facility index. In the downloaded spreadsheets all sub questions stats will be broken down and shown, within reason.
10.summary: for questions in each slot link to another page that shows stats for all sub questions and variants when the question has sub questions or variants
description: for those random questions or questions with variants for which there are stats for more sub questions than can be shown in the report we will link to a sub page.
11.summary: provide break down of question responses for each question variant
description: when listing the statistics of a question with variants the question name will link to analysis of the responses for that question variant.
12.summary: in response analysis we will provide the count of responses for each try of a question for question behaviours with multiple tries
description: the response analysis report will include columns with counts of which response was selected on which try. We will default to listing up to 5 tries but this will be controlled by a constant which can be changed.
13.summary: quiz and question statistics should be calculable for the first, last, or the highest attempt or for all attempts.
description: the report settings should default to calculate the stats based on the same attempt(s) as the gradebook grade is based on.
14.summary: separate out quiz statistics calculations from quiz statistics report
description: I also reworked the code to clarify it and make it more easily maintainable.
15.summary: Various coding style / phpdocs fixes required for new question statistics code
description: Reviewing it was detected that there were a bunch of both coding style and phpdocs details to fix here and there. List: (note surely any phpdoc warning under /tests directories) As far as that issue was the first in a long chain of issues and it was blocking a lot, it was agreed to make an exception and to delegate those fixes to another issue (aka, this one). So this is about to get all those problems annihilated.
16.summary: quiz statistics report - response analysis for questions with multiple tries : limit the breakdown of responses by tries to default to up to 4 tries and then 5+ tries
description: For adaptive questions types a student can take unlimited tries at a question but we need to have some limit on how many columns to show when breaking down what response was given in which try. In response analysis report we will default to have columns to count responses up to try 4 and then have a final column where responses given in any try more than that are counted.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Improvement to the quiz reports, especially the statistics
description: This is a set of changes requested by the OU. Jamie Pratt is implementing them.
### Response:
1.summary: Unit tests for quiz statistics report
description: We want to be able to unit test the quiz reports. This will involve populating the unit test db with test data. Using the data generator we want to be able : Create test instances of each sort of question type. Create a quiz from a set of questions. Supply attempt data for each of those question types. Build entire quiz attempts by supplying attempt data for each question in the quiz, pulling responses from a csv file. Compare the results generated to pre calculated stats for the responses. I will create sub tasks to track these tasks.
2.summary: introduce $form->mock_submit(); method to test form submission
description: A mock_submit method should make the form behave as if a submit button has been pressed and get_data should then return all the values as passed into the form from set_data and setDefault etc. So that we could perform the following integration test for example : code $questiondata = test_question_maker::get_question_data(multichoice, single); $expectedfromform = test_question_maker::get_question_form_data(multichoice, single); $form = new qtype_multichoice_edit_form(...); $form->set_data($questiondata); $form->mock_submit(); $actualfromform = $form->get_data(); $this->assertEquals($expectedfromform, $actualfromform); save_question($actualfromform); $actualquestiondata = question_load_questions(array($actualfromform->id)); $this->assertEquals($questiondata, $actualquestiondata); code
3.summary: move question statistics code and db tables into the question bank so that they can be used by other modules that use questions
description: We will move both the code and db tables for calculating and caching question statistics into the question/engine/ directory.
4.summary: quiz_question_statistics_stats renamed to question_statistics_calculator, separate class question_statistics used to store calculated stats and api changed
description: API should be similar to question_response_analyser. question_statistics stores the stats for each question.
5.summary: consider modules where each usage might have different numbers of slots
description: A big issue is what to do in the general situation, where different usages may have different numbers of slots. (That would be the case if anyone every built a module like and I still hope that they will.) We may be able to calculate useful statisitics in this case.
6.summary: Handling slow question stats calculations
description: "We dont want the back-end code to do UI things like display a progress bar, however, we do want to be able to output progress information during slow calculations." "I think the right way to abstract it is to use the progress_trace class from weblib.php. We need to add a progress_bar_progress_trace subclass. If the slow calculations take a progress_trace (defaulting to a null_progress_trace), then the calling code can decide what sort of output is appropriate."
7.summary: consider making code that makes a flexible table from the data from tables like question_statistics generic
description: "There is a question whether the code that takes the data from tables like question_statistics, and returns a flexible_table (or even a more specific class like quiz_statistics_question_table) can usefully be made generic and shared. Potentially it could be, but I cannot tell off the top of my head. When thinking it through, we should be aware of this possibility."
8.summary: break down question stats by variant in a similar way to a random questions stats are broken down by sub question
description: For questions that have variants we will break down the question statistics by variant as well as showing the overall stats for that question. In the most complex case we will need to break down random questions into the actual question seen and then possibly further break down those results by variant.
9.summary: when breaking down stats for random questions and / or questions with variant we will limit the maximum number of variants or sub questions stats we will show
description: the max number of sub questions and variants combined shown in the report will be controlled by a constant that will default to 10. If more than that are found then we will show the stats for the question with the minimum, median and maximum facility index. In the downloaded spreadsheets all sub questions stats will be broken down and shown, within reason.
10.summary: for questions in each slot link to another page that shows stats for all sub questions and variants when the question has sub questions or variants
description: for those random questions or questions with variants for which there are stats for more sub questions than can be shown in the report we will link to a sub page.
11.summary: provide break down of question responses for each question variant
description: when listing the statistics of a question with variants the question name will link to analysis of the responses for that question variant.
12.summary: in response analysis we will provide the count of responses for each try of a question for question behaviours with multiple tries
description: the response analysis report will include columns with counts of which response was selected on which try. We will default to listing up to 5 tries but this will be controlled by a constant which can be changed.
13.summary: quiz and question statistics should be calculable for the first, last, or the highest attempt or for all attempts.
description: the report settings should default to calculate the stats based on the same attempt(s) as the gradebook grade is based on.
14.summary: separate out quiz statistics calculations from quiz statistics report
description: I also reworked the code to clarify it and make it more easily maintainable.
15.summary: Various coding style / phpdocs fixes required for new question statistics code
description: Reviewing it was detected that there were a bunch of both coding style and phpdocs details to fix here and there. List: (note surely any phpdoc warning under /tests directories) As far as that issue was the first in a long chain of issues and it was blocking a lot, it was agreed to make an exception and to delegate those fixes to another issue (aka, this one). So this is about to get all those problems annihilated.
16.summary: quiz statistics report - response analysis for questions with multiple tries : limit the breakdown of responses by tries to default to up to 4 tries and then 5+ tries
description: For adaptive questions types a student can take unlimited tries at a question but we need to have some limit on how many columns to show when breaking down what response was given in which try. In response analysis report we will default to have columns to count responses up to try 4 and then have a final column where responses given in any try more than that are counted.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Moodle LMS / MoodleNet integration project - Phase 2
description: This epic follows on from the progress of , to expand the functionality available for teachers sharing content from Moodle LMS to MoodleNet, beyond the MVP scope of that original epic. The key persona in this phase of the project is teachers. . Key user stories The key user stories related to the teacher persona are: As a teacher, I can share the contents of a whole course as a Moodle backup file to MoodleNet, so others can import and use the course I have written. (Note: User/student data is not included). As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. As a teacher, I can select/deselect activities and resources when sharing a course to MoodleNet, so I can customise which course content is available to other MoodleNet users. (Note: User/student data is not included). Current teacher journey prototype| . "Nice to have" features for phase 2 - automatic cleanup of share progress so sent/error items are removed from the list once viewed. - sharing resources asynchronously. - validate connection before packaging. - allow URLs and files to be shared in their raw form (rather than as backups). . Future work / Out of scope The following milestone is currently beyond the scope of this project phase. Any updates to the existing implementation of MoodleNet to LMS functionality. This will likely be re-implemented to more closely integrate with the new LMS to MoodleNet functionality in a later project phase. Any improvements / features listed under the _MoodleNet integration - future phases_ epic ().
| Unsolvable | 1.summary: Allow teachers to share courses to MoodleNet (all activities)
description: This issue resolves the following user story: As a teacher, I can share the contents of a whole course as a Moodle backup file to MoodleNet, so others can import and use the course I have written. . Requirements A new capability, _moodle/moodlenet:sharecourse_, consistent with the existing shareactivity capability. Teacher has the ability to share a course from the course homepage. The implementation should build onto, and be consistent with, the existing activity sharing to MoodleNet. Modal UI will be consistent with activity sharing, since it relates to sharing the whole course as a backup. User/student data is not included, consistent with activity sharing. Behat/unit tests implemented as applicable. . Out of scope The ability to view and select/deselect individual activities from the course (this will be introduced by ).
2.summary: Add ability for teachers to customise courses shared to MoodleNet
description: This issue resolves the following user story: As a teacher, I can select/deselect activities and resources when sharing a course to MoodleNet, so I can customise which course content is available to other MoodleNet users. . Requirements Before sending, the teacher has the ability to select/deselect any activity/resource they wish. Only the selected items will form part of the course that is uploaded to MoodleNet. User/student data is not included. Note: Further requirements will be outlined prior to development commencing on this issue, following upcoming prototype refinements to ensure usability in courses with larger numbers of activities.
3.summary: Implement share progress page for content shared to MoodleNet
description: This issue resolves the following user story: As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. . Requirements -Teachers can access the share progress from their user dropdown menu.- To simplify the logic required (and improve performance), teachers can access the share progress from the _More_ menu within a course where they have the capability to share activities or courses. We need to create a new page to render this information. A table on the page including name (activity or course name), type (activity type or "Course"), send date, send status (Sent, In progress, Error). The table should be automatically sorted by send status (Error first, then In progress, then Sent), then by send date/time (newest first). For example, the most recent one to fail/error would be the first item at the top of the list. When a share has completed successfully, the resource name should become a hyperlink to the MoodleNet resources draft URL. Include pagination, wont always be required, but will be useful in cases where someone shares a lot before checking back on the list. Possibly 25 items per page would be ideal. Ensure there is an appropriate zero state (an indication on the page when there are no shares to view). Before allowing this new page to render successfully and attempt to fetch any data, we should check that the visiting user is logged in, not a guest, and has at least one of the relevant activity/course sharing capabilities (in any context) before allowing the page to render (with appropriate caching). This is to avoid having a page which can be directly accessed by a user when its not possible to reach it via the UI. Behat/unit tests implemented as applicable. The information required to fulfill requirements 3-4 will be available once is implemented. . Out of scope Clean up/clearing of the share progress data. This will be implemented in . User filtering/sorting of table data. With requirement 4 in place, priority information will be surfaced, and with the above cleanup implemented, the data listed will be temporary. Accessing the share progress from the share modal (this will need to be implemented as part of ). Ability to expand a course shares to view activity details - this is a high level overview of recent upload progress, so granular details are not required. Linking to the relevant activity/course within the LMS. Granular progress updates (eg upload percentage that are more detailed than the listed requirements). Any content relating to MN => Moodle transfers. . Prototype Figma prototype |
4.summary: Record MoodleNet share progress data in a consumable format
description: In order for a teacher to be able to view the send progress/status of activities and courses they have shared to MoodleNet, first there must be a way to store that data in a way that it can be easily processed and rendered in the UI. It is critical that this information is available before we are able to move sharing to MoodleNet from a synchronous process to asynchronous. Although involves standard logging of shares to MoodleNet via admin logs, this issue relates to storing key information about what was shared and the current send status so that it can be easily fetched and presented to teachers in a MoodleNet share progress list (the page that makes this information available to teachers will be implemented in a follow up issue). . Requirements Create a new share progress API in core\moodlenet, which in this phase will be responsible for storing and updating the information in the database. This will include recording basic information at the time the sharing is initiated (where the status is in progress), as well as performing updates to reflect changes in status (sent/error) and any pertinent information received from MoodleNet (such as the resource URL). Implement the relevant database table to store the data in a forwards compatible way (see DB tables section below for more details). Detailed "snapshots" of what has been shared (eg activity/course names) are not required (see out of scope section below). Check if any of the data being stored constitutes user data, which may require some additions to the privacy provider. During investigation of this issue, we should also look into other options that may be available, eg events hook when the "normal" logging is being called. . DB tables To be compatible with planned functionality, this will need a table created to record the initial ID details of what is shared and by who, as well as some details from MoodleNet, as outlined below. ID (PK, incremented). Course ID. LMS user ID that performed the share. Share type (which can be an int that maps to a constant). For this phase, activity or course backup are the only options. It may be possible to use this to indicate URL or raw file in future as well if/when implemented. LMS activity/resource ID (eg cmid) - this will need to be optional because it will remain empty for course sharing. MoodleNet resource URL. Time created timestamp (when the share is first requested). Status (can map to an int constant for send statuses of error, in progress or sent status). This will initially be inserted as in progress when a share is first executed. . User stories This issue does not directly address any user stories. It does however lay the initial foundation for future functionality which will address the following user story: As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. . Out of scope Implementing any UI to share this information with users (this is covered by other issues). A way to fetch data from the API. This will be implemented alongside the UI. Implementing system/admin level logging (which is already covered as part of the API). Archiving or removing old entries. This will be linked to users viewing the content, so will be completed in a follow up. Recording detailed information/names for activities/courses being shared. As the key focus is to keep a short term history of whether a share is in progress, sent or an error occurred, we can also assume that in most cases the content will still exist when the teacher views the status information, so a complete "snapshot" is unnecessary. We also do not need to record which activities are included in a course share, it will be sufficient for us to be able to identify which course was shared (whether in whole or part).
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Moodle LMS / MoodleNet integration project - Phase 2
description: This epic follows on from the progress of , to expand the functionality available for teachers sharing content from Moodle LMS to MoodleNet, beyond the MVP scope of that original epic. The key persona in this phase of the project is teachers. . Key user stories The key user stories related to the teacher persona are: As a teacher, I can share the contents of a whole course as a Moodle backup file to MoodleNet, so others can import and use the course I have written. (Note: User/student data is not included). As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. As a teacher, I can select/deselect activities and resources when sharing a course to MoodleNet, so I can customise which course content is available to other MoodleNet users. (Note: User/student data is not included). Current teacher journey prototype| . "Nice to have" features for phase 2 - automatic cleanup of share progress so sent/error items are removed from the list once viewed. - sharing resources asynchronously. - validate connection before packaging. - allow URLs and files to be shared in their raw form (rather than as backups). . Future work / Out of scope The following milestone is currently beyond the scope of this project phase. Any updates to the existing implementation of MoodleNet to LMS functionality. This will likely be re-implemented to more closely integrate with the new LMS to MoodleNet functionality in a later project phase. Any improvements / features listed under the _MoodleNet integration - future phases_ epic ().
### Response:
1.summary: Allow teachers to share courses to MoodleNet (all activities)
description: This issue resolves the following user story: As a teacher, I can share the contents of a whole course as a Moodle backup file to MoodleNet, so others can import and use the course I have written. . Requirements A new capability, _moodle/moodlenet:sharecourse_, consistent with the existing shareactivity capability. Teacher has the ability to share a course from the course homepage. The implementation should build onto, and be consistent with, the existing activity sharing to MoodleNet. Modal UI will be consistent with activity sharing, since it relates to sharing the whole course as a backup. User/student data is not included, consistent with activity sharing. Behat/unit tests implemented as applicable. . Out of scope The ability to view and select/deselect individual activities from the course (this will be introduced by ).
2.summary: Add ability for teachers to customise courses shared to MoodleNet
description: This issue resolves the following user story: As a teacher, I can select/deselect activities and resources when sharing a course to MoodleNet, so I can customise which course content is available to other MoodleNet users. . Requirements Before sending, the teacher has the ability to select/deselect any activity/resource they wish. Only the selected items will form part of the course that is uploaded to MoodleNet. User/student data is not included. Note: Further requirements will be outlined prior to development commencing on this issue, following upcoming prototype refinements to ensure usability in courses with larger numbers of activities.
3.summary: Implement share progress page for content shared to MoodleNet
description: This issue resolves the following user story: As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. . Requirements -Teachers can access the share progress from their user dropdown menu.- To simplify the logic required (and improve performance), teachers can access the share progress from the _More_ menu within a course where they have the capability to share activities or courses. We need to create a new page to render this information. A table on the page including name (activity or course name), type (activity type or "Course"), send date, send status (Sent, In progress, Error). The table should be automatically sorted by send status (Error first, then In progress, then Sent), then by send date/time (newest first). For example, the most recent one to fail/error would be the first item at the top of the list. When a share has completed successfully, the resource name should become a hyperlink to the MoodleNet resources draft URL. Include pagination, wont always be required, but will be useful in cases where someone shares a lot before checking back on the list. Possibly 25 items per page would be ideal. Ensure there is an appropriate zero state (an indication on the page when there are no shares to view). Before allowing this new page to render successfully and attempt to fetch any data, we should check that the visiting user is logged in, not a guest, and has at least one of the relevant activity/course sharing capabilities (in any context) before allowing the page to render (with appropriate caching). This is to avoid having a page which can be directly accessed by a user when its not possible to reach it via the UI. Behat/unit tests implemented as applicable. The information required to fulfill requirements 3-4 will be available once is implemented. . Out of scope Clean up/clearing of the share progress data. This will be implemented in . User filtering/sorting of table data. With requirement 4 in place, priority information will be surfaced, and with the above cleanup implemented, the data listed will be temporary. Accessing the share progress from the share modal (this will need to be implemented as part of ). Ability to expand a course shares to view activity details - this is a high level overview of recent upload progress, so granular details are not required. Linking to the relevant activity/course within the LMS. Granular progress updates (eg upload percentage that are more detailed than the listed requirements). Any content relating to MN => Moodle transfers. . Prototype Figma prototype |
4.summary: Record MoodleNet share progress data in a consumable format
description: In order for a teacher to be able to view the send progress/status of activities and courses they have shared to MoodleNet, first there must be a way to store that data in a way that it can be easily processed and rendered in the UI. It is critical that this information is available before we are able to move sharing to MoodleNet from a synchronous process to asynchronous. Although involves standard logging of shares to MoodleNet via admin logs, this issue relates to storing key information about what was shared and the current send status so that it can be easily fetched and presented to teachers in a MoodleNet share progress list (the page that makes this information available to teachers will be implemented in a follow up issue). . Requirements Create a new share progress API in core\moodlenet, which in this phase will be responsible for storing and updating the information in the database. This will include recording basic information at the time the sharing is initiated (where the status is in progress), as well as performing updates to reflect changes in status (sent/error) and any pertinent information received from MoodleNet (such as the resource URL). Implement the relevant database table to store the data in a forwards compatible way (see DB tables section below for more details). Detailed "snapshots" of what has been shared (eg activity/course names) are not required (see out of scope section below). Check if any of the data being stored constitutes user data, which may require some additions to the privacy provider. During investigation of this issue, we should also look into other options that may be available, eg events hook when the "normal" logging is being called. . DB tables To be compatible with planned functionality, this will need a table created to record the initial ID details of what is shared and by who, as well as some details from MoodleNet, as outlined below. ID (PK, incremented). Course ID. LMS user ID that performed the share. Share type (which can be an int that maps to a constant). For this phase, activity or course backup are the only options. It may be possible to use this to indicate URL or raw file in future as well if/when implemented. LMS activity/resource ID (eg cmid) - this will need to be optional because it will remain empty for course sharing. MoodleNet resource URL. Time created timestamp (when the share is first requested). Status (can map to an int constant for send statuses of error, in progress or sent status). This will initially be inserted as in progress when a share is first executed. . User stories This issue does not directly address any user stories. It does however lay the initial foundation for future functionality which will address the following user story: As a teacher, I need the ability to view the current send status of content I have recently shared to MoodleNet from the current Moodle site, so that I know when I can visit the respective MoodleNet draft to complete and publish the resource. . Out of scope Implementing any UI to share this information with users (this is covered by other issues). A way to fetch data from the API. This will be implemented alongside the UI. Implementing system/admin level logging (which is already covered as part of the API). Archiving or removing old entries. This will be linked to users viewing the content, so will be completed in a follow up. Recording detailed information/names for activities/courses being shared. As the key focus is to keep a short term history of whether a share is in progress, sent or an error occurred, we can also assume that in most cases the content will still exist when the teacher views the status information, so a complete "snapshot" is unnecessary. We also do not need to record which activities are included in a course share, it will be sufficient for us to be able to identify which course was shared (whether in whole or part).
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: User should be able to configure settings on a separate page
description: User should be able to configure settings on a separate page.
| Solvable | 1.summary: Move language selector to settings page
description: Create a separate settings page, instead of a modal.
2.summary: Link to Code of Conduct from user drop-down menu
description: As we are removing the current home page text when we launch Beta v0.1 we need somewhere for the Code of Conduct to live: Note that this is a temporary place for the Code of Conduct, as when we open registrations / have federated instances, users will have to agree to Terms of Service.
3.summary: Move settings from modal to separate page
description: Settings are currently in a modal, accessible from the user drop-down menu. This should be a separate page to hold more options.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: User should be able to configure settings on a separate page
description: User should be able to configure settings on a separate page.
### Response:
1.summary: Move language selector to settings page
description: Create a separate settings page, instead of a modal.
2.summary: Link to Code of Conduct from user drop-down menu
description: As we are removing the current home page text when we launch Beta v0.1 we need somewhere for the Code of Conduct to live: Note that this is a temporary place for the Code of Conduct, as when we open registrations / have federated instances, users will have to agree to Terms of Service.
3.summary: Move settings from modal to separate page
description: Settings are currently in a modal, accessible from the user drop-down menu. This should be a separate page to hold more options.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Integrate a customizable report builder into core
description: This Epic is intended to support the Learning Analytics roadmap, specifically Implement UI for creating and editing learning analytics models. However, there are other benefits for the Moodle community, as described below. A general purpose reporting tool is one of the most commonly requested features in Moodle. A previous effort () sought to integrate the Totara Report Builder into core. That effort was never completed. Meanwhile, development in Configurable Reports has continued, but has been slow to keep pace with new Moodle releases. Either of these code bases could provide a good starting point for a built-in report tool. The analysis that follows is based on Configurable Reports, but the needs are similar whether or not this is the starting code base. Configurable Reports provides both a form-based report creator and support for SQL reports. This carries some potential risks, addressed below. The form-based report tool is able to use the Moodle API to access the proper data elements, rather than relying on direct SQL which might return the wrong value (e.g. final grades). The necessary enhancements to the existing supported report structures are also addressed below and in attached issues. Finally, Configurable Reports was originally a fork of Ad-Hoc Queries (customsql), a tool which is only available to administrators (whereas Configurable Reports allows reports to be made available based on Moodle roles and permissions). One feature of Ad-Hoc Queries that should be re-merged to Configurable Reports, however, is the ability to run a report on a schedule (e.g. off-peak hours) and archive it for immediate viewing on demand. This feature also allows reports to be sent to a distribution list via email. Again, security issues are addressed below. The attached recommendations for enhancements are based on an analysis of existing core Moodle reports, as well as commonly used reports in the Ad-Hoc Queries Contributed Reports page ( and commonly asked questions on the Analytics and Reporting forum on moodle.org ( Note that a previous analysis determined the following challenges to integrating Configurable Reports: It must be converted to an admin tool The underlying API should be rebuilt to do proper JOINS with tables and use existing APIs when possible A performance analysis must be implemented A plugin compatibility / API must be developed (so plugins can expose their data to the builder) The UX must be improved The current SQL queries option should be disabled by default (for security) According to Adrian and John analysis two years ago it would be better to just do something new following Totara approach Moodle for Workplace will implement a report builder (not sure about the plans for it, if its something meant for core as well or something to be delivered as an extra-value for paid subscriptions) Some of these issues have already been noted below.
| Unsolvable | 1.summary: Custom Reports should use Moodle API whenever possible
description: Use only Moodle API: the forms-based function of Configurable Reports should use the Moodle API to retrieve data whenever possible, not direct database access. E.g. for grades, use grade_get_course_grade($user->id, $courseid) When there is no defined API, it should be ok to use something like $DB->get_record(course, array(id => $courseid), , MUST_EXIST);
2.summary: Custom reporting tool makes output available for Moodle Learning Analytics
description: Available for analytics: This option makes the report available for use in the Moodle Learning Analytics feature. Within the Learning Analytics tool, specific columns will be identified as the Target, Indicators, and Time Splitting Value. As a minimum viable feature, a reporting tool must make a plain-text CSV (Comma-separated values) version of the report available on demand via URL, while respecting role-based security.
3.summary: Support simple common joins in Configurable Reports
description: Easier joining of report types: Currently joins are constructed by embedding one report within another. Provide a new tab allowing commonly desired related tables to be added to a report with predefined joins. _Example_: certain values, like the roles a user has in a course or the groups a user is in, are so commonly requested that they should be defined as objects that can be selected as columns. _Example_: Course modules are often joined via module type to module tables. This should be an easy selection in the report. _Specific instance_: Support Scales by allowing for substitution of Scale value for any integer
4.summary: Group/Break feature for Configurable Reports
description: Group/Break feature: allow results to be grouped by one or more columns and allow selection of aggregation function per column, including Sum, Mean, Min, Max, StdDev, Percentile, Concatenate, Concatenate Distinct. Break feature retains individual rows and provides a summary row per grouping level. Specific example: Multi-value cell: if multiple values apply to a row, e.g. multiple roles for a participant, there should be an option to display all of them in a delimited list within the cell. Groups based on calculated value allow construction of histogram reports. E.g. create a column for time of day and round timestamps to hour values, stripping off date information. This becomes the group value. Then use a COUNT() calculation for log entries. This creates a histogram of site activity per hour of the day over the selected timespan. Group with aggregate calculations is a critical feature for learning analytics. Indicators and targets must be scaled to convert to a value between -1 and 1. Scaling options should include: Percentile (based on current report results) Manual min/max, logarithmic distribution Manual min/max, linear distribution Manual classifier (conditional function transforming integers to categorical values - binary classifier is just a specific example of this)
5.summary: Configurable Reports calculated column type
description: Cell calculations: Within a row, allow a calculated value, e.g. the addition of values from two supported numerical columns. Support regular arithmetic operations as well as Min/Max and concatenation. Support date math and useful constants/functions such as currenttime.
6.summary: Configurable Reports row limit feature
description: Limit: allow form-based reports to have a defined limit for number of rows returned (in addition to the current safety limit). Allow an option (on by default) to display this limit on the report results.
7.summary: Configurable Reports random sample tool
description: Random sample tool: allow a report to be run on a random sample of data (rather than just the first n values in the database), using the limit. Very valuable for testing large reports, especially for Learning Analytics.
8.summary: Display Configurable Reports results as popup
description: Display report as popup: Certain reports are currently displayed as modal popups over the current page, rather than directing the user to a new page. Perhaps this could be triggered by a URL parameter, if enabled for the report.
9.summary: Configurable Reports additional information on "Report" tab
description: Report summary tab: Provide additional information on the Report tab summarizing all options selected on the other tabs (not SQL).
10.summary: Multipurpose filter in Configurable Reports
description: Multipurpose Filter: This is a filter similar to the one in Participants. It allows free text entry which is used to search any text field, a pulldown menu list of categorical data options (e.g. roles, groups) (these should be configured as selected categorical columns on report editing) certain timeline options (these should be configured by column and time interval on report editing)
11.summary: Lookback filter in Configurable Reports
description: Lookback filter: This is applicable to timeline reports and some other reports that specify a datetime column. The filter should be configured by column and time interval on report creation/editing.
12.summary: Alphabet filter in Configurable Reports
description: Alphabet filter: This displays the alphabet in the report header and provides filtering by the first letter of the alphabet (where applicable by language) for the defined column. (The column should be defined when creating/editing the report.)
13.summary: Distinct values filter in Configurable Reports
description: This filter displays all the distinct values from a column of data in a pull-down menu, defaulting to "Any" Variation: Two-column combined distinct values filter: If the distinct values in two columns are both limited, sometimes it is helpful to combine the two sets of values into a single filter (All A, All X, A and X, B and X, A and Y, etc.) See the Statistics report for an example of such a filter.
14.summary: Set filter(s) before executing Configurable Report
description: Currently when the Report page is visited in Configurable Reports, the report attempts to execute before filter values have been set, which can return very large record sets (and may time out). This provides a new report option to delay attempting to retrieve report results until filters have been set.
15.summary: Include filter selections as text in Configurable Report header
description: Include filter selections in report header (filter option): This is especially important when multiple values can be selected. It also makes the filter selections printable.
16.summary: Select row/Bulk action feature in Configurable Reports
description: Select row/Bulk action feature: This option would be added to the report while editing, and available actions would be chosen from a list. Available actions should be controlled by the report type (e.g. User, Course). These actions should be reusable in learning analytics Insights. If Group/Break report is being used, allow selection/action by groups or by rows.
17.summary: Configurable Reports edit row/action menu feature
description: Edit row/action menu feature: Add an "action" menu to the end of each row. The list of actions per row should be the same as the list of bulk actions in the bulk action feature ().
18.summary: Edit column/action menu for Configurable Reports
description: Edit column/action menu: as with Edit row/action menu (), but for a column. Primarily useful for crosstab reports.
19.summary: Conditional cell styling in Configurable Reports
description: Conditional cell styling: allow contents of cell to be styled depending on value in that cell or another cell in the same row. This includes, but is not limited to: setting character color, setting background color, bold and italic style, replacement of predefined values with icons (using FontAwesome). This is especially useful for heatmap reports of course activity usage or in crosstab reports to call out unusual values. Specific example: allow display of Module icon in place of Module type. Example 2: display avatar image for a given user id. Example 3: Display a value in red if it exceeds a predefined limit.
20.summary: Support use of localization text strings in Configurable Reports
description: This proposal has two parts: Reports can be made more localizable by allowing the definition of text strings which will appear in the language editor (e.g. column names). Reports constructed in Configurable Reports should be able to display localized text strings (by text string name), e.g. in column names or status values.
21.summary: Allow inclusion of hidden columns in Configurable Reports results
description: Hidden columns: draw data from columns, but do not display in report (for use in chart-only reports, cell calculations and conditional styling)
22.summary: Display Configurable Reports with "frozen" header row(s) and left column(s).
description: Frozen column(s): Allow n left-most (or right-most, in RTL languages) to be defined as frozen , such that they remain visible when horizontally scrolling. Frozen header row(s): Allow n top-most rows to be defined as frozen such that they remain visible at the top of the page area while vertically scrolling. Frozen footer row(s): allow summary calculation rows to be frozen at the bottom of the page area when scrolling
23.summary: Configurable Reports column output as microchart
description: Output as microchart: Allow one or more columns to be combined and displayed as a microchart. Combine with Group/Break feature to provide sparkline embedded line graphs. Implement using charts.js (assuming that is still the selected chart library at the time of implementation). Example: Users report contains Events (see Joining, below). Condition: Event CRUD = C. Group report by User, select CRUD and Timecreated columns and combine as linechart. Now a small line chart of user activity shows on each row next to the user name.
24.summary: Configurable Reports edit cell option
description: Edit cell option: if the user has permissions to edit a value, enabling this option for a column will cause an edit icon (currently the pencil) to appear next to the value in the cell. If the values are restricted to a list, display the list as a pulldown menu. This may be enabled as a separate mode, switched on with a button in the header of the report.
25.summary: Provide URL link to related report in Configurable Reports
description: URL Link to related report: To configure this column, select the other report (must already exist) and provide the linking column(s) of data for each parameter the report accepts. Allow this to be presented in the report as an existing column in the report (e.g. the linking data value), or free text (could include an icon using FontAwesome).
26.summary: Allow Configurable Reports to receive URL parameters
description: Receive URL parameters: Define URL parameters that can be accepted when this report is run, and attach them to either Conditions (invisible in report results or displayed in header only) or Filters (can be modified after the report is run).
27.summary: Option to "return" to previous page from Configurable Reports
description: Return buttons: When viewing a report, record the page the user arrived from. A Return button should be a default option to return the user to their previous page.
28.summary: Support crosstab reports in Configurable Reports
description: Crosstab reports: Select two primary report types and create a matrix of calculated values. _Example_: The number of courses each teacher is assigned to in each Course Category. (Number of teachers and number of categories are both variable.) Example 2: The students in a course are listed as rows. The competencies attached to the course are columns. Each cell contains the current status of that student in that competency. Bonus: enable Chi Square option to look for unusual cells and highlight them.
29.summary: Manually order Configurable Reports results and save order for next execution
description: Manually reorder report results and save new order for next execution: provide drag and drop crosshairs to reorder results of a report to a custom order, and save custom order to user or to context.
30.summary: On-screen help for all display elements in Configurable Reports
description: On-screen help for all display elements: Filters, column headers, charts, and other components of reports should have help available, either on mouse rollover or via info button next to the element. When reports are constructed, this help text can be manually added for columns if there is not already help text available for that data element.
31.summary: Configurable Reports progress bar and error handling
description: Display a progress bar while report is running. If report times out or returns an error, display that result in the same page, rather than dumping the user to an ungraceful generic error page with no "back" alternative.
32.summary: New chart types/options for Configurable Reports
description: New chart types/options: Currently three chart types are supported: bar, pie, and line (timeline only). Bar charts allow vertical bars only. Pie charts are all 3D pies, which are even more difficult to read accurately than ordinary pie charts. Since Moodle is using Chart.js, more chart types should be easy to support, including parameters to style charts: Bar Horizontal bar Stacked vertical and horizontal bar (grouped reports) Progress bar (course progress, not report progress) (could also be done with a styled crosstab report) Radar - valuable for cyclical data and profile characteristics Donut/Pie - these are just more options for pie charts. Currently used on Dashboard report. Good for displaying rough proportions, but note that a number of studies have shown that humans have difficulty estimating and comparing angular wedge values. Polar Area - valuable for cyclical data (e.g. day of week or month of year) Bubble (crosstab, multiple level groups) Bar-whisker/Candlestick (May require plugin, e.g. chartjs-chart-financial| needed for Survey report) Scatterplot (crosstab data) Tree map chart (much easier to read accurately than pie charts, but does not seem to be included in Chart.js) Mixed - this could be a later addition (needed for Survey activity report) but is also helpful for adding a trend line to a scatterplot Animated charts - supported in Charts.js, valuable for time series data (and looks very shiny)
33.summary: Enable Configurable Reports to schedule execution, archive results, and automatically distribute
description: Scheduled execution/archive & distribute: (as in Ad-Hoc Queries) run reports on a schedule auto-email or Moodle Notify results, and/or archive the results for fast access between runs
34.summary: Text editor filter codes for report output
description: Text editor filters for report output: allow report results to appear in a text field (e.g. a Page, a Label, a Lesson, etc.). Allow certain values and summary calculations and charts to be selected during report editing and token filters to be created for embedding in text. Pass context of element automatically to report (e.g. if the filter code is being displayed in a Label, pass the Course in which the Label appears as the context, and also pass the current User). Ideally a plugin for ATTO would show the list of available reports that can be embedded in this way. Example: Show chart of percentage of students who have completed the course in a Label or HTML block Example: Display first name of current user in text on the first page of a Lesson
35.summary: Control SQL feature of Configurable Reports via config.php setting
description: Because the custom SQL feature of Configurable Reports can cause extremely heavy load on a Moodle site and can even result in a loss of data if available space is exceeded, many hosting organizations may wish to disable access to it, even to site administrators. This option would allow access to the custom SQL tab in Configurable Reports to be disabled from the config.php file.
36.summary: Configurable Reports must respect roles and capabilities when allowing access to data
description: When using APIs to access data in Moodle, Configurable Reports should respect applicable capabilities, contexts, and role assignments of the person viewing the report. Graceful failure should allow a report to be viewed with blanks for data the user does not have permission to see, with an annotation.
37.summary: Integrate custom report builder with Database module
description: Any custom report builder included in Moodle should be available for use with the Database activity module, for ease of creating/replacing "list" templates.
38.summary: Provide pivot table feature in customisable report builder and other reports in Moodle core
description: We could dramatically improve functionality of many Moodle reports by adding pivot table capability. This package is an open source, React-based pivot table library: It includes many visualisation tools, as well. It would be especially helpful to have this as part of a customisable report builder, but it would also benefit log/event reports and other reports that contain interrelated data. (There is an older version that uses JQuery instead of React, as well.)
39.summary: Report Builder needs additional data sources
description: The "Report builder" developed as part of the Workplace project provides a form-based way to develop custom reports. However, as originally developed, it supports a limited number of Data sources. (Data sources identify the primary table the report will be based on. Other tables joined to the primary table may be included in the data source as "Tables" in the report builder.) Increasing the number of Data sources will allow greater use of the Report builder, eventually allowing all reports included in Moodle (all versions) to be based on the Report builder, and therefore customisable. Data sources currently included in Workplace: Certification users allocation and completion: User certification allocation, User certification completion, Certification, User, Job assignments, Program Certifications: Program, User allocation, User, Course (JOINed by Program) Programs: Course, User Program users allocation and completion: Program, User allocation, User program completion, User, Job assignments Course completion from datastore: Datastore action (Time completed), Course from datastore, User from datastore, Course completion, User, Course Users: Job assignments The data sources suggested below are based on analysis of user-created reports (e.g. using Ad-hoc queries or Configurable reports), existing reports provided in core, and popular reporting plugins. The primary table is given first, followed by additional tables that are often JOINed to the primary table in existing reports. New data sources: Events/Log activity: Users (mediated by Role assignments and Enrolments), Courses, Course modules, Role assignments, Roles (full name of Role) Gradebook: Grades, Gradebook categories, Course modules, User, Groups, Advanced grading _Note: this is an example of a type of report that could benefit from having editable fields_ Course modules (Activities and Resources): Log activity, Activity completion, Grades Competencies: Courses, Course modules, Users, Course categories Course completion: Enrolments, Users, Courses, Course modules Specific Module types for Core modules (especially Quiz, Assignment, Forum) Course categories: Courses, Enrolments, Role assignments Groups: Users, Events (often filtered by the Course in which the report is run) Course: Course Metadata, Course format, Users (mediated by Role assignments), Enrolments (mediated by Users+Role assignments), Course categories, Course completions User enrolments: User last access, Role assignments/Role, User, Course Time spent in course: This is a special variation of the Course data source that allows the report user to specify the session time (how long a session is assumed to extend after the last logged event), and this value is provided as "Time spent" for all users who access the Course, filterable by Role assignment. Users enroled but not logged in: This Data source requires a LEFT JOIN (if implemented in SQL) to pick up Enrolments in a Course that do NOT have any log activity. Otherwise it resembles "Events/Log activity" above. Communications: Course, Users (linked to Course via Role assignment), various sources of communications between users, e.g.: Messages, Feedback (from Gradebook), Forum (read or reply), Assignment (annotations) (In Configurable Reports, data sources are called report types. In Totara Report Builder, these are called "Sources." Existing report types in CR are Users, Courses, Categories, and Timeline.)
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Integrate a customizable report builder into core
description: This Epic is intended to support the Learning Analytics roadmap, specifically Implement UI for creating and editing learning analytics models. However, there are other benefits for the Moodle community, as described below. A general purpose reporting tool is one of the most commonly requested features in Moodle. A previous effort () sought to integrate the Totara Report Builder into core. That effort was never completed. Meanwhile, development in Configurable Reports has continued, but has been slow to keep pace with new Moodle releases. Either of these code bases could provide a good starting point for a built-in report tool. The analysis that follows is based on Configurable Reports, but the needs are similar whether or not this is the starting code base. Configurable Reports provides both a form-based report creator and support for SQL reports. This carries some potential risks, addressed below. The form-based report tool is able to use the Moodle API to access the proper data elements, rather than relying on direct SQL which might return the wrong value (e.g. final grades). The necessary enhancements to the existing supported report structures are also addressed below and in attached issues. Finally, Configurable Reports was originally a fork of Ad-Hoc Queries (customsql), a tool which is only available to administrators (whereas Configurable Reports allows reports to be made available based on Moodle roles and permissions). One feature of Ad-Hoc Queries that should be re-merged to Configurable Reports, however, is the ability to run a report on a schedule (e.g. off-peak hours) and archive it for immediate viewing on demand. This feature also allows reports to be sent to a distribution list via email. Again, security issues are addressed below. The attached recommendations for enhancements are based on an analysis of existing core Moodle reports, as well as commonly used reports in the Ad-Hoc Queries Contributed Reports page ( and commonly asked questions on the Analytics and Reporting forum on moodle.org ( Note that a previous analysis determined the following challenges to integrating Configurable Reports: It must be converted to an admin tool The underlying API should be rebuilt to do proper JOINS with tables and use existing APIs when possible A performance analysis must be implemented A plugin compatibility / API must be developed (so plugins can expose their data to the builder) The UX must be improved The current SQL queries option should be disabled by default (for security) According to Adrian and John analysis two years ago it would be better to just do something new following Totara approach Moodle for Workplace will implement a report builder (not sure about the plans for it, if its something meant for core as well or something to be delivered as an extra-value for paid subscriptions) Some of these issues have already been noted below.
### Response:
1.summary: Custom Reports should use Moodle API whenever possible
description: Use only Moodle API: the forms-based function of Configurable Reports should use the Moodle API to retrieve data whenever possible, not direct database access. E.g. for grades, use grade_get_course_grade($user->id, $courseid) When there is no defined API, it should be ok to use something like $DB->get_record(course, array(id => $courseid), , MUST_EXIST);
2.summary: Custom reporting tool makes output available for Moodle Learning Analytics
description: Available for analytics: This option makes the report available for use in the Moodle Learning Analytics feature. Within the Learning Analytics tool, specific columns will be identified as the Target, Indicators, and Time Splitting Value. As a minimum viable feature, a reporting tool must make a plain-text CSV (Comma-separated values) version of the report available on demand via URL, while respecting role-based security.
3.summary: Support simple common joins in Configurable Reports
description: Easier joining of report types: Currently joins are constructed by embedding one report within another. Provide a new tab allowing commonly desired related tables to be added to a report with predefined joins. _Example_: certain values, like the roles a user has in a course or the groups a user is in, are so commonly requested that they should be defined as objects that can be selected as columns. _Example_: Course modules are often joined via module type to module tables. This should be an easy selection in the report. _Specific instance_: Support Scales by allowing for substitution of Scale value for any integer
4.summary: Group/Break feature for Configurable Reports
description: Group/Break feature: allow results to be grouped by one or more columns and allow selection of aggregation function per column, including Sum, Mean, Min, Max, StdDev, Percentile, Concatenate, Concatenate Distinct. Break feature retains individual rows and provides a summary row per grouping level. Specific example: Multi-value cell: if multiple values apply to a row, e.g. multiple roles for a participant, there should be an option to display all of them in a delimited list within the cell. Groups based on calculated value allow construction of histogram reports. E.g. create a column for time of day and round timestamps to hour values, stripping off date information. This becomes the group value. Then use a COUNT() calculation for log entries. This creates a histogram of site activity per hour of the day over the selected timespan. Group with aggregate calculations is a critical feature for learning analytics. Indicators and targets must be scaled to convert to a value between -1 and 1. Scaling options should include: Percentile (based on current report results) Manual min/max, logarithmic distribution Manual min/max, linear distribution Manual classifier (conditional function transforming integers to categorical values - binary classifier is just a specific example of this)
5.summary: Configurable Reports calculated column type
description: Cell calculations: Within a row, allow a calculated value, e.g. the addition of values from two supported numerical columns. Support regular arithmetic operations as well as Min/Max and concatenation. Support date math and useful constants/functions such as currenttime.
6.summary: Configurable Reports row limit feature
description: Limit: allow form-based reports to have a defined limit for number of rows returned (in addition to the current safety limit). Allow an option (on by default) to display this limit on the report results.
7.summary: Configurable Reports random sample tool
description: Random sample tool: allow a report to be run on a random sample of data (rather than just the first n values in the database), using the limit. Very valuable for testing large reports, especially for Learning Analytics.
8.summary: Display Configurable Reports results as popup
description: Display report as popup: Certain reports are currently displayed as modal popups over the current page, rather than directing the user to a new page. Perhaps this could be triggered by a URL parameter, if enabled for the report.
9.summary: Configurable Reports additional information on "Report" tab
description: Report summary tab: Provide additional information on the Report tab summarizing all options selected on the other tabs (not SQL).
10.summary: Multipurpose filter in Configurable Reports
description: Multipurpose Filter: This is a filter similar to the one in Participants. It allows free text entry which is used to search any text field, a pulldown menu list of categorical data options (e.g. roles, groups) (these should be configured as selected categorical columns on report editing) certain timeline options (these should be configured by column and time interval on report editing)
11.summary: Lookback filter in Configurable Reports
description: Lookback filter: This is applicable to timeline reports and some other reports that specify a datetime column. The filter should be configured by column and time interval on report creation/editing.
12.summary: Alphabet filter in Configurable Reports
description: Alphabet filter: This displays the alphabet in the report header and provides filtering by the first letter of the alphabet (where applicable by language) for the defined column. (The column should be defined when creating/editing the report.)
13.summary: Distinct values filter in Configurable Reports
description: This filter displays all the distinct values from a column of data in a pull-down menu, defaulting to "Any" Variation: Two-column combined distinct values filter: If the distinct values in two columns are both limited, sometimes it is helpful to combine the two sets of values into a single filter (All A, All X, A and X, B and X, A and Y, etc.) See the Statistics report for an example of such a filter.
14.summary: Set filter(s) before executing Configurable Report
description: Currently when the Report page is visited in Configurable Reports, the report attempts to execute before filter values have been set, which can return very large record sets (and may time out). This provides a new report option to delay attempting to retrieve report results until filters have been set.
15.summary: Include filter selections as text in Configurable Report header
description: Include filter selections in report header (filter option): This is especially important when multiple values can be selected. It also makes the filter selections printable.
16.summary: Select row/Bulk action feature in Configurable Reports
description: Select row/Bulk action feature: This option would be added to the report while editing, and available actions would be chosen from a list. Available actions should be controlled by the report type (e.g. User, Course). These actions should be reusable in learning analytics Insights. If Group/Break report is being used, allow selection/action by groups or by rows.
17.summary: Configurable Reports edit row/action menu feature
description: Edit row/action menu feature: Add an "action" menu to the end of each row. The list of actions per row should be the same as the list of bulk actions in the bulk action feature ().
18.summary: Edit column/action menu for Configurable Reports
description: Edit column/action menu: as with Edit row/action menu (), but for a column. Primarily useful for crosstab reports.
19.summary: Conditional cell styling in Configurable Reports
description: Conditional cell styling: allow contents of cell to be styled depending on value in that cell or another cell in the same row. This includes, but is not limited to: setting character color, setting background color, bold and italic style, replacement of predefined values with icons (using FontAwesome). This is especially useful for heatmap reports of course activity usage or in crosstab reports to call out unusual values. Specific example: allow display of Module icon in place of Module type. Example 2: display avatar image for a given user id. Example 3: Display a value in red if it exceeds a predefined limit.
20.summary: Support use of localization text strings in Configurable Reports
description: This proposal has two parts: Reports can be made more localizable by allowing the definition of text strings which will appear in the language editor (e.g. column names). Reports constructed in Configurable Reports should be able to display localized text strings (by text string name), e.g. in column names or status values.
21.summary: Allow inclusion of hidden columns in Configurable Reports results
description: Hidden columns: draw data from columns, but do not display in report (for use in chart-only reports, cell calculations and conditional styling)
22.summary: Display Configurable Reports with "frozen" header row(s) and left column(s).
description: Frozen column(s): Allow n left-most (or right-most, in RTL languages) to be defined as frozen , such that they remain visible when horizontally scrolling. Frozen header row(s): Allow n top-most rows to be defined as frozen such that they remain visible at the top of the page area while vertically scrolling. Frozen footer row(s): allow summary calculation rows to be frozen at the bottom of the page area when scrolling
23.summary: Configurable Reports column output as microchart
description: Output as microchart: Allow one or more columns to be combined and displayed as a microchart. Combine with Group/Break feature to provide sparkline embedded line graphs. Implement using charts.js (assuming that is still the selected chart library at the time of implementation). Example: Users report contains Events (see Joining, below). Condition: Event CRUD = C. Group report by User, select CRUD and Timecreated columns and combine as linechart. Now a small line chart of user activity shows on each row next to the user name.
24.summary: Configurable Reports edit cell option
description: Edit cell option: if the user has permissions to edit a value, enabling this option for a column will cause an edit icon (currently the pencil) to appear next to the value in the cell. If the values are restricted to a list, display the list as a pulldown menu. This may be enabled as a separate mode, switched on with a button in the header of the report.
25.summary: Provide URL link to related report in Configurable Reports
description: URL Link to related report: To configure this column, select the other report (must already exist) and provide the linking column(s) of data for each parameter the report accepts. Allow this to be presented in the report as an existing column in the report (e.g. the linking data value), or free text (could include an icon using FontAwesome).
26.summary: Allow Configurable Reports to receive URL parameters
description: Receive URL parameters: Define URL parameters that can be accepted when this report is run, and attach them to either Conditions (invisible in report results or displayed in header only) or Filters (can be modified after the report is run).
27.summary: Option to "return" to previous page from Configurable Reports
description: Return buttons: When viewing a report, record the page the user arrived from. A Return button should be a default option to return the user to their previous page.
28.summary: Support crosstab reports in Configurable Reports
description: Crosstab reports: Select two primary report types and create a matrix of calculated values. _Example_: The number of courses each teacher is assigned to in each Course Category. (Number of teachers and number of categories are both variable.) Example 2: The students in a course are listed as rows. The competencies attached to the course are columns. Each cell contains the current status of that student in that competency. Bonus: enable Chi Square option to look for unusual cells and highlight them.
29.summary: Manually order Configurable Reports results and save order for next execution
description: Manually reorder report results and save new order for next execution: provide drag and drop crosshairs to reorder results of a report to a custom order, and save custom order to user or to context.
30.summary: On-screen help for all display elements in Configurable Reports
description: On-screen help for all display elements: Filters, column headers, charts, and other components of reports should have help available, either on mouse rollover or via info button next to the element. When reports are constructed, this help text can be manually added for columns if there is not already help text available for that data element.
31.summary: Configurable Reports progress bar and error handling
description: Display a progress bar while report is running. If report times out or returns an error, display that result in the same page, rather than dumping the user to an ungraceful generic error page with no "back" alternative.
32.summary: New chart types/options for Configurable Reports
description: New chart types/options: Currently three chart types are supported: bar, pie, and line (timeline only). Bar charts allow vertical bars only. Pie charts are all 3D pies, which are even more difficult to read accurately than ordinary pie charts. Since Moodle is using Chart.js, more chart types should be easy to support, including parameters to style charts: Bar Horizontal bar Stacked vertical and horizontal bar (grouped reports) Progress bar (course progress, not report progress) (could also be done with a styled crosstab report) Radar - valuable for cyclical data and profile characteristics Donut/Pie - these are just more options for pie charts. Currently used on Dashboard report. Good for displaying rough proportions, but note that a number of studies have shown that humans have difficulty estimating and comparing angular wedge values. Polar Area - valuable for cyclical data (e.g. day of week or month of year) Bubble (crosstab, multiple level groups) Bar-whisker/Candlestick (May require plugin, e.g. chartjs-chart-financial| needed for Survey report) Scatterplot (crosstab data) Tree map chart (much easier to read accurately than pie charts, but does not seem to be included in Chart.js) Mixed - this could be a later addition (needed for Survey activity report) but is also helpful for adding a trend line to a scatterplot Animated charts - supported in Charts.js, valuable for time series data (and looks very shiny)
33.summary: Enable Configurable Reports to schedule execution, archive results, and automatically distribute
description: Scheduled execution/archive & distribute: (as in Ad-Hoc Queries) run reports on a schedule auto-email or Moodle Notify results, and/or archive the results for fast access between runs
34.summary: Text editor filter codes for report output
description: Text editor filters for report output: allow report results to appear in a text field (e.g. a Page, a Label, a Lesson, etc.). Allow certain values and summary calculations and charts to be selected during report editing and token filters to be created for embedding in text. Pass context of element automatically to report (e.g. if the filter code is being displayed in a Label, pass the Course in which the Label appears as the context, and also pass the current User). Ideally a plugin for ATTO would show the list of available reports that can be embedded in this way. Example: Show chart of percentage of students who have completed the course in a Label or HTML block Example: Display first name of current user in text on the first page of a Lesson
35.summary: Control SQL feature of Configurable Reports via config.php setting
description: Because the custom SQL feature of Configurable Reports can cause extremely heavy load on a Moodle site and can even result in a loss of data if available space is exceeded, many hosting organizations may wish to disable access to it, even to site administrators. This option would allow access to the custom SQL tab in Configurable Reports to be disabled from the config.php file.
36.summary: Configurable Reports must respect roles and capabilities when allowing access to data
description: When using APIs to access data in Moodle, Configurable Reports should respect applicable capabilities, contexts, and role assignments of the person viewing the report. Graceful failure should allow a report to be viewed with blanks for data the user does not have permission to see, with an annotation.
37.summary: Integrate custom report builder with Database module
description: Any custom report builder included in Moodle should be available for use with the Database activity module, for ease of creating/replacing "list" templates.
38.summary: Provide pivot table feature in customisable report builder and other reports in Moodle core
description: We could dramatically improve functionality of many Moodle reports by adding pivot table capability. This package is an open source, React-based pivot table library: It includes many visualisation tools, as well. It would be especially helpful to have this as part of a customisable report builder, but it would also benefit log/event reports and other reports that contain interrelated data. (There is an older version that uses JQuery instead of React, as well.)
39.summary: Report Builder needs additional data sources
description: The "Report builder" developed as part of the Workplace project provides a form-based way to develop custom reports. However, as originally developed, it supports a limited number of Data sources. (Data sources identify the primary table the report will be based on. Other tables joined to the primary table may be included in the data source as "Tables" in the report builder.) Increasing the number of Data sources will allow greater use of the Report builder, eventually allowing all reports included in Moodle (all versions) to be based on the Report builder, and therefore customisable. Data sources currently included in Workplace: Certification users allocation and completion: User certification allocation, User certification completion, Certification, User, Job assignments, Program Certifications: Program, User allocation, User, Course (JOINed by Program) Programs: Course, User Program users allocation and completion: Program, User allocation, User program completion, User, Job assignments Course completion from datastore: Datastore action (Time completed), Course from datastore, User from datastore, Course completion, User, Course Users: Job assignments The data sources suggested below are based on analysis of user-created reports (e.g. using Ad-hoc queries or Configurable reports), existing reports provided in core, and popular reporting plugins. The primary table is given first, followed by additional tables that are often JOINed to the primary table in existing reports. New data sources: Events/Log activity: Users (mediated by Role assignments and Enrolments), Courses, Course modules, Role assignments, Roles (full name of Role) Gradebook: Grades, Gradebook categories, Course modules, User, Groups, Advanced grading _Note: this is an example of a type of report that could benefit from having editable fields_ Course modules (Activities and Resources): Log activity, Activity completion, Grades Competencies: Courses, Course modules, Users, Course categories Course completion: Enrolments, Users, Courses, Course modules Specific Module types for Core modules (especially Quiz, Assignment, Forum) Course categories: Courses, Enrolments, Role assignments Groups: Users, Events (often filtered by the Course in which the report is run) Course: Course Metadata, Course format, Users (mediated by Role assignments), Enrolments (mediated by Users+Role assignments), Course categories, Course completions User enrolments: User last access, Role assignments/Role, User, Course Time spent in course: This is a special variation of the Course data source that allows the report user to specify the session time (how long a session is assumed to extend after the last logged event), and this value is provided as "Time spent" for all users who access the Course, filterable by Role assignment. Users enroled but not logged in: This Data source requires a LEFT JOIN (if implemented in SQL) to pick up Enrolments in a Course that do NOT have any log activity. Otherwise it resembles "Events/Log activity" above. Communications: Course, Users (linked to Course via Role assignment), various sources of communications between users, e.g.: Messages, Feedback (from Gradebook), Forum (read or reply), Assignment (annotations) (In Configurable Reports, data sources are called report types. In Totara Report Builder, these are called "Sources." Existing report types in CR are Users, Courses, Categories, and Timeline.)
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Merge Participants and Enrolled Users
description: Let us merge them! Two user lists with almost identical content, in different locations. || Item || Type || Link to ||Enrolment page || Participants (brief) || Participants (detailed) || || Profile picture | Data/Picture | Profile | (/) | (/) | (/) | || First name | Data | Profile | (/) | (/) | (/) | || Last name | Data | Profile | (/) | (/) | (/) | || E-mail | Data | Profile | (/) | (/) | (/) | || Last access | Data | None | (/) | (/) | (/) | || City/Town | Data | None | (x) | (/) | (/) | || Country | Data | None | (x) | (/) | (/) | || Select user | Checkbox | N/A | (x) | (/) | (/) | || List of roles | List of data | Delete individual roles | (/) | (x) | (x) | || Add role button | Link | Add role modal | (/) | (x) | (x) | || List of groups | List of data | Remove from individual group | (/) | (x) | (x) | || Add user to group | Link | Add user to group form | (/) | (x) | (x) | || Enrolment method | List of data | None | (/) | (x) | (x) | || Configure user enrolment link | Link | User-Enrolment instance configuration form | (/) | (x) | (x) | || Unenrol link | Link | Remove user from enrolment instance | (/) | (x) | (x) | || Blogs link | Link | User blog entries| (x) | (x) | (/) | || Notes link | Link | Notes | (x) | (x) | (/) | || Activity link | Link | Activity log | (x) | (x) | (/) | || Log in as link | Link | Login as this user | (x) | (x) | (/) | || Full profile link | Link | Link to full profile | (x) | (x) | (/) | . Participants page . Data picture, first name, surname, email address, city, country, last course access . Actions - message one or more users - add note to one or more users - add common note to one or more users . Filter - By role - By first name - By last name . Enrolled users . Data picture, first name, surname, email, last access to course, roles, groups, enrolment methods . Actions - Enrol users - Add role to user - Remove role from users - Add user to group - Remove user from group - Unenrol user . Filter - Free form search - Enrolment method - Role - Group - Status (active / inactiveto
| Unsolvable | 1.summary: Discuss user stories / requirements
description: ||User Story||Acceptance Criteria|| |As a teacher I want to be able to if a users can access the course or not.| - If the current user has moodle/course:enrolreview capability, show a column with the enrolment status for each student. - The enrolment status should be one of "Active", "Suspended" or "Not current". Not current means the date is outside of the enrolment start / end dates.| |As a teacher I want to be able to edit the enrolment settings of an enrolled user using the course participants page in order to fix incorrect enrolments| - edit cog in the "Status" column - clicking the cog takes to the edit enrolment page - completing or cancelling the edit should return you to the participants page| |As a teacher I want to be able to enrol a user using the course participants page in order to give users access to my course| - enrolling a user should not navigate the teacher away from the page - newly enrolled users should appear on the page once the teacher has finished enrolling them| |As a teacher I want to be able to unenrol a user using the course participants page in order to remove a user from my course| - unenrolling a user should ask for confirmation before unenrolling - I should be returned to the participants page on completion or cancel - The unenrol icon should be in the "Status" column. - the unenrolled user should no longer appear in the list of users| |As a teacher I want to be able to see which roles a user has using the course participants page in order to better manage user roles in my course| - roles should be listed inline with the user| |As a teacher I want to be able to add and remove roles from a user using the course participants page in order to give a user capabilities within my course| - If the user has moodle/role:assign capability, roles should have an "edit-inline" icon to indicate they can be modified in-place - Clicking the icon should change the list of roles to an "autocomplete" field allowing add/remove roles. - Saving the list should apply the role changes.| |As a teacher I want to be able to see which groups a user is a member of within the course page in order to better manage groups within my course| - the group names should be listed inline with the user| |As a teacher I want to be able to add a user to a group using the course participants page in order to better structure my course for group learning| - If I have moodle/course:managegroups capability, I should see an edit-inline icon next to the list of groups for each user. - Clicking the edit-inline icon should change the list to an auto-complete field allowing me to add and remove groups. - Saving the list should apply the group changes.| |As a teacher I want to be able to search enrolled users within the course participants page in order to quickly find an enrolled user| - I should be able to filter by: -- free form text - If I have moodle/course:enrolreview capability I should also be able to filter by -- enrolment method -- role -- group -- status| |As a user I want the list of users to be displayed in a compact format so I can see more columns at once| Combine the user picture, fullname and email columns| |As a user I do not want 2 pages with highly overlapping functionality so I dont get confused| Remove enrolments page and update links| | As a user I want to see only UI elements with an important function so that I can find and use the functions I need.| Remove Brief / User Details controls from participants page.|
2.summary: Fix all Behat tests
description: Fix all behat tests following the merging of the two pages.
3.summary: Remove the "Brief / User Details" functionality from the participants page
description: We are adding functionality from the enrol users page, so we need this space in the UI. This is a pointless feature, everything is available from the profile. User Story: As a user I want to see only UI elements with an important function so that I can find and use the functions I need.
4.summary: Enrol Users button on participants page
description: Add the "Enrol users" button to the top and bottom of the participants page if the current user has the capability to create manual enrolments in the course.
5.summary: Add filter controls to the participants page to allow custom filtering
description: Filter by enrolment method, role, status, group, inactive time period or text search. See screenshot. NOTE: Remember to remove the legacy code that used to handle this behaviour.
6.summary: Add a roles column to participants page
description: Allow inline editing on the list of roles (try an autocomplete field for the editing UI). Only show the column if the user can see the users roles (one of moodle/role:assign, moodle/role:safeoverride,moodle/role:override, moodle/role:review). Only show the inline editing control if the user can manage the roles (moodle/role:assign)
7.summary: Add a groups column to the participants page
description: Add a groups column to the participants page listing each users groups, if the current user has moodle/course:managegroups. Show an inline edit icon if the user has moodle/course:managegroups. Try and use an auto-complete field for the editing UI.
8.summary: Add a status column to the participants page
description: If the current user has moodle/course:enrolreview capability, show a column with the enrolment status for each student. The enrolment status should be one of "Active", "Suspended" or "Not current". Not current means the date is outside of the enrolment start / end dates. edit cog in the "Status" column clicking the cog takes to the edit enrolment page completing or cancelling the edit should return you to the participants page enrolling a user should not navigate the teacher away from the page newly enrolled users should appear on the page once the teacher has finished enrolling them unenrolling a user should ask for confirmation before unenrolling I should be returned to the participants page on completion or cancel The unenrol icon should be in the "Status" column. the unenrolled user should no longer appear in the list of users
9.summary: Remove user enrolments page
description: When all the functionality has been added to the participants page, remove the enrolments page and update any links to it.
10.summary: Move flexible_table logic into separate class
description: Currently the logic is all located in index.php making it very messy. We are adding columns to this table and I think a minor refactor to this code would go a long way to helping us solve those issues quickly.
11.summary: Remove the "My courses" functionality from the participants page
description: In we are adding filter controls which will be far superior.
12.summary: Remove the random group div from participants page
description: It is horrendous looking.
13.summary: Remove the columns from the participants page that are not in showuseridentity
description: Participants page randomly lists additional columns for city and country. There is no reason these should not be configurable via showuseridentity.
14.summary: Cover existing participants page with behat tests
description: As part of improving the participants page, we need to ensure existing functionality is not broken. It is not currently well covered by behat (its included in a few other tests, but not many and they dont test the functions on this page).
15.summary: Change user_picture to wrap the entire name + picture in the link
description: Raised as part of changes - the user picture does not look clickable until you hover it and provides a small target for clicking at small sizes. Consider changing the $OUTPUT->user_picture() to by-default wrap the entire think in a link. Potential downsides: Headers might look worse as links.
16.summary: Add bulk editing of enrolment status/dates for users in the course participants page
description: As marina mentioned last week, the user enrolment page has this feature, so it might make sense to add this in the revamped course participants page as well.
17.summary: Participants bulk actions - warn when users removed
description: Show a warning when participants are selected that do not match the bulk action enrolment method. We just need to warn when users are removed from the list.
18.summary: Bulk messaging really needs a tidy up
description: There are other issues about this that came out of the UMN user research work two years ago. Basically people get confused about the entire interface. - they think its the MAIN messaging interface (instead mark it clearly as BULK) - they get lost in the wierd UI (instead remove the "keep searching" and simplify it to select users, then type message, then send)
19.summary: Only show profile roles to students
description: In the participants page, students should only see the courseprofileroles. This is part of merging the participants and enrolments pages. the fix will go in user/classes/output/user_roles_editable.php when calculating the display value and editing is not allowed.
20.summary: Add "Proceed to course content" to participants page
description: This was added to the enrolments page, but we deleted that page.
21.summary: Prevent enrolment bulk changes on frontpage
description: When the participants page is shown on the front page, you should not be able to bulk change enrolments.
22.summary: Only show bulk enrolment methods from plugins added to the course
description: We are currently showing bulk enrolment actions from any enabled enrolment plugin, but we should only show actions from enrolment methods that have been added to the course (have an instance).
23.summary: Groups inplace editable should not be editable if there are no course groups.
description: If there are no groups to add to a user, make it read only.
24.summary: Expand the course settings "Users" node when on participants
description: Only will affect "Clean" - When on participants page if we expand the "Users" navigation node in the settings tree it will be easier to find the course management pages related to Users.
25.summary: Filter on participants page does an ugly flicker while it loads
description: We could hide it until its loaded etc.
26.summary: Replace all checks for the viewparticipants capability with function
description: We now allow the following capabilities in order to check the participant page - moodle/course:viewparticipants (or moodle/site:viewparticipants depending on context). moodle/course:enrolreview We need to go through Moodle and convert the direct check on viewparticipants with a function that uses or logic.
27.summary: Switching between filters is not intuitive
description: From Marina - "When user is in two groups it is very unintuitive how to switch between them - you need to remove the filter by one group and then other groups appear in the filter dropdown, you need to select another one and then press "Filter". It is impossible to remove group filter even when course is in "Visible groups" mode."
28.summary: Apply filters on change (Participants page)
description: Dont wait for them to click on the "Filter" button - its redundant.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Merge Participants and Enrolled Users
description: Let us merge them! Two user lists with almost identical content, in different locations. || Item || Type || Link to ||Enrolment page || Participants (brief) || Participants (detailed) || || Profile picture | Data/Picture | Profile | (/) | (/) | (/) | || First name | Data | Profile | (/) | (/) | (/) | || Last name | Data | Profile | (/) | (/) | (/) | || E-mail | Data | Profile | (/) | (/) | (/) | || Last access | Data | None | (/) | (/) | (/) | || City/Town | Data | None | (x) | (/) | (/) | || Country | Data | None | (x) | (/) | (/) | || Select user | Checkbox | N/A | (x) | (/) | (/) | || List of roles | List of data | Delete individual roles | (/) | (x) | (x) | || Add role button | Link | Add role modal | (/) | (x) | (x) | || List of groups | List of data | Remove from individual group | (/) | (x) | (x) | || Add user to group | Link | Add user to group form | (/) | (x) | (x) | || Enrolment method | List of data | None | (/) | (x) | (x) | || Configure user enrolment link | Link | User-Enrolment instance configuration form | (/) | (x) | (x) | || Unenrol link | Link | Remove user from enrolment instance | (/) | (x) | (x) | || Blogs link | Link | User blog entries| (x) | (x) | (/) | || Notes link | Link | Notes | (x) | (x) | (/) | || Activity link | Link | Activity log | (x) | (x) | (/) | || Log in as link | Link | Login as this user | (x) | (x) | (/) | || Full profile link | Link | Link to full profile | (x) | (x) | (/) | . Participants page . Data picture, first name, surname, email address, city, country, last course access . Actions - message one or more users - add note to one or more users - add common note to one or more users . Filter - By role - By first name - By last name . Enrolled users . Data picture, first name, surname, email, last access to course, roles, groups, enrolment methods . Actions - Enrol users - Add role to user - Remove role from users - Add user to group - Remove user from group - Unenrol user . Filter - Free form search - Enrolment method - Role - Group - Status (active / inactiveto
### Response:
1.summary: Discuss user stories / requirements
description: ||User Story||Acceptance Criteria|| |As a teacher I want to be able to if a users can access the course or not.| - If the current user has moodle/course:enrolreview capability, show a column with the enrolment status for each student. - The enrolment status should be one of "Active", "Suspended" or "Not current". Not current means the date is outside of the enrolment start / end dates.| |As a teacher I want to be able to edit the enrolment settings of an enrolled user using the course participants page in order to fix incorrect enrolments| - edit cog in the "Status" column - clicking the cog takes to the edit enrolment page - completing or cancelling the edit should return you to the participants page| |As a teacher I want to be able to enrol a user using the course participants page in order to give users access to my course| - enrolling a user should not navigate the teacher away from the page - newly enrolled users should appear on the page once the teacher has finished enrolling them| |As a teacher I want to be able to unenrol a user using the course participants page in order to remove a user from my course| - unenrolling a user should ask for confirmation before unenrolling - I should be returned to the participants page on completion or cancel - The unenrol icon should be in the "Status" column. - the unenrolled user should no longer appear in the list of users| |As a teacher I want to be able to see which roles a user has using the course participants page in order to better manage user roles in my course| - roles should be listed inline with the user| |As a teacher I want to be able to add and remove roles from a user using the course participants page in order to give a user capabilities within my course| - If the user has moodle/role:assign capability, roles should have an "edit-inline" icon to indicate they can be modified in-place - Clicking the icon should change the list of roles to an "autocomplete" field allowing add/remove roles. - Saving the list should apply the role changes.| |As a teacher I want to be able to see which groups a user is a member of within the course page in order to better manage groups within my course| - the group names should be listed inline with the user| |As a teacher I want to be able to add a user to a group using the course participants page in order to better structure my course for group learning| - If I have moodle/course:managegroups capability, I should see an edit-inline icon next to the list of groups for each user. - Clicking the edit-inline icon should change the list to an auto-complete field allowing me to add and remove groups. - Saving the list should apply the group changes.| |As a teacher I want to be able to search enrolled users within the course participants page in order to quickly find an enrolled user| - I should be able to filter by: -- free form text - If I have moodle/course:enrolreview capability I should also be able to filter by -- enrolment method -- role -- group -- status| |As a user I want the list of users to be displayed in a compact format so I can see more columns at once| Combine the user picture, fullname and email columns| |As a user I do not want 2 pages with highly overlapping functionality so I dont get confused| Remove enrolments page and update links| | As a user I want to see only UI elements with an important function so that I can find and use the functions I need.| Remove Brief / User Details controls from participants page.|
2.summary: Fix all Behat tests
description: Fix all behat tests following the merging of the two pages.
3.summary: Remove the "Brief / User Details" functionality from the participants page
description: We are adding functionality from the enrol users page, so we need this space in the UI. This is a pointless feature, everything is available from the profile. User Story: As a user I want to see only UI elements with an important function so that I can find and use the functions I need.
4.summary: Enrol Users button on participants page
description: Add the "Enrol users" button to the top and bottom of the participants page if the current user has the capability to create manual enrolments in the course.
5.summary: Add filter controls to the participants page to allow custom filtering
description: Filter by enrolment method, role, status, group, inactive time period or text search. See screenshot. NOTE: Remember to remove the legacy code that used to handle this behaviour.
6.summary: Add a roles column to participants page
description: Allow inline editing on the list of roles (try an autocomplete field for the editing UI). Only show the column if the user can see the users roles (one of moodle/role:assign, moodle/role:safeoverride,moodle/role:override, moodle/role:review). Only show the inline editing control if the user can manage the roles (moodle/role:assign)
7.summary: Add a groups column to the participants page
description: Add a groups column to the participants page listing each users groups, if the current user has moodle/course:managegroups. Show an inline edit icon if the user has moodle/course:managegroups. Try and use an auto-complete field for the editing UI.
8.summary: Add a status column to the participants page
description: If the current user has moodle/course:enrolreview capability, show a column with the enrolment status for each student. The enrolment status should be one of "Active", "Suspended" or "Not current". Not current means the date is outside of the enrolment start / end dates. edit cog in the "Status" column clicking the cog takes to the edit enrolment page completing or cancelling the edit should return you to the participants page enrolling a user should not navigate the teacher away from the page newly enrolled users should appear on the page once the teacher has finished enrolling them unenrolling a user should ask for confirmation before unenrolling I should be returned to the participants page on completion or cancel The unenrol icon should be in the "Status" column. the unenrolled user should no longer appear in the list of users
9.summary: Remove user enrolments page
description: When all the functionality has been added to the participants page, remove the enrolments page and update any links to it.
10.summary: Move flexible_table logic into separate class
description: Currently the logic is all located in index.php making it very messy. We are adding columns to this table and I think a minor refactor to this code would go a long way to helping us solve those issues quickly.
11.summary: Remove the "My courses" functionality from the participants page
description: In we are adding filter controls which will be far superior.
12.summary: Remove the random group div from participants page
description: It is horrendous looking.
13.summary: Remove the columns from the participants page that are not in showuseridentity
description: Participants page randomly lists additional columns for city and country. There is no reason these should not be configurable via showuseridentity.
14.summary: Cover existing participants page with behat tests
description: As part of improving the participants page, we need to ensure existing functionality is not broken. It is not currently well covered by behat (its included in a few other tests, but not many and they dont test the functions on this page).
15.summary: Change user_picture to wrap the entire name + picture in the link
description: Raised as part of changes - the user picture does not look clickable until you hover it and provides a small target for clicking at small sizes. Consider changing the $OUTPUT->user_picture() to by-default wrap the entire think in a link. Potential downsides: Headers might look worse as links.
16.summary: Add bulk editing of enrolment status/dates for users in the course participants page
description: As marina mentioned last week, the user enrolment page has this feature, so it might make sense to add this in the revamped course participants page as well.
17.summary: Participants bulk actions - warn when users removed
description: Show a warning when participants are selected that do not match the bulk action enrolment method. We just need to warn when users are removed from the list.
18.summary: Bulk messaging really needs a tidy up
description: There are other issues about this that came out of the UMN user research work two years ago. Basically people get confused about the entire interface. - they think its the MAIN messaging interface (instead mark it clearly as BULK) - they get lost in the wierd UI (instead remove the "keep searching" and simplify it to select users, then type message, then send)
19.summary: Only show profile roles to students
description: In the participants page, students should only see the courseprofileroles. This is part of merging the participants and enrolments pages. the fix will go in user/classes/output/user_roles_editable.php when calculating the display value and editing is not allowed.
20.summary: Add "Proceed to course content" to participants page
description: This was added to the enrolments page, but we deleted that page.
21.summary: Prevent enrolment bulk changes on frontpage
description: When the participants page is shown on the front page, you should not be able to bulk change enrolments.
22.summary: Only show bulk enrolment methods from plugins added to the course
description: We are currently showing bulk enrolment actions from any enabled enrolment plugin, but we should only show actions from enrolment methods that have been added to the course (have an instance).
23.summary: Groups inplace editable should not be editable if there are no course groups.
description: If there are no groups to add to a user, make it read only.
24.summary: Expand the course settings "Users" node when on participants
description: Only will affect "Clean" - When on participants page if we expand the "Users" navigation node in the settings tree it will be easier to find the course management pages related to Users.
25.summary: Filter on participants page does an ugly flicker while it loads
description: We could hide it until its loaded etc.
26.summary: Replace all checks for the viewparticipants capability with function
description: We now allow the following capabilities in order to check the participant page - moodle/course:viewparticipants (or moodle/site:viewparticipants depending on context). moodle/course:enrolreview We need to go through Moodle and convert the direct check on viewparticipants with a function that uses or logic.
27.summary: Switching between filters is not intuitive
description: From Marina - "When user is in two groups it is very unintuitive how to switch between them - you need to remove the filter by one group and then other groups appear in the filter dropdown, you need to select another one and then press "Filter". It is impossible to remove group filter even when course is in "Visible groups" mode."
28.summary: Apply filters on change (Participants page)
description: Dont wait for them to click on the "Filter" button - its redundant.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Group messaging follow-ups
description: These are follow-ups to group messaging.
| Unsolvable | 1.summary: Add emojis to messaging
description: Add emoji support to messaging as is common in most standard messaging services.
2.summary: Show plain text in Messages summary pane
description: From discussion with michaelh: quoteI think the reason is that you wouldnt want things like showing massive text within the summary pane, though maybe it needs to just strip any HTML and show plaintext (maybe with the exception of an emote showing the actual icon) quote See following example: !HTML entities.png|thumbnail! Should be able to do this here: Acceptance Criteria: Display either the text value, alt tag, title, element type (in that order of priority), falling back to a generic message ("Media content") if we cant match the above.
3.summary: Message - Auto-Reply notification
description: I think for an enhancement to the messaging system in Moodle we should include a Auto-Reply type notice to pop-up. If I was to put this pop up on my messages settings then automatically this will appear to any user trying to message me, thus avoiding the hassle of them trying to get a quick response and they are aware of when I am away and will return. The reason I am asking is because at our institute we have teachers that sometimes go away perhaps for a week and they need a way to show all there students they arent available for questions and for marking assessments. We use the message system within moodle for our communications so this would be a great addition.
4.summary: Show courses shared by sender and receiver of a message
description: When an user receives a message (internal Moodle message), It is hard for the user to know who is the sender, what course is the sender referring in his message. Imagine a teacher who has 2 or 3 courses with more than 20 students each course. There are a lot of students who dont contextualize the message os the teacher can know what is he referring about. If the receiver could know what courses he and the sender are sharing, everything would turn out easier. When an user sends a message to another one, an email is sended to the receiver. This message should include a list of courses shared by sender and receiver for more information about the sender.
5.summary: Upgrade the plugin to use Airnotifier 2 APIs
description: The message_output airnotifier plugin still uses old Airnotifier APIs, it should be upgraded to use the new API for Moodle 2.0
6.summary: Add the ability to attach files to messages
description: In our testing, users kept trying to send files via the messages function of the mobile app. This feature is not available currently.
7.summary: Add the option for read receipts in messages
description: Read receipts help establish clear expectations with communication, and they arent present. Users believe this will mitigate the need for sending multiple messages.
8.summary: View blocked users with option to unblock
description: View blocked users with option to unblock
9.summary: Easy to access preferences for how you want these personal messages (only) dealt with - eg notifications on different devices etc
description: Disable/mute notifications of messages for a period of time (out of office) This should be more directly accessible option.
10.summary: Message create
description: Ability to create a message without having first selected the target user Then prompted to enter the name - within contacts / or course/group - using autocomplete
11.summary: Improve how notification icons are generated
description: Weve added an intermediate solution to have to notification icons generated based on the component name, if its a module, but that doesnt account for things like LTI tools. The notification API probably needs to be split out from messaging and expanded in order to allow for things like specifying an icon (as well as a lot more information relevant to notifications).
12.summary: Disabling notifications also disables messages
description: These are now 2 concepts and should be separate.
13.summary: Review the names of all the message output processors
description: Even just the names of the activities can be confusing when shown without context ("Lesson" is generic and not obvious its about the lesson activity). Especially bad are the inbound message processor notifications. We could probably "group" system messages.
14.summary: Add help text to mobile processor settings to explain how to get messages on your mobile
description: Mobile is kind of tricky to setup and it isnt obvious what the user has to do. Some help text and a warning icon (if needed) would help.
15.summary: Send self-enrolment welcome message through messaging API (Add Web and Mobile notifications)
description: Currently, when a user self-enrolls there is a hard-coded email sent out to confirm their enrollment. It would make more sense to have a notification be sent through the standard notification system that other events go through, similar to other notifications such as self-enrolment expiry
16.summary: Improve notification preference page
description: Add 2 or 3 sentences about each notification explaining its purpose with a help icon with more detail (ie. when is it triggered, how often etc). Change Disable notifications to Disable all notifications. Add introductory text for the preferences page explaining what they are and do.
17.summary: Add ability for some processors to only display online or offline
description: The hack existed for this purpose which is being reverted. We need a cleaner way of doing this.
18.summary: Review all places in Moodle sending messages / generating notifications
description: Find all of the places in Moodle that are sending messages or generating notifications and make sure they are being set as the correct type (message or notification). Anything that is being sent from the system to a user should be set as a notification. Messages should only be for user to user communication.
19.summary: Put "Course shortname" in each notification (in the popover)
description: Put "Course shortname" in each notification (in the popover)
20.summary: New notification type for News Forum
description: From the UX review discussion with Mark McKay: The News Forum should have its own special type of notification to make sure all students are notified about posts. It should also be made more obvious that its a way to communicate with the entire course and ensure everyone will receive those notifications.
21.summary: Mute notifications from a forum
description: From the UX review discussion with Mark McKay. It would be good to be able to easily mute notifications per forum, so that people can unsubscribe to notifications from individual forums they arent interested in.
22.summary: Be able to lock messaging down per course
description: From the UX review discussion with Mark McKay. A user (particularly teacher) should be able to restrict ability to be messaged to only users they share a course with. They should be able to do this course by course.
23.summary: Split assignment notification into separate types
description: From the UX review discussion with Mark McKay. Create more granular notification types for assignment and allow finer control in the preferences. This is particularly important for notifications around grades, which students value extremely highly.
24.summary: Group similar notifications into single summary notification
description: From the UX review discussion with Mark McKay. Rather than present an individual notification to the user for each event, group similar notifications and offer summarised information about them similar to how Facebook notifications work. e.g. for a teacher, instead of getting 5 notifications saying "student x has submitted their assignment", they should just get a single notification saying "5 students have submitted their assignments" or similar.
25.summary: Add a max limit to the get notifications request to stop DDOS
description: We need to add a check in the webservice that gets notifications to enforce a reasonable limit so that someone cant request 10,000 notifications and kill the server.
26.summary: Add activities heading to notification page
description: Add Activities heading to notification preferences page and group activity notification under single "toggle all" type row, rather than individual notifications listed per activity. See UX-7
27.summary: Group non-activity notifications into single "General site notifications" section
description: Group notifications that are no triggered by activity modules under a General site notifications header with a simple toggle for all.
28.summary: HTML editor should be available in the messaging UI
description: Messaging from the Participants page allows the user to use a simplified HTML editor, but messaging from the Message page does not. Why is that? It is VERY useful to be able to add emphasis, use bullets and provide links in messages. Rich-text messages sent from Participants display perfectly on the Message page, so please consider adding the ability to send rich text from the Message page as well.
29.summary: Add example context to message_area templates
description: Need to add example contexts to the template documentation for the message_area templates
30.summary: Add scheduled task to clean message_popup data of read notifications
description: There is a scheduled task here lib/classes/task/messaging_cleanup_task.php that removes read notifications if the "messagingdeletereadnotificationsdelay" config value is not empty. We should add a scheduled task to do the same operation for the message_popup table to remove the data from that table when these records are deleted, since itll now be stale data.
31.summary: Searching messages should take you to message context
description: Consider S1 send following few messages to S2 Testing is fun Few random msg Few random msg Testing is not fun Log in as S2 and go to User Menu -> messages Search for Testing You will observe two results Click on either and it show conversation with S1 Expected is to show the context of the message, (Message where it belong in conversation) and not end of the converstaion.
32.summary: Usability improvement suggestions for new messages UI
description: (1) Seems to me like the current users image and name at the top of the pages is redundant, as you know who you are and you already have your image and name on the users top left menu (navbar). (2) It seems like a redundancy when displaying the name & online state of the users we already selected on the left (users menu) above the conversation. (3) It feels less confusing when I type a message and see it displayed on the left and the other users messages are on the far right. (4) It would be very helpful to see users picture and maybe he/her name on the beginning of the message, to make it very clear - who wrote what. (5) Messages should be refreshed every now and then, to reflect the conversation, if it is happening online. as now it does not. and the conversation is not really happening. it is stuck. and both users need to manually refresh to other users reply. (6) Seems like the "send" button has a redundant btn-link class. also the "edit" button. as they are actions (and not links to other information pages) (7) Accessibility: "write a message" textarea form element is missing label (8) Accessibility: message time stamps have low contrast.
33.summary: On Notification preferences page it will be nice to show default value with different color icon
description: On notifications preferences page, it is hard to differentiate if the values are default (site wide), or user specific. Any changes done by admin, are reflected on user settings and its not visible what is default and what user has changed. Steps to reproduce: Go to Notification preferences (User menu > Preferences) It will be nice to show icons as grey or some other color when its default site wide value.
34.summary: Additional accessibility improvements for the messaging page.
description: added basic accessibility to the messaging page, but it would be nice to add the following: A link to skip all of the contacts and go straight to the two tabs at the bottom of that column. A link to skip all of the conversations and go straight to the "Write a message" box. Have the search box notify the user as to how many results it has found. The message popup in the header cant be selected with a combination of firefox and NVDA. Some installations of IE 11 and Jaws will leave edit mode when a contact is selected to message. Some of the keyboard ARIA controls for tabs are missing Doesn t say who sent what message (not a huge problem since we don t have group chats. But confusing since it reads out your own messages when you send them) Feel free to update this issue with other ideas as they pop up.
35.summary: Add polling to conversation tab
description: Currently we perform polling when you are viewing a particular conversation. However, while conversing with someone it is entirely possible someone else may send you a message. Currently the only way to know this is if you do a page refresh. It would be nice if the conversations were polled and updated as well.
36.summary: Ability to forward messages
description: Similar to how you can do it in telegram. This would be pretty cool.
37.summary: Message app should not block rendering messages while marking them as read
description: If you create a user with lots of unread messages (thousands of them) and then view the conversation in the message area it waits for the "mark all as read" request to complete before it renders the messages in the widget even though weve received the messages from the server. This results in the loading spinner sitting there for ages even though weve got content to render. Each request is separate from one another and asynchronous so the message rendering shouldnt be blocked by the "mark all as read" ajax request.
38.summary: Improve push notifications
description: In this issue we plan to improve Push notifications, well be working on this four areas: 1 Enable more "message providers" for the Mobile app in new installations or during upgrade. So students will receive Push notifications even if the site admin didnt configure them yet. 2 Review all the data included in a "message/notification" so we can receive all the necessary context information in the app to open the "page related" to the notification in the app once the user clicks on the notification text (this is working partially now). 3 Improve the media information included in a "message/notificaiton" so we can display "Rich" Push Notifications, including icons, large images, badge icons, etc.. 4 Support "In-line action buttons", so you can, for example, accept a "Contact request" via the notification itself (with an "Accept" or "Decline" button just bellow the information of the notification. Please, note that iOS Push notifications are quite limited compared to Android ones, and that the Cordova framework and hybrid apps have additional limitations. Push and Web notifications usually come with: - Badge icon: The badge is a small monochrome icon that is used to portray a little more information to the user about where the notification is from. - Custom icons: The icon option is essentially a small image you can show next to the title and body text. - Custom pictures (large images): The image option can be used to display a larger image to the user. This is particularly useful to display a preview image to the user. 2x1 ratio recommended We should support these in our message base class and in the "messages" and "notifications" tables. (notificationbadgeurl, notificationiconurl, notificationimageurl) See more information an screenshot examples here:
39.summary: Notification preferences web offline options confusing
description: Apparently the notification preferences web offline options are for setting whether a user is notified when they next log in to Moodle. This is confusing, as highlighted in a recent discussion on moodle.org Offline web notifications - how do they even work?| How about instead simplifying the UI and having only one column for web notifications?
40.summary: Add send message buffering
description: We should create a buffer for sending messaging to allow the user to quickly type and send multiple messages one after another. Currently we block the message input after each message is sent until we get confirmation from the server that it was successfully sent. This could be changed to immediately add the message to the conversation in the page in a pending state while the request is being sent to the server. Once the server responds we can update update the message text to be the server responded text (because it can change). If the message fails then we need to indicate that the message failed and allow it to be re-sent.
41.summary: Messaging: Deprecate no longer used API functions
description: After this project is done there may be a lot of no longer used API functions to deprecate, i.e.: externallib.php: get_messages, data_for_message_area_messages, send_instant_messages lib.php: message_post_message api.php: get_messages helper.php: get_messages
42.summary: Messaging: Allow searching within a conversation
description: Just creating this so we can dump some of the code from into here, so we dont lose it. This issue is not a priority for MVP.
43.summary: Messaging: UI: Add searching within a conversation feature to the new UI
description: Scope: Users should be able to search for messages within a conversation - see designs. should have updated the backend web services to facilitate this.
44.summary: For private conversations, let users reply, despite of the privacy preferences, if one of them has the moodle/course:contactanycourseuser
description: In a new capability (moodle/course:contactanycourseuser) has been added to allow users to bypass other privacy messaging preferences. During IR, Andrew has raised a situation where the teacher may contact the student, but the student cannot then reply. This issue is for adding this feature: if convo is private (this will be added in ) and if one member has that capability (contactanycourseuser), then allow the other member to reply.
45.summary: All contact requests between users should be cleaned up if one is accepted
description: If there are 2 users, A and B, and each of them sends the other a contact request then if either A or B accepts the request as the recipient then the request they sent should also be removed (since its now redundant as they are contacts). I guess it could be the same for the opposite scenario too, if the recipient declines a request then maybe it should also remove the request that they sent. Im not 100 sure about this scenario though.
46.summary: A user should be able to decline/cancel a contact request that theyve sent
description: If a user creates a contact request then they should be able to cancel it if it hasnt been accepted/decline by the recipient already.
47.summary: Work out a better way for linked conversations to set their conversation subname
description: Currently, only course groups are linked to conversations, and the subname is the course name, hard coded in the get_conversations() function. This was done due to time restrictions only, and is not a long term solution nor does it scale to other component relationships. We should provide a way for components to specify this subname field, either during creation, or via some other mechanism, so we can achieve the same outcome in a more generic way.
48.summary: Add index conversationid-userid to message_conversation_members table
description: At this moment in time a user can not be in the same conversation twice - if this does happen then it is a bug. Adding an index would prevent duplicate records and alert us to errors quicker.
49.summary: Improve permissions checks in message API
description: Permissions checks in message API are baked into external function wrappers. It sounds like this is existing with messaging but "api" has become a not a usable api by anything outside of messaging. Since this is existing no change is required in this issue.
50.summary: Fix display of html messages
description: Yep, this got borked again. get_conversations() will not return the message in a format that allows things like links, images (all raw html code) to be displayed. We didnt used to return the formatted message for the conversations list on the old UI, which explains this perhaps, but now, we should make our web services behave the same way everywhere. I.e. return the formatted full message.
51.summary: Ordering and blocktimes of php-rendered conversation messages is incorrect
description: This affects the current UI for messaging. NOT the new interface due to land in 3.6 soon. 1. Send some messages to a user and send some back as that user. 2. Now, load up the message/index page If you load the conversation by clicking it, this calls the OLD web service, and the messages are in the correct order. If you refresh the page on the conversation, the ordering comes from the new function, and the messages are out of order.
52.summary: Adapt behat tests to new group messaging functions and UI
description: Some behat tests are failing because default value for messagingallusers is 0, but to get same search results as in deprecated functions, value needs to be 1. Those behat tests had been changed, setting mssagingallusers = 1 in . We should redo those behat tests, decide how many new tests we need, and remove the ones we dont need anymore.
53.summary: Deprecate search_users and search_users_in_course in api.php
description: This function should be removed once new group messaging UI is in place and old messaging UI is removed. For now we are not removing/deprecating this function for backwards compatibility with messaging UI. data_for_messagearea_search_users_in_course external function is deprecated in .
54.summary: Add API function to generate unread counts for conversations by type, with favourites support.
description: This will assist in populating the unread counts for the accordion tabs in the new UI. Lets say we have 10 favourited conversations, and we have 4 of these with unread messages (it doesnt matter how many unread messages per conversation - ignore that), then the unread count for favourites would be 4. Same applies to the group and individual types.
55.summary: Improve performance of sending messages
description: Weve had to duplicate a lot of logic for the old send message stuff in . This needs to be re-worked to improve performance. Things like avoiding some DB queries and multiple checks, making the message processors execute offline with something like cron etc.
56.summary: Replace $CFG->block_online_users_timetosee with a core setting
description: Core code (messagelib, message/manager) should not be dependant on a block setting, so we should create this in core.
57.summary: Messaging: Improve the performance of non-contact searches when site-wide messaging is disabled (default)
description: This currently grabs non-contact users in batches, and checks each users visibility using user_get_user_details_courses(). We may be able to optimise this, so that the generator sql is smarter, and gets users who are more likely to be visible to the current user (shared courses).
58.summary: Actions on view contact page in message drawer should be handled on that page
description: Currently performing an action on a contact (e.g. blocking a user, adding contact etc) redirects the drawer to the conversation page to be corrected. However the the UI prototype has changed this so that the user can complete that action on the contact page and is only redirected after the action is confirmed (or not at all if its cancelled). See
59.summary: User tours for messaging and Dashboard
description: This would surely help.
60.summary: Create new web service for returning contacts to prevent usage of new UI using deprecated web service
description: The web service data_for_messagearea_get_contacts was deprecated but is still used in the new UI introduced in . This issue will be to add a new webservice to replace it, and also deprecate the old get_contacts webservice which will no longer be used by mobile for 3.6. The reason I propose a new web service is because the data_for_messagearea prefix is misleading.
61.summary: It is possible to send empty messages
description: Just try adding a message with just HTML tags, like It creates a new empty message.
62.summary: Improve handling of unread messages in conversations
description: For the first release we just mark all messages in a conversation as read when the user views the conversation however it would be a better user experience to indicate to the user which messages were the unread ones. Perhaps even loading all unread messages first and scrolling them to the earliest of the unread. Take a look at how Telegram treats unread messages for inspiration.
63.summary: Viewing a user from a group members list takes me to the wrong place
description: Given I am in a group conversation And I click on the group title When I click on the name of a user in that conversation Then I should see the Users Messaging Profile I am actually taken to a message page with them which is counter intuitive.
64.summary: Add CSS animation transitions when changing views in UI
description: Originally we had CSS animations to slide the view changes in the messaging UI however I had to remove the animations because they were causing a visual bug in the browser where the "hidden" view wouldnt slide out of view correctly. Here is the commit that removed the styles (in case we want to base new changes off of them): To replicate the bug that cause these to be removed: Have 3 users, s1, s2, and s3 Send some messages between s1 and s2 and between s1 and s3 Have s2 add s1 to their contacts (which creates a contact request for s1) Log in as s1 and view the conversation from the first page in the message drawer You should see the confirm dialogue for the contact request (dont accept or decline it) Go back and switch between the two conversations a couple of times After switching a few times eventually you should see the conversation between s1 and s2 only partially show because the hidden page doesnt correctly animate out of view.
65.summary: Add the ability to mute messaging conversations
description: From a chat, somewhere, to avoid it to be forgotten... dobedobedoh dixit: bq. Another thought if someone could raise it for me: mute conversations Thats all, Ive searched in the tracker trying to find if that had been discussed previously and didnt find anything, so creating this. Ciao :-)
66.summary: Add search functionality on group chat
description: The prototype for the MVP shows search functionality which is missing on the test version. !group chat search.png|thumbnail!
67.summary: Add a capability to prevent users from disabling notifications
description: There does not seem to be a capability for the option to disable notifications on the notification settings page: thus it is not possible to remove this capability and prevent students from disabling all notifications. This is a problem where Moodle is being used as the primary means of communication within a University. We would like the ability to disable this feature so that students could not inadvertently disable all notifications and potentially miss important notices. Please see related
68.summary: Add a capability to prevent users from blocking messages from non-contacts
description: There does not seem to be a capability for the ability to block non contacts from messaging you via the edit preferences > message preferences screen: It would be useful if we could disable this setting for useres to prevent them rendering themselves non messagable by their peers or in some cases their tutors. Please see related
69.summary: Expose get_unread_conversation_counts as a web service
description: We need this because the UI is changing to poll for this when the messaging pane is first opened, rather than doing this one every page load. This is a performance improvement, in the cases where users are not using messaging (or do not intend to, after loading the page).
70.summary: Add new web service to expose number of unread contact requests
description: This is required by the mobile team - see .
71.summary: Review online/offline behaviour for personal messages output because users cant distinct them any more
description: As commented in , the online/offline distinction has been removed on purpose from the messaging user settings page, but it is still working in some cases, like when the user hasnt any default messages preferences and they are defined with different values in Site administration | Plugins | Message outputs | Default message outputs. This confuses a little bit because, by default, on a fresh installation, users will only receive email notifications for personal messages when they wont be connected. However, if they disable and enable Email from the new messaging settings page, they will receive email notifications for private messages always (regardless if they are online or offline). We should review this part to make it more consistent from the users POV. For instance, we could display the online/offline information (when its not the same) to let know it to the user, add some help text to explain how it works or even add it again to the settings page or remove it from the Default message outputs.
72.summary: Keep messaging drawer open on page refresh
description: Currently when using messaging if you open the drawer and then do a page refresh the drawer doesnt appear and you lose where you were in the messaging drawer, which breaks the flow. eg. You are in a conversation with your teacher and they are telling you what resources to click on and then what text to enter etc
73.summary: I just want to reply to a one-off message. I dont want to add a contact, and I dont want to decline
description: Before Moodle 3.6, you could just reploy to one message that someone sent you. In Moodle 3.6, when I try to do that, I get confronted with a Modal dialogue !image-2019-02-04-13-44-13-412.png|thumbnail! I dont want to do either of those things. I want to reply. Note: I got here by clickin a link in the email that said Go to LINK to reply. This is really bad usability.
74.summary: Change the mute icon in the messaging UI
description: Currently we are using the font-awesome icon fa-microphone-slash (see core:i/mute in lib/classes/output/icon_system_fontawesome.php). Ideally we should be using fa-volume-mute but this is not available in the version of FA we are using (4.7). has been created to upgrade this library. When that is done we should change this.
75.summary: Users should be informed that they cant block a user who has permission to message all users
description: Hi there, while testing and trying to understand the newly introduced capabilty, I stumbled over this. Status quo and problem By default the capability _moodle/site:messageanyuser_ is given to the roles Manager, Teacher and Non-editing teacher. The capability has the effect that this user can text to users even if they were blocked. For example. User A is teacher in course X. User B, enrolled as student in course X does not want to receive messages from his teacher and therefore he blocks user A. Then A can still send messages to B. This is absolutely okay, because teachers should be able to text their students in all means. Were just struggling with the unexpectedness of this feature for the student B. He thought that he has blocked A and is confused why he still receives messages and the conclusion might be that he thinks that theres a bug and blocking is not working. Steps to reproduce Having users A and B in your system Make sure that _moodle/site:messageanyuser_ is given to teachers Go to a course X (or create one) and enrol user A as teacher and user B as student Login as user B, open the messaging interface and search for user A In the list, klick on the three dots for user A and klick on context menu item "Block user" Confirm the blocking action by clicking the button "Block" Verify that you see the information "You have blocked this user in the past" with the button "Unblock user" Login as user A Open the messaging interface and search for user B Make sure that you have the messaging text area Enter a message and send it to user B Login as user B and see that hes got a new message from user A and the blocking icon is shown after the name of user A Proposal So were proposing to make this more transparent for the users: If a user wants to block a user that has the capability moodle/site:messageanyuser, the dialogue "Are you sure you want to block XY?" could be altered to something like this: "Are you sure you want to block XY? Attention: Currently the block wont have any effect, because XY has permissions to contact you though." The information that the block currently has no effect should be displayed in the user list, too. For example the strike through icon could be grayed out and some textual explanation could be added. For example something like this (inactive is probably not the correct term, but it should only serve visual support here): !messaging_block_inactive.png! We think with this changes the user should be clear about the status of the blocking action and should not wonder or assume a bug if a user with the capability sends him a message though. Best, Kathrin
76.summary: Messaging: Starred conversations should show up in both the starred and group/individual categories
description: Currently, starred conversations are removed from their respective category when starred. Because this might be (?) confusing, we may want to change this behaviour so that, once starred, a conversation shows up in 2 places: The starred category, and the original (group or private) category.
77.summary: Messaging: revise messaging controls on user profile page
description: In light of changes in , we should ensure the messaging controls on a users profile page are not displayed unless that user can be seen in the messaging search results. For users who are not going to be contactable at all, dont display the links. In the course contact case: if a student views a course contacts profile page, the messaging links (message, add to contacts) wont be presented, but the profile page is still visible. introduces a messaging function which should be used to determine whether one use can see another, specifically in the regards to messaging search results.
78.summary: Add year to messaging conversation date headings, if not the current year
description: See the attached screenshot. If the message listed under the heading "21 March" was sent last year, how would we know? We should see if its possible to format these timestamps conditionally, as we did for the recent message dates in . So (for headings only!): - Timestamps for a date which is NOT inside the current calendar year will be of the format "21 March, 2018". - Timestamps which are inside the current calendar year remain as they are now.
79.summary: Messaging interface assumes secondary color is light shade
description: The messaging interface in Boost uses bg-secondary behind some text but assumes that its a pale shade, since it puts hardcoded gray and dark gray text on top of it. The text colors should use color-yiq functions to ensure they are readable if the secondary color is set to something else.
80.summary: Replace message polling with websockets
description: THIS IS AN MUA PROJECT PROPOSAL THAT WILL BE OR HAS BEEN SUBMITTED FOR POSSIBLE MUA FUNDING. ANY EXISTING TRACKER ITEMS THAT THIS MIGHT DUPLICATE SHOULD BE LINKED TO BELOW. We should replace the current code in the messaging interface that polls the server for new messages with websockets to more efficiently perform these operations. This will improve the performance of the messaging interface and make it feel more responsive for users that would like to conduct real time conversations in it.
81.summary: Add activity module link previews to messages
description: When an activity module link is added to a message we should generate a little link preview for the activity similar to how facebook or other platforms do for links in their messages.
82.summary: Ability to delete all messages in one action
description: The university where I work switched to Moodle version 3.6 last July and the messaging function was not unanimously accepted. In fact, the biggest problem comes from the fact that it is not possible to select conversations in order to be able to delete them all in one action. !image-2019-10-22-16-02-51-024.png|width=306,height=991! The only way right now is to click to read the conversation, then click on the three small dots and click on delete. !image-2019-10-22-16-03-17-306.png! However, a teacher can receive about a hundred messages in a single semester. Is there a way to only select all received messages and delete them (like a mailbox)?
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Group messaging follow-ups
description: These are follow-ups to group messaging.
### Response:
1.summary: Add emojis to messaging
description: Add emoji support to messaging as is common in most standard messaging services.
2.summary: Show plain text in Messages summary pane
description: From discussion with michaelh: quoteI think the reason is that you wouldnt want things like showing massive text within the summary pane, though maybe it needs to just strip any HTML and show plaintext (maybe with the exception of an emote showing the actual icon) quote See following example: !HTML entities.png|thumbnail! Should be able to do this here: Acceptance Criteria: Display either the text value, alt tag, title, element type (in that order of priority), falling back to a generic message ("Media content") if we cant match the above.
3.summary: Message - Auto-Reply notification
description: I think for an enhancement to the messaging system in Moodle we should include a Auto-Reply type notice to pop-up. If I was to put this pop up on my messages settings then automatically this will appear to any user trying to message me, thus avoiding the hassle of them trying to get a quick response and they are aware of when I am away and will return. The reason I am asking is because at our institute we have teachers that sometimes go away perhaps for a week and they need a way to show all there students they arent available for questions and for marking assessments. We use the message system within moodle for our communications so this would be a great addition.
4.summary: Show courses shared by sender and receiver of a message
description: When an user receives a message (internal Moodle message), It is hard for the user to know who is the sender, what course is the sender referring in his message. Imagine a teacher who has 2 or 3 courses with more than 20 students each course. There are a lot of students who dont contextualize the message os the teacher can know what is he referring about. If the receiver could know what courses he and the sender are sharing, everything would turn out easier. When an user sends a message to another one, an email is sended to the receiver. This message should include a list of courses shared by sender and receiver for more information about the sender.
5.summary: Upgrade the plugin to use Airnotifier 2 APIs
description: The message_output airnotifier plugin still uses old Airnotifier APIs, it should be upgraded to use the new API for Moodle 2.0
6.summary: Add the ability to attach files to messages
description: In our testing, users kept trying to send files via the messages function of the mobile app. This feature is not available currently.
7.summary: Add the option for read receipts in messages
description: Read receipts help establish clear expectations with communication, and they arent present. Users believe this will mitigate the need for sending multiple messages.
8.summary: View blocked users with option to unblock
description: View blocked users with option to unblock
9.summary: Easy to access preferences for how you want these personal messages (only) dealt with - eg notifications on different devices etc
description: Disable/mute notifications of messages for a period of time (out of office) This should be more directly accessible option.
10.summary: Message create
description: Ability to create a message without having first selected the target user Then prompted to enter the name - within contacts / or course/group - using autocomplete
11.summary: Improve how notification icons are generated
description: Weve added an intermediate solution to have to notification icons generated based on the component name, if its a module, but that doesnt account for things like LTI tools. The notification API probably needs to be split out from messaging and expanded in order to allow for things like specifying an icon (as well as a lot more information relevant to notifications).
12.summary: Disabling notifications also disables messages
description: These are now 2 concepts and should be separate.
13.summary: Review the names of all the message output processors
description: Even just the names of the activities can be confusing when shown without context ("Lesson" is generic and not obvious its about the lesson activity). Especially bad are the inbound message processor notifications. We could probably "group" system messages.
14.summary: Add help text to mobile processor settings to explain how to get messages on your mobile
description: Mobile is kind of tricky to setup and it isnt obvious what the user has to do. Some help text and a warning icon (if needed) would help.
15.summary: Send self-enrolment welcome message through messaging API (Add Web and Mobile notifications)
description: Currently, when a user self-enrolls there is a hard-coded email sent out to confirm their enrollment. It would make more sense to have a notification be sent through the standard notification system that other events go through, similar to other notifications such as self-enrolment expiry
16.summary: Improve notification preference page
description: Add 2 or 3 sentences about each notification explaining its purpose with a help icon with more detail (ie. when is it triggered, how often etc). Change Disable notifications to Disable all notifications. Add introductory text for the preferences page explaining what they are and do.
17.summary: Add ability for some processors to only display online or offline
description: The hack existed for this purpose which is being reverted. We need a cleaner way of doing this.
18.summary: Review all places in Moodle sending messages / generating notifications
description: Find all of the places in Moodle that are sending messages or generating notifications and make sure they are being set as the correct type (message or notification). Anything that is being sent from the system to a user should be set as a notification. Messages should only be for user to user communication.
19.summary: Put "Course shortname" in each notification (in the popover)
description: Put "Course shortname" in each notification (in the popover)
20.summary: New notification type for News Forum
description: From the UX review discussion with Mark McKay: The News Forum should have its own special type of notification to make sure all students are notified about posts. It should also be made more obvious that its a way to communicate with the entire course and ensure everyone will receive those notifications.
21.summary: Mute notifications from a forum
description: From the UX review discussion with Mark McKay. It would be good to be able to easily mute notifications per forum, so that people can unsubscribe to notifications from individual forums they arent interested in.
22.summary: Be able to lock messaging down per course
description: From the UX review discussion with Mark McKay. A user (particularly teacher) should be able to restrict ability to be messaged to only users they share a course with. They should be able to do this course by course.
23.summary: Split assignment notification into separate types
description: From the UX review discussion with Mark McKay. Create more granular notification types for assignment and allow finer control in the preferences. This is particularly important for notifications around grades, which students value extremely highly.
24.summary: Group similar notifications into single summary notification
description: From the UX review discussion with Mark McKay. Rather than present an individual notification to the user for each event, group similar notifications and offer summarised information about them similar to how Facebook notifications work. e.g. for a teacher, instead of getting 5 notifications saying "student x has submitted their assignment", they should just get a single notification saying "5 students have submitted their assignments" or similar.
25.summary: Add a max limit to the get notifications request to stop DDOS
description: We need to add a check in the webservice that gets notifications to enforce a reasonable limit so that someone cant request 10,000 notifications and kill the server.
26.summary: Add activities heading to notification page
description: Add Activities heading to notification preferences page and group activity notification under single "toggle all" type row, rather than individual notifications listed per activity. See UX-7
27.summary: Group non-activity notifications into single "General site notifications" section
description: Group notifications that are no triggered by activity modules under a General site notifications header with a simple toggle for all.
28.summary: HTML editor should be available in the messaging UI
description: Messaging from the Participants page allows the user to use a simplified HTML editor, but messaging from the Message page does not. Why is that? It is VERY useful to be able to add emphasis, use bullets and provide links in messages. Rich-text messages sent from Participants display perfectly on the Message page, so please consider adding the ability to send rich text from the Message page as well.
29.summary: Add example context to message_area templates
description: Need to add example contexts to the template documentation for the message_area templates
30.summary: Add scheduled task to clean message_popup data of read notifications
description: There is a scheduled task here lib/classes/task/messaging_cleanup_task.php that removes read notifications if the "messagingdeletereadnotificationsdelay" config value is not empty. We should add a scheduled task to do the same operation for the message_popup table to remove the data from that table when these records are deleted, since itll now be stale data.
31.summary: Searching messages should take you to message context
description: Consider S1 send following few messages to S2 Testing is fun Few random msg Few random msg Testing is not fun Log in as S2 and go to User Menu -> messages Search for Testing You will observe two results Click on either and it show conversation with S1 Expected is to show the context of the message, (Message where it belong in conversation) and not end of the converstaion.
32.summary: Usability improvement suggestions for new messages UI
description: (1) Seems to me like the current users image and name at the top of the pages is redundant, as you know who you are and you already have your image and name on the users top left menu (navbar). (2) It seems like a redundancy when displaying the name & online state of the users we already selected on the left (users menu) above the conversation. (3) It feels less confusing when I type a message and see it displayed on the left and the other users messages are on the far right. (4) It would be very helpful to see users picture and maybe he/her name on the beginning of the message, to make it very clear - who wrote what. (5) Messages should be refreshed every now and then, to reflect the conversation, if it is happening online. as now it does not. and the conversation is not really happening. it is stuck. and both users need to manually refresh to other users reply. (6) Seems like the "send" button has a redundant btn-link class. also the "edit" button. as they are actions (and not links to other information pages) (7) Accessibility: "write a message" textarea form element is missing label (8) Accessibility: message time stamps have low contrast.
33.summary: On Notification preferences page it will be nice to show default value with different color icon
description: On notifications preferences page, it is hard to differentiate if the values are default (site wide), or user specific. Any changes done by admin, are reflected on user settings and its not visible what is default and what user has changed. Steps to reproduce: Go to Notification preferences (User menu > Preferences) It will be nice to show icons as grey or some other color when its default site wide value.
34.summary: Additional accessibility improvements for the messaging page.
description: added basic accessibility to the messaging page, but it would be nice to add the following: A link to skip all of the contacts and go straight to the two tabs at the bottom of that column. A link to skip all of the conversations and go straight to the "Write a message" box. Have the search box notify the user as to how many results it has found. The message popup in the header cant be selected with a combination of firefox and NVDA. Some installations of IE 11 and Jaws will leave edit mode when a contact is selected to message. Some of the keyboard ARIA controls for tabs are missing Doesn t say who sent what message (not a huge problem since we don t have group chats. But confusing since it reads out your own messages when you send them) Feel free to update this issue with other ideas as they pop up.
35.summary: Add polling to conversation tab
description: Currently we perform polling when you are viewing a particular conversation. However, while conversing with someone it is entirely possible someone else may send you a message. Currently the only way to know this is if you do a page refresh. It would be nice if the conversations were polled and updated as well.
36.summary: Ability to forward messages
description: Similar to how you can do it in telegram. This would be pretty cool.
37.summary: Message app should not block rendering messages while marking them as read
description: If you create a user with lots of unread messages (thousands of them) and then view the conversation in the message area it waits for the "mark all as read" request to complete before it renders the messages in the widget even though weve received the messages from the server. This results in the loading spinner sitting there for ages even though weve got content to render. Each request is separate from one another and asynchronous so the message rendering shouldnt be blocked by the "mark all as read" ajax request.
38.summary: Improve push notifications
description: In this issue we plan to improve Push notifications, well be working on this four areas: 1 Enable more "message providers" for the Mobile app in new installations or during upgrade. So students will receive Push notifications even if the site admin didnt configure them yet. 2 Review all the data included in a "message/notification" so we can receive all the necessary context information in the app to open the "page related" to the notification in the app once the user clicks on the notification text (this is working partially now). 3 Improve the media information included in a "message/notificaiton" so we can display "Rich" Push Notifications, including icons, large images, badge icons, etc.. 4 Support "In-line action buttons", so you can, for example, accept a "Contact request" via the notification itself (with an "Accept" or "Decline" button just bellow the information of the notification. Please, note that iOS Push notifications are quite limited compared to Android ones, and that the Cordova framework and hybrid apps have additional limitations. Push and Web notifications usually come with: - Badge icon: The badge is a small monochrome icon that is used to portray a little more information to the user about where the notification is from. - Custom icons: The icon option is essentially a small image you can show next to the title and body text. - Custom pictures (large images): The image option can be used to display a larger image to the user. This is particularly useful to display a preview image to the user. 2x1 ratio recommended We should support these in our message base class and in the "messages" and "notifications" tables. (notificationbadgeurl, notificationiconurl, notificationimageurl) See more information an screenshot examples here:
39.summary: Notification preferences web offline options confusing
description: Apparently the notification preferences web offline options are for setting whether a user is notified when they next log in to Moodle. This is confusing, as highlighted in a recent discussion on moodle.org Offline web notifications - how do they even work?| How about instead simplifying the UI and having only one column for web notifications?
40.summary: Add send message buffering
description: We should create a buffer for sending messaging to allow the user to quickly type and send multiple messages one after another. Currently we block the message input after each message is sent until we get confirmation from the server that it was successfully sent. This could be changed to immediately add the message to the conversation in the page in a pending state while the request is being sent to the server. Once the server responds we can update update the message text to be the server responded text (because it can change). If the message fails then we need to indicate that the message failed and allow it to be re-sent.
41.summary: Messaging: Deprecate no longer used API functions
description: After this project is done there may be a lot of no longer used API functions to deprecate, i.e.: externallib.php: get_messages, data_for_message_area_messages, send_instant_messages lib.php: message_post_message api.php: get_messages helper.php: get_messages
42.summary: Messaging: Allow searching within a conversation
description: Just creating this so we can dump some of the code from into here, so we dont lose it. This issue is not a priority for MVP.
43.summary: Messaging: UI: Add searching within a conversation feature to the new UI
description: Scope: Users should be able to search for messages within a conversation - see designs. should have updated the backend web services to facilitate this.
44.summary: For private conversations, let users reply, despite of the privacy preferences, if one of them has the moodle/course:contactanycourseuser
description: In a new capability (moodle/course:contactanycourseuser) has been added to allow users to bypass other privacy messaging preferences. During IR, Andrew has raised a situation where the teacher may contact the student, but the student cannot then reply. This issue is for adding this feature: if convo is private (this will be added in ) and if one member has that capability (contactanycourseuser), then allow the other member to reply.
45.summary: All contact requests between users should be cleaned up if one is accepted
description: If there are 2 users, A and B, and each of them sends the other a contact request then if either A or B accepts the request as the recipient then the request they sent should also be removed (since its now redundant as they are contacts). I guess it could be the same for the opposite scenario too, if the recipient declines a request then maybe it should also remove the request that they sent. Im not 100 sure about this scenario though.
46.summary: A user should be able to decline/cancel a contact request that theyve sent
description: If a user creates a contact request then they should be able to cancel it if it hasnt been accepted/decline by the recipient already.
47.summary: Work out a better way for linked conversations to set their conversation subname
description: Currently, only course groups are linked to conversations, and the subname is the course name, hard coded in the get_conversations() function. This was done due to time restrictions only, and is not a long term solution nor does it scale to other component relationships. We should provide a way for components to specify this subname field, either during creation, or via some other mechanism, so we can achieve the same outcome in a more generic way.
48.summary: Add index conversationid-userid to message_conversation_members table
description: At this moment in time a user can not be in the same conversation twice - if this does happen then it is a bug. Adding an index would prevent duplicate records and alert us to errors quicker.
49.summary: Improve permissions checks in message API
description: Permissions checks in message API are baked into external function wrappers. It sounds like this is existing with messaging but "api" has become a not a usable api by anything outside of messaging. Since this is existing no change is required in this issue.
50.summary: Fix display of html messages
description: Yep, this got borked again. get_conversations() will not return the message in a format that allows things like links, images (all raw html code) to be displayed. We didnt used to return the formatted message for the conversations list on the old UI, which explains this perhaps, but now, we should make our web services behave the same way everywhere. I.e. return the formatted full message.
51.summary: Ordering and blocktimes of php-rendered conversation messages is incorrect
description: This affects the current UI for messaging. NOT the new interface due to land in 3.6 soon. 1. Send some messages to a user and send some back as that user. 2. Now, load up the message/index page If you load the conversation by clicking it, this calls the OLD web service, and the messages are in the correct order. If you refresh the page on the conversation, the ordering comes from the new function, and the messages are out of order.
52.summary: Adapt behat tests to new group messaging functions and UI
description: Some behat tests are failing because default value for messagingallusers is 0, but to get same search results as in deprecated functions, value needs to be 1. Those behat tests had been changed, setting mssagingallusers = 1 in . We should redo those behat tests, decide how many new tests we need, and remove the ones we dont need anymore.
53.summary: Deprecate search_users and search_users_in_course in api.php
description: This function should be removed once new group messaging UI is in place and old messaging UI is removed. For now we are not removing/deprecating this function for backwards compatibility with messaging UI. data_for_messagearea_search_users_in_course external function is deprecated in .
54.summary: Add API function to generate unread counts for conversations by type, with favourites support.
description: This will assist in populating the unread counts for the accordion tabs in the new UI. Lets say we have 10 favourited conversations, and we have 4 of these with unread messages (it doesnt matter how many unread messages per conversation - ignore that), then the unread count for favourites would be 4. Same applies to the group and individual types.
55.summary: Improve performance of sending messages
description: Weve had to duplicate a lot of logic for the old send message stuff in . This needs to be re-worked to improve performance. Things like avoiding some DB queries and multiple checks, making the message processors execute offline with something like cron etc.
56.summary: Replace $CFG->block_online_users_timetosee with a core setting
description: Core code (messagelib, message/manager) should not be dependant on a block setting, so we should create this in core.
57.summary: Messaging: Improve the performance of non-contact searches when site-wide messaging is disabled (default)
description: This currently grabs non-contact users in batches, and checks each users visibility using user_get_user_details_courses(). We may be able to optimise this, so that the generator sql is smarter, and gets users who are more likely to be visible to the current user (shared courses).
58.summary: Actions on view contact page in message drawer should be handled on that page
description: Currently performing an action on a contact (e.g. blocking a user, adding contact etc) redirects the drawer to the conversation page to be corrected. However the the UI prototype has changed this so that the user can complete that action on the contact page and is only redirected after the action is confirmed (or not at all if its cancelled). See
59.summary: User tours for messaging and Dashboard
description: This would surely help.
60.summary: Create new web service for returning contacts to prevent usage of new UI using deprecated web service
description: The web service data_for_messagearea_get_contacts was deprecated but is still used in the new UI introduced in . This issue will be to add a new webservice to replace it, and also deprecate the old get_contacts webservice which will no longer be used by mobile for 3.6. The reason I propose a new web service is because the data_for_messagearea prefix is misleading.
61.summary: It is possible to send empty messages
description: Just try adding a message with just HTML tags, like It creates a new empty message.
62.summary: Improve handling of unread messages in conversations
description: For the first release we just mark all messages in a conversation as read when the user views the conversation however it would be a better user experience to indicate to the user which messages were the unread ones. Perhaps even loading all unread messages first and scrolling them to the earliest of the unread. Take a look at how Telegram treats unread messages for inspiration.
63.summary: Viewing a user from a group members list takes me to the wrong place
description: Given I am in a group conversation And I click on the group title When I click on the name of a user in that conversation Then I should see the Users Messaging Profile I am actually taken to a message page with them which is counter intuitive.
64.summary: Add CSS animation transitions when changing views in UI
description: Originally we had CSS animations to slide the view changes in the messaging UI however I had to remove the animations because they were causing a visual bug in the browser where the "hidden" view wouldnt slide out of view correctly. Here is the commit that removed the styles (in case we want to base new changes off of them): To replicate the bug that cause these to be removed: Have 3 users, s1, s2, and s3 Send some messages between s1 and s2 and between s1 and s3 Have s2 add s1 to their contacts (which creates a contact request for s1) Log in as s1 and view the conversation from the first page in the message drawer You should see the confirm dialogue for the contact request (dont accept or decline it) Go back and switch between the two conversations a couple of times After switching a few times eventually you should see the conversation between s1 and s2 only partially show because the hidden page doesnt correctly animate out of view.
65.summary: Add the ability to mute messaging conversations
description: From a chat, somewhere, to avoid it to be forgotten... dobedobedoh dixit: bq. Another thought if someone could raise it for me: mute conversations Thats all, Ive searched in the tracker trying to find if that had been discussed previously and didnt find anything, so creating this. Ciao :-)
66.summary: Add search functionality on group chat
description: The prototype for the MVP shows search functionality which is missing on the test version. !group chat search.png|thumbnail!
67.summary: Add a capability to prevent users from disabling notifications
description: There does not seem to be a capability for the option to disable notifications on the notification settings page: thus it is not possible to remove this capability and prevent students from disabling all notifications. This is a problem where Moodle is being used as the primary means of communication within a University. We would like the ability to disable this feature so that students could not inadvertently disable all notifications and potentially miss important notices. Please see related
68.summary: Add a capability to prevent users from blocking messages from non-contacts
description: There does not seem to be a capability for the ability to block non contacts from messaging you via the edit preferences > message preferences screen: It would be useful if we could disable this setting for useres to prevent them rendering themselves non messagable by their peers or in some cases their tutors. Please see related
69.summary: Expose get_unread_conversation_counts as a web service
description: We need this because the UI is changing to poll for this when the messaging pane is first opened, rather than doing this one every page load. This is a performance improvement, in the cases where users are not using messaging (or do not intend to, after loading the page).
70.summary: Add new web service to expose number of unread contact requests
description: This is required by the mobile team - see .
71.summary: Review online/offline behaviour for personal messages output because users cant distinct them any more
description: As commented in , the online/offline distinction has been removed on purpose from the messaging user settings page, but it is still working in some cases, like when the user hasnt any default messages preferences and they are defined with different values in Site administration | Plugins | Message outputs | Default message outputs. This confuses a little bit because, by default, on a fresh installation, users will only receive email notifications for personal messages when they wont be connected. However, if they disable and enable Email from the new messaging settings page, they will receive email notifications for private messages always (regardless if they are online or offline). We should review this part to make it more consistent from the users POV. For instance, we could display the online/offline information (when its not the same) to let know it to the user, add some help text to explain how it works or even add it again to the settings page or remove it from the Default message outputs.
72.summary: Keep messaging drawer open on page refresh
description: Currently when using messaging if you open the drawer and then do a page refresh the drawer doesnt appear and you lose where you were in the messaging drawer, which breaks the flow. eg. You are in a conversation with your teacher and they are telling you what resources to click on and then what text to enter etc
73.summary: I just want to reply to a one-off message. I dont want to add a contact, and I dont want to decline
description: Before Moodle 3.6, you could just reploy to one message that someone sent you. In Moodle 3.6, when I try to do that, I get confronted with a Modal dialogue !image-2019-02-04-13-44-13-412.png|thumbnail! I dont want to do either of those things. I want to reply. Note: I got here by clickin a link in the email that said Go to LINK to reply. This is really bad usability.
74.summary: Change the mute icon in the messaging UI
description: Currently we are using the font-awesome icon fa-microphone-slash (see core:i/mute in lib/classes/output/icon_system_fontawesome.php). Ideally we should be using fa-volume-mute but this is not available in the version of FA we are using (4.7). has been created to upgrade this library. When that is done we should change this.
75.summary: Users should be informed that they cant block a user who has permission to message all users
description: Hi there, while testing and trying to understand the newly introduced capabilty, I stumbled over this. Status quo and problem By default the capability _moodle/site:messageanyuser_ is given to the roles Manager, Teacher and Non-editing teacher. The capability has the effect that this user can text to users even if they were blocked. For example. User A is teacher in course X. User B, enrolled as student in course X does not want to receive messages from his teacher and therefore he blocks user A. Then A can still send messages to B. This is absolutely okay, because teachers should be able to text their students in all means. Were just struggling with the unexpectedness of this feature for the student B. He thought that he has blocked A and is confused why he still receives messages and the conclusion might be that he thinks that theres a bug and blocking is not working. Steps to reproduce Having users A and B in your system Make sure that _moodle/site:messageanyuser_ is given to teachers Go to a course X (or create one) and enrol user A as teacher and user B as student Login as user B, open the messaging interface and search for user A In the list, klick on the three dots for user A and klick on context menu item "Block user" Confirm the blocking action by clicking the button "Block" Verify that you see the information "You have blocked this user in the past" with the button "Unblock user" Login as user A Open the messaging interface and search for user B Make sure that you have the messaging text area Enter a message and send it to user B Login as user B and see that hes got a new message from user A and the blocking icon is shown after the name of user A Proposal So were proposing to make this more transparent for the users: If a user wants to block a user that has the capability moodle/site:messageanyuser, the dialogue "Are you sure you want to block XY?" could be altered to something like this: "Are you sure you want to block XY? Attention: Currently the block wont have any effect, because XY has permissions to contact you though." The information that the block currently has no effect should be displayed in the user list, too. For example the strike through icon could be grayed out and some textual explanation could be added. For example something like this (inactive is probably not the correct term, but it should only serve visual support here): !messaging_block_inactive.png! We think with this changes the user should be clear about the status of the blocking action and should not wonder or assume a bug if a user with the capability sends him a message though. Best, Kathrin
76.summary: Messaging: Starred conversations should show up in both the starred and group/individual categories
description: Currently, starred conversations are removed from their respective category when starred. Because this might be (?) confusing, we may want to change this behaviour so that, once starred, a conversation shows up in 2 places: The starred category, and the original (group or private) category.
77.summary: Messaging: revise messaging controls on user profile page
description: In light of changes in , we should ensure the messaging controls on a users profile page are not displayed unless that user can be seen in the messaging search results. For users who are not going to be contactable at all, dont display the links. In the course contact case: if a student views a course contacts profile page, the messaging links (message, add to contacts) wont be presented, but the profile page is still visible. introduces a messaging function which should be used to determine whether one use can see another, specifically in the regards to messaging search results.
78.summary: Add year to messaging conversation date headings, if not the current year
description: See the attached screenshot. If the message listed under the heading "21 March" was sent last year, how would we know? We should see if its possible to format these timestamps conditionally, as we did for the recent message dates in . So (for headings only!): - Timestamps for a date which is NOT inside the current calendar year will be of the format "21 March, 2018". - Timestamps which are inside the current calendar year remain as they are now.
79.summary: Messaging interface assumes secondary color is light shade
description: The messaging interface in Boost uses bg-secondary behind some text but assumes that its a pale shade, since it puts hardcoded gray and dark gray text on top of it. The text colors should use color-yiq functions to ensure they are readable if the secondary color is set to something else.
80.summary: Replace message polling with websockets
description: THIS IS AN MUA PROJECT PROPOSAL THAT WILL BE OR HAS BEEN SUBMITTED FOR POSSIBLE MUA FUNDING. ANY EXISTING TRACKER ITEMS THAT THIS MIGHT DUPLICATE SHOULD BE LINKED TO BELOW. We should replace the current code in the messaging interface that polls the server for new messages with websockets to more efficiently perform these operations. This will improve the performance of the messaging interface and make it feel more responsive for users that would like to conduct real time conversations in it.
81.summary: Add activity module link previews to messages
description: When an activity module link is added to a message we should generate a little link preview for the activity similar to how facebook or other platforms do for links in their messages.
82.summary: Ability to delete all messages in one action
description: The university where I work switched to Moodle version 3.6 last July and the messaging function was not unanimously accepted. In fact, the biggest problem comes from the fact that it is not possible to select conversations in order to be able to delete them all in one action. !image-2019-10-22-16-02-51-024.png|width=306,height=991! The only way right now is to click to read the conversation, then click on the three small dots and click on delete. !image-2019-10-22-16-03-17-306.png! However, a teacher can receive about a hundred messages in a single semester. Is there a way to only select all received messages and delete them (like a mailbox)?
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Make Moodle OBv2.1 implementation compliant and get certification
description: Support to OBv2.1 was added in for Moodle 3.9. However, it was one of the first implementation of this specification and there were no certification process for that. Since then, some early adopters have been working on their OBv2.1 implementations and that has helped to test Moodle implementation. This issue is the epic to collect all the changes required to make Moodle OBv2.1 compliant and fix missing/wrong points.
| Unsolvable | 1.summary: Add new "IMS OBv2.1" OAuth 2 service
description: While testing OBv2.1 with several backpack providers, such as Badgr or CampusLabs, we realised our current OBv2.1 implementation in Moodle is ignoring the content in manifest file /.well-known/badgeconnect.json. Tests with IMS Digital credential service worked in the past because they had .well-known/openid-configuration to discover the endpoints (its not working any more because IMS has changed this testing service too to force to check the expected /.well-known/badgeconnect.json). Information such as authorization, token or revocation end points should be loaded from /.well-known/badgeconnect.json when using OBv2.1. So a new OBv2.1 service should be added to the OAuth 2 services page (/admin/tool/oaut/issuers.php). More information about OBv2.1:
2.summary: Remove "Backpack settings" site administration page and improve UI
description: Site administration page for "Backpack settings" can be removed in order to improve UX: External backpack connection can be moved to "Badges settings". If it is disabled, "Manage backpacks" shouldnt be displayed (as happens now). "Active external backpack" can be removed. The default external backpack will be the first in "List of backpacks" ("Site administration > Badges > Manage backpacks"). So an option for moving up/down should be added (in order to let admins set the default).
3.summary: Backpack API and URL should support more than 50 characters
description: While testing IMS OBv2.1 with the certification platform weve faced this issue: current backpacks dont support more then 255 in the URLs. This restriction should be removed to let users define longer URLs. Steps to reproduce: Login as admin Go to "Site administration > Badges > Manage backpacks". Create a new backpack with an URL longer than 50 (for instance, ) Expected behaviour: Backpack should be created. Current behaviour: An error about the 255 characters limitation is displayed.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Make Moodle OBv2.1 implementation compliant and get certification
description: Support to OBv2.1 was added in for Moodle 3.9. However, it was one of the first implementation of this specification and there were no certification process for that. Since then, some early adopters have been working on their OBv2.1 implementations and that has helped to test Moodle implementation. This issue is the epic to collect all the changes required to make Moodle OBv2.1 compliant and fix missing/wrong points.
### Response:
1.summary: Add new "IMS OBv2.1" OAuth 2 service
description: While testing OBv2.1 with several backpack providers, such as Badgr or CampusLabs, we realised our current OBv2.1 implementation in Moodle is ignoring the content in manifest file /.well-known/badgeconnect.json. Tests with IMS Digital credential service worked in the past because they had .well-known/openid-configuration to discover the endpoints (its not working any more because IMS has changed this testing service too to force to check the expected /.well-known/badgeconnect.json). Information such as authorization, token or revocation end points should be loaded from /.well-known/badgeconnect.json when using OBv2.1. So a new OBv2.1 service should be added to the OAuth 2 services page (/admin/tool/oaut/issuers.php). More information about OBv2.1:
2.summary: Remove "Backpack settings" site administration page and improve UI
description: Site administration page for "Backpack settings" can be removed in order to improve UX: External backpack connection can be moved to "Badges settings". If it is disabled, "Manage backpacks" shouldnt be displayed (as happens now). "Active external backpack" can be removed. The default external backpack will be the first in "List of backpacks" ("Site administration > Badges > Manage backpacks"). So an option for moving up/down should be added (in order to let admins set the default).
3.summary: Backpack API and URL should support more than 50 characters
description: While testing IMS OBv2.1 with the certification platform weve faced this issue: current backpacks dont support more then 255 in the URLs. This restriction should be removed to let users define longer URLs. Steps to reproduce: Login as admin Go to "Site administration > Badges > Manage backpacks". Create a new backpack with an URL longer than 50 (for instance, ) Expected behaviour: Backpack should be created. Current behaviour: An error about the 255 characters limitation is displayed.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Add links and a drop down to navigate between activities
description: When did they go? I dont know. Adding back the next/previous links was rated as a high priority issue for 3.4. This epic collects the user stories and tasks required to complete this work. See --
| Unsolvable | 1.summary: User Stories for next/previous links on activities.
description: ||User Story||Acceptance Criteria|| |As a user, I should be able to step through activities in the course without returning to the course page in order to stay focused on completing activities| Each activity should have a next/previous link in the footer of the content region that will navigate to the next/previous available activity for the course The first activity in the course should not show a previous link. The last activity in the course should not show a next link. The next / previous links should be shown on every page of each activity that uses the in-course layout. The next / previous links should contain the name of the activity that the user will navigate to and an arrow icon indicating next/previous. The user should never see a link to an activity that they cannot access. Stealth activities should not contain previous / next links and should not be displayed in the next/previous links of any other activities. The link to a hidden activity should have a "(hidden)" suffix. The previous link should be displayed on the left side of the page (in ltr languages) and the next link should be displayed on the right (in ltr languages) The previous icon should come before the activity name, and the next icon should come after the activity name. In rtl languages the positions of the next/previous links should be reversed. In rtl languages the direction of the arrow icons should be reversed. When view is required to complete an activity, and an activity completion is required to see the next activity. On the page that triggers the view - the link to the next activity should be immediately displayed and available. Activities that open in a new page (like url) when accessed via next/previous links should not open in a new window - but should show the summary of the activity with a clickable link to open the activity as normal. Continuously clicking on previous links should always take me to the first activity I can see in the course (eventually). Continuously clicking next links should always take me to the last activity I can see for the course.| |As a user I should be able to navigate directly from any activity in a course, to any other activity in the same course.| In between the next / previous links for activities, there should be a drop down listing all the activities in the course. If there is only one visible activity, the drop down should not appear. The text in the drop down before selecting an activity should say "Jump to...". Selecting an activity from the drop down list should navigate directly to that activity. Hidden activities that the user can see should be listed with the "(hidden)" suffix.| |As a user, the next/previous navigation for activities should closely match the navigation for sections, in order to be consistent and predictable.| When viewing a course section, with one section per page enabled and the next section is a hidden section it should not be dimmed, but instead should be an active link with the "(hidden)" suffix. When viewing a course section, with one section per page enabled, any hidden sections in the section navigation drop down should have the "(hidden)" suffix.|
2.summary: Add the previous and next links to navigate between activities
description: These links once existed, but are no more. Lets bring them back. Things to consider - Each activity should have a next/previous link in the footer of the content region that will navigate to the next/previous available activity for the course The first activity in the course should not show a previous link. The last activity in the course should not show a next link. The next / previous links should be shown on every page of each activity that uses the in-course layout. The next / previous links should contain the name of the activity that the user will navigate to and an arrow icon indicating next/previous. The user should never see a link to an activity that they cannot access. Stealth activities should not contain previous / next links and should not be displayed in the next/previous links of any other activities. The link to a hidden activity should have a "(hidden)" suffix. The previous link should be displayed on the left side of the page (in ltr languages) and the next link should be displayed on the right (in ltr languages) The previous icon should come before the activity name, and the next icon should come after the activity name. In rtl languages the positions of the next/previous links should be reversed. In rtl languages the direction of the arrow icons should be reversed. When view is required to complete an activity, and an activity completion is required to see the next activity. On the page that triggers the view - the link to the next activity should be immediately displayed and available. Activities that open in a new page (like url) when accessed via next/previous links should not open in a new window - but should show the summary of the activity with a clickable link to open the activity as normal. Continuously clicking on previous links should always take me to the first activity I can see in the course (eventually). Continuously clicking next links should always take me to the last activity I can see for the course.
3.summary: Add the drop-down to navigate between activities
description: In-between the the next and previous buttons we should have a drop-down that can take a user to other activities, ensuring we only show the ones that they would be able to click on in the course view (consider hidden and restricted activities etc). There is a nice picture in that shows this.
4.summary: Add Behat tests to ensure the navigation between activities work as expected
description: Read summary.
5.summary: Completion data for LTI not updated before rendering navigation
description: Enable completion and availability under Advanced features. Create a course with completion enabled. Create an LTI activity and set it to complete when it is viewed (use if you want). Create an assignment that is restricted until the LTI activity is completed. Enrol a student into this course. Log in as the student. Click on the LTI activity. Notice that there is no link to the assignment even though LTI is completed. Refresh the page. Notice there is now a link to the assignment.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Add links and a drop down to navigate between activities
description: When did they go? I dont know. Adding back the next/previous links was rated as a high priority issue for 3.4. This epic collects the user stories and tasks required to complete this work. See --
### Response:
1.summary: User Stories for next/previous links on activities.
description: ||User Story||Acceptance Criteria|| |As a user, I should be able to step through activities in the course without returning to the course page in order to stay focused on completing activities| Each activity should have a next/previous link in the footer of the content region that will navigate to the next/previous available activity for the course The first activity in the course should not show a previous link. The last activity in the course should not show a next link. The next / previous links should be shown on every page of each activity that uses the in-course layout. The next / previous links should contain the name of the activity that the user will navigate to and an arrow icon indicating next/previous. The user should never see a link to an activity that they cannot access. Stealth activities should not contain previous / next links and should not be displayed in the next/previous links of any other activities. The link to a hidden activity should have a "(hidden)" suffix. The previous link should be displayed on the left side of the page (in ltr languages) and the next link should be displayed on the right (in ltr languages) The previous icon should come before the activity name, and the next icon should come after the activity name. In rtl languages the positions of the next/previous links should be reversed. In rtl languages the direction of the arrow icons should be reversed. When view is required to complete an activity, and an activity completion is required to see the next activity. On the page that triggers the view - the link to the next activity should be immediately displayed and available. Activities that open in a new page (like url) when accessed via next/previous links should not open in a new window - but should show the summary of the activity with a clickable link to open the activity as normal. Continuously clicking on previous links should always take me to the first activity I can see in the course (eventually). Continuously clicking next links should always take me to the last activity I can see for the course.| |As a user I should be able to navigate directly from any activity in a course, to any other activity in the same course.| In between the next / previous links for activities, there should be a drop down listing all the activities in the course. If there is only one visible activity, the drop down should not appear. The text in the drop down before selecting an activity should say "Jump to...". Selecting an activity from the drop down list should navigate directly to that activity. Hidden activities that the user can see should be listed with the "(hidden)" suffix.| |As a user, the next/previous navigation for activities should closely match the navigation for sections, in order to be consistent and predictable.| When viewing a course section, with one section per page enabled and the next section is a hidden section it should not be dimmed, but instead should be an active link with the "(hidden)" suffix. When viewing a course section, with one section per page enabled, any hidden sections in the section navigation drop down should have the "(hidden)" suffix.|
2.summary: Add the previous and next links to navigate between activities
description: These links once existed, but are no more. Lets bring them back. Things to consider - Each activity should have a next/previous link in the footer of the content region that will navigate to the next/previous available activity for the course The first activity in the course should not show a previous link. The last activity in the course should not show a next link. The next / previous links should be shown on every page of each activity that uses the in-course layout. The next / previous links should contain the name of the activity that the user will navigate to and an arrow icon indicating next/previous. The user should never see a link to an activity that they cannot access. Stealth activities should not contain previous / next links and should not be displayed in the next/previous links of any other activities. The link to a hidden activity should have a "(hidden)" suffix. The previous link should be displayed on the left side of the page (in ltr languages) and the next link should be displayed on the right (in ltr languages) The previous icon should come before the activity name, and the next icon should come after the activity name. In rtl languages the positions of the next/previous links should be reversed. In rtl languages the direction of the arrow icons should be reversed. When view is required to complete an activity, and an activity completion is required to see the next activity. On the page that triggers the view - the link to the next activity should be immediately displayed and available. Activities that open in a new page (like url) when accessed via next/previous links should not open in a new window - but should show the summary of the activity with a clickable link to open the activity as normal. Continuously clicking on previous links should always take me to the first activity I can see in the course (eventually). Continuously clicking next links should always take me to the last activity I can see for the course.
3.summary: Add the drop-down to navigate between activities
description: In-between the the next and previous buttons we should have a drop-down that can take a user to other activities, ensuring we only show the ones that they would be able to click on in the course view (consider hidden and restricted activities etc). There is a nice picture in that shows this.
4.summary: Add Behat tests to ensure the navigation between activities work as expected
description: Read summary.
5.summary: Completion data for LTI not updated before rendering navigation
description: Enable completion and availability under Advanced features. Create a course with completion enabled. Create an LTI activity and set it to complete when it is viewed (use if you want). Create an assignment that is restricted until the LTI activity is completed. Enrol a student into this course. Log in as the student. Click on the LTI activity. Notice that there is no link to the assignment even though LTI is completed. Refresh the page. Notice there is now a link to the assignment.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Additional Theme and Navigation changes for Theme "Boost"
description: This is an epic to collect "optional" (not blocking) issues related to the new "Theme Boost" for Moodle 3.2.
| Unsolvable | 1.summary: Convert all the nav block and settings links into contextual lists on each page.
description: Some background to this. Blocks in general are seen by practically all web designers Ive ever met as "old school" and something we should get rid of, or at least deprecate. Many sites hide those blocks in Moodle, indicating they dont like them or find them necessary. Navigating the nav and settings blocks is not particularly nice, even if accessibility work has been done recently. Even without blocks, we still need ways to access the many functions in these blocks. Over in the idea came up to use a list on the left to navigate between a "set" of similar pages. Similar navigation is on a lot of other popular sites, like LinkedIn, Google+, ZenDesk and so on. This issue is to examine the feasibility of using this approach on ALL pages in Moodle, combined with other features, to make the nav and settings blocks obsolete. Some of the other features we should add at the same time are: - Adding a single consistent "gear" icon to (the top-right of) every page that has settings - Adding drop-down menus to the items in the navbar to allow jumps across to other activities, courses, categories - In activities, add Next and Previous buttons. - Adding inline editing to every text we can. - Adding a "zoom" button to toggle all navigation from the page temporarily to focus on content. I think a lot of this can be done by just displaying the navtree structure in a different way - plugin developers would not have to do anything different.
2.summary: Flatten Navigation Tree
description: The navigation tree shows too many nested branches. We want to simplify this tree into a flat list of links showing only the siblings of the current node in the tree. This could/should be done only for the new theme. This new style of navigation should not even be in a block - it should be a renderable added by the theme.
3.summary: Remove blocks from the content section of the page
description: This means moving all the blocks into a new block region accessed from a menu in the header. When opening a new page - no blocks should be visible (navigation tree will no longer be a block).
4.summary: Prototype changes to navigation blocks and settings
description: Build a prototype of the changes to the blocks, navigation and settings so we can evaluate it. These changes will be restricted to the new theme.
5.summary: Add a cog with badges actions on Course > Badges page
description: Add a cog with badges actions on Course > Badges page
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Additional Theme and Navigation changes for Theme "Boost"
description: This is an epic to collect "optional" (not blocking) issues related to the new "Theme Boost" for Moodle 3.2.
### Response:
1.summary: Convert all the nav block and settings links into contextual lists on each page.
description: Some background to this. Blocks in general are seen by practically all web designers Ive ever met as "old school" and something we should get rid of, or at least deprecate. Many sites hide those blocks in Moodle, indicating they dont like them or find them necessary. Navigating the nav and settings blocks is not particularly nice, even if accessibility work has been done recently. Even without blocks, we still need ways to access the many functions in these blocks. Over in the idea came up to use a list on the left to navigate between a "set" of similar pages. Similar navigation is on a lot of other popular sites, like LinkedIn, Google+, ZenDesk and so on. This issue is to examine the feasibility of using this approach on ALL pages in Moodle, combined with other features, to make the nav and settings blocks obsolete. Some of the other features we should add at the same time are: - Adding a single consistent "gear" icon to (the top-right of) every page that has settings - Adding drop-down menus to the items in the navbar to allow jumps across to other activities, courses, categories - In activities, add Next and Previous buttons. - Adding inline editing to every text we can. - Adding a "zoom" button to toggle all navigation from the page temporarily to focus on content. I think a lot of this can be done by just displaying the navtree structure in a different way - plugin developers would not have to do anything different.
2.summary: Flatten Navigation Tree
description: The navigation tree shows too many nested branches. We want to simplify this tree into a flat list of links showing only the siblings of the current node in the tree. This could/should be done only for the new theme. This new style of navigation should not even be in a block - it should be a renderable added by the theme.
3.summary: Remove blocks from the content section of the page
description: This means moving all the blocks into a new block region accessed from a menu in the header. When opening a new page - no blocks should be visible (navigation tree will no longer be a block).
4.summary: Prototype changes to navigation blocks and settings
description: Build a prototype of the changes to the blocks, navigation and settings so we can evaluate it. These changes will be restricted to the new theme.
5.summary: Add a cog with badges actions on Course > Badges page
description: Add a cog with badges actions on Course > Badges page
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Boost 4.0 Migration
description: This epic covers the work to convert from the original BS4 Alpha 3 integration to BS4.0.
| Unsolvable | 1.summary: Update bootstrap 4 to final release
description: The new release plan for bootstrap 4 is to go up to alpha 6, then switch to more stable betas. Alpha 5 just came out.
2.summary: Implement course images for the myoverview block
description: The myoverview block is being redesigned based on UX studies and the work done by the Moodle UX team. Changes will be done step by step. The first step is to add images to the course to create nice course cards. The images are used above the card content. User can add a custom image using the course edit form, this form allows for the upload of an image file. All cards need to have an image for the design to make sense. In case no image is available Moodle will generate a geopattern image using the geopattern library. The geopattern library can create semi-random patterns based on the course name. The attached commit includes changes for bootstrapbase and theme boost.
3.summary: Atto editor appears clipped in new boost
description: See attached screenshot: there is no ability to make the editor window wider, only taller the icons are shown very close to the right-hand side making it feel clipped !attoclip.png|thumbnail!
4.summary: Messaging between users appears broken
description: See screenshots. Originally reported in .
5.summary: Quiz: Review options section poor layout in boost theme
description: On the quiz editing page, on the boost theme only, the Review options section has a poor layout. Please see screen shots.
6.summary: Update Boost readme for Bootstrap 4 stable upgrade
description: The changes related presets, bootswatches and typography have been changed during development. The upgrade.txt needs to be updated based on these changes.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Boost 4.0 Migration
description: This epic covers the work to convert from the original BS4 Alpha 3 integration to BS4.0.
### Response:
1.summary: Update bootstrap 4 to final release
description: The new release plan for bootstrap 4 is to go up to alpha 6, then switch to more stable betas. Alpha 5 just came out.
2.summary: Implement course images for the myoverview block
description: The myoverview block is being redesigned based on UX studies and the work done by the Moodle UX team. Changes will be done step by step. The first step is to add images to the course to create nice course cards. The images are used above the card content. User can add a custom image using the course edit form, this form allows for the upload of an image file. All cards need to have an image for the design to make sense. In case no image is available Moodle will generate a geopattern image using the geopattern library. The geopattern library can create semi-random patterns based on the course name. The attached commit includes changes for bootstrapbase and theme boost.
3.summary: Atto editor appears clipped in new boost
description: See attached screenshot: there is no ability to make the editor window wider, only taller the icons are shown very close to the right-hand side making it feel clipped !attoclip.png|thumbnail!
4.summary: Messaging between users appears broken
description: See screenshots. Originally reported in .
5.summary: Quiz: Review options section poor layout in boost theme
description: On the quiz editing page, on the boost theme only, the Review options section has a poor layout. Please see screen shots.
6.summary: Update Boost readme for Bootstrap 4 stable upgrade
description: The changes related presets, bootswatches and typography have been changed during development. The upgrade.txt needs to be updated based on these changes.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Prepare feedback module for the Mobile app
description: - Move some view.php/continue.php code to functions - Add required web services - Implement the check_updates callback Spec: (wip)
| Unsolvable | 1.summary: New Web Service mod_feedback_get_feedbacks_by_courses
description: Retrieve a list of feedbacks from several courses
2.summary: New Web Service mod_feedback_view_feedback
description: To mark view completed and optionally launch the mod viewed event
3.summary: New Web Service mod_feedback_get_feedback_access_information
description: To retrieve the current user status in a given feedback before starting or continuing it. With this information, the app will be able to print the appropriate messages before starting or continuing a feedback (maybe the user could not continue, re-takes are not allowed, etc )
4.summary: New Web Service mod_feedback_get_last_completed
description: Return the last feedback completed by the user (empty for anonymous)
5.summary: New Web Service mod_feedback_get_current_completed_tmp
description: Return the current uncompleted feedback for the user
6.summary: New Web Service mod_feedback_get_items
description: Return a complete list of the questions in a feedback so external clients (like the mobile app) can calculate the amount of information to download.
7.summary: New Web Service mod_feedback_launch_feedback
description: This WS should be used before starting or when continuing a feedback. The main goal of this WS is to return the last page the user completed in a feedback, so we can redirect them via the mod_feedback_get_page_items web service function
8.summary: New Web Service mod_feedback_get_page_items
description: Get a single feedback page information including questions
9.summary: New Web Service mod_feedback_process_page
description: Processes a jump between pages.
10.summary: New Web Service mod_feedback_submit_feedback
description: Submit a feedback (finishes it)
11.summary: New Web Service mod_feedback_get_analysis
description: Return the feedback responses analysis
12.summary: New Web Service mod_feedback_get_responses_analysis
description: Return the feedback user responses
13.summary: New Web Service mod_feedback_get_non_respondents
description: Return a list of the people who actually didn t respond
14.summary: Implement the check_updates callback in the feedback module
description: We need this callback so the mobile app is able to check for updates in the feedback module in order to update the download/update status of the activity in the course.
15.summary: Add generators for items in the feedback module
description: The feedback module is missing generators for items. We need them to be able to create data for Web Services unit tests.
16.summary: New Web Service mod_feeback_get_unfinished_responses
description: Retrieves responses from an unfinished attempt
17.summary: New Web Service mod_feedback_get_finished_responses
description: Return the list of finished responses
18.summary: Improve mod_feedback_get_non_respondents to return required data
description: The current implementation does not return all the required data to render properly the information.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Prepare feedback module for the Mobile app
description: - Move some view.php/continue.php code to functions - Add required web services - Implement the check_updates callback Spec: (wip)
### Response:
1.summary: New Web Service mod_feedback_get_feedbacks_by_courses
description: Retrieve a list of feedbacks from several courses
2.summary: New Web Service mod_feedback_view_feedback
description: To mark view completed and optionally launch the mod viewed event
3.summary: New Web Service mod_feedback_get_feedback_access_information
description: To retrieve the current user status in a given feedback before starting or continuing it. With this information, the app will be able to print the appropriate messages before starting or continuing a feedback (maybe the user could not continue, re-takes are not allowed, etc )
4.summary: New Web Service mod_feedback_get_last_completed
description: Return the last feedback completed by the user (empty for anonymous)
5.summary: New Web Service mod_feedback_get_current_completed_tmp
description: Return the current uncompleted feedback for the user
6.summary: New Web Service mod_feedback_get_items
description: Return a complete list of the questions in a feedback so external clients (like the mobile app) can calculate the amount of information to download.
7.summary: New Web Service mod_feedback_launch_feedback
description: This WS should be used before starting or when continuing a feedback. The main goal of this WS is to return the last page the user completed in a feedback, so we can redirect them via the mod_feedback_get_page_items web service function
8.summary: New Web Service mod_feedback_get_page_items
description: Get a single feedback page information including questions
9.summary: New Web Service mod_feedback_process_page
description: Processes a jump between pages.
10.summary: New Web Service mod_feedback_submit_feedback
description: Submit a feedback (finishes it)
11.summary: New Web Service mod_feedback_get_analysis
description: Return the feedback responses analysis
12.summary: New Web Service mod_feedback_get_responses_analysis
description: Return the feedback user responses
13.summary: New Web Service mod_feedback_get_non_respondents
description: Return a list of the people who actually didn t respond
14.summary: Implement the check_updates callback in the feedback module
description: We need this callback so the mobile app is able to check for updates in the feedback module in order to update the download/update status of the activity in the course.
15.summary: Add generators for items in the feedback module
description: The feedback module is missing generators for items. We need them to be able to create data for Web Services unit tests.
16.summary: New Web Service mod_feeback_get_unfinished_responses
description: Retrieves responses from an unfinished attempt
17.summary: New Web Service mod_feedback_get_finished_responses
description: Return the list of finished responses
18.summary: Improve mod_feedback_get_non_respondents to return required data
description: The current implementation does not return all the required data to render properly the information.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Deprecate the bootstrapbase theme and remove from core
description: Boost is the new default. Time to start deprecation of clean and bootstrapbase.
| Unsolvable | 1.summary: Move all templates from boost to core and (where relevant) core to bootstrapbase
description: All core templates should now belong to boost rather than bootstrapbase. We need to: move all existing core templates which are overridden by boost into the bootstrapbase theme move all templates from boost to core
2.summary: Introduce the classic theme to core
description: Implement the theme available at into core. Within the classic repo: Remove LICENSE Remove README.txt Check version.php Add to lib/classes/plugin_manager.php list of core plugins There are a few remaining bits to complete, notably: Check if templates are still required once lands Check for any behat changes/overrides required Add a more detailed choosereadme language string in /theme/classic/lang/en/theme_classic.php Block docking has been added as a separate linked issue, which can land after the introduction of the theme if needed. Also: Prototype site ASAP
3.summary: Remove clean theme
description: Remove the clean and bootstrapbase themes. This changes should also consider: removing the less compilers from both php and grunt removing old references to bootstrapbase: /lib/adminlib.php : bootstrap_renderer /lib/outputlib.php : find_theme_config(bootstrapbase, /lib/weblib.php : bootstrap_renderer:: /lib/setuplib.php: bootstrap_renderer:: updating any unit tests which make use of the clean theme to make it use classic instead. There are some which test theme availability and fallback.
4.summary: Remove the unused footer template from Classic theme
description: The footer within the Classic theme (/theme/classic/templates/core/footer.mustache) is not actually used, it uses the Boost footer in its templates. Given the footer is also almost identical (but is missing some aria elements), it should be removed from the theme.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Deprecate the bootstrapbase theme and remove from core
description: Boost is the new default. Time to start deprecation of clean and bootstrapbase.
### Response:
1.summary: Move all templates from boost to core and (where relevant) core to bootstrapbase
description: All core templates should now belong to boost rather than bootstrapbase. We need to: move all existing core templates which are overridden by boost into the bootstrapbase theme move all templates from boost to core
2.summary: Introduce the classic theme to core
description: Implement the theme available at into core. Within the classic repo: Remove LICENSE Remove README.txt Check version.php Add to lib/classes/plugin_manager.php list of core plugins There are a few remaining bits to complete, notably: Check if templates are still required once lands Check for any behat changes/overrides required Add a more detailed choosereadme language string in /theme/classic/lang/en/theme_classic.php Block docking has been added as a separate linked issue, which can land after the introduction of the theme if needed. Also: Prototype site ASAP
3.summary: Remove clean theme
description: Remove the clean and bootstrapbase themes. This changes should also consider: removing the less compilers from both php and grunt removing old references to bootstrapbase: /lib/adminlib.php : bootstrap_renderer /lib/outputlib.php : find_theme_config(bootstrapbase, /lib/weblib.php : bootstrap_renderer:: /lib/setuplib.php: bootstrap_renderer:: updating any unit tests which make use of the clean theme to make it use classic instead. There are some which test theme availability and fallback.
4.summary: Remove the unused footer template from Classic theme
description: The footer within the Classic theme (/theme/classic/templates/core/footer.mustache) is not actually used, it uses the Boost footer in its templates. Given the footer is also almost identical (but is missing some aria elements), it should be removed from the theme.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Do organisations want to run their own MoodleNet instance?
description: Users can choose a MoodleNet instance to join and sign in with their social account. Organisations can set up their own instance and enter an API key to access the functionality of Moodle HQ s API-as-a-service (e.g. federated search, profile discovery)
| Unsolvable | 1.summary: Spec out admin dashboard for federated instances
description: We should use this issue to talk about longer-term admin features. The MVP admin dashboard issue is ----- Older info: Ive been talking to Gavin have doing some value proposition work. In particular, system admins deploying a MoodleNet instance want to avoid: 1. Potential data loss (files shared which shouldnt be) 2. Leakage of private data, (account information - MoodleNet hub knowing a user exists in their site...) when they SSO 3. Potential use of illegal or unlicensed materials in the site 4. Requiring hosting of YAS (yet another system, with new hosting requirements) and maintenance... etc We can deal with this via an admin dashboard which provides reporting on whats been shared and where. Depending on the feedback we get from partners and institutions, we may need to negotiate around sensible defaults.
2.summary: Delete a user and handle the relations
description: When a user is deleted not all her information is deleted: Comments should be set to empty strings and author should be null Community/Collection/Resource creator should be null Activity actors should be null User it self should be completely deleted This is also needed in because in this data migration we are losing some data we dont know the _attributedTo_ of the old entities.
3.summary: Implement webfinger for MN actors to allow discovery and @ mentions
description: Implement webfinger for actor discovery and @ mentions inter-operable with Mastodon and other fediverse platforms
4.summary: UX for fediverse users to remote-follow MN users
description: .
5.summary: ActivityPub Pagination for lists
description: In ActivityPub you can iterate a long list--_Collection_ in AP vocabulary using _CollectionPage_. Because they are ephimeral, the content of the a page changes continously, the implementation should be different to other AP entities and they shouldnt be stored in the database.
6.summary: Change some AP fields to be more standard
description: Currently, the community of a collection is set using the field _attributedTo._ It also happens with collection resource relation. We have to change to the field _context_. The _attributedTo_ will be the user who created the entity now. The GraphQL API should be updated to reflect these changes. Its also important to review the activity audience the _to_ field of each activity.
7.summary: New collections to store inverse relations
description: We need some new collections to make the inverse relations in the AP vocabulary; ie: The _context_ of a resource is its collection, now we need an AP collection a list in the collection named "resource list" with all the resources in this collection. Similar problem with the community which needs the list of collection that includes. We also need a collection for threads, tlisthe with all the threads in a community or a collection.
8.summary: Configurable URL for AP IDs
description: The Phoenix configuration to build URL may not be the same for the ActivityPub IDs, ie: working behind a proxy. So we need to add a configuration for ActivityPub to build the IDs independently of Phoenix configuration.
9.summary: Use ID instead of localID for any query in GraphQL
description: Because external entities could not have localID, we should always use the ID. This way it is possible to fetch information of entities which arent currently stored in the server.
10.summary: Implement webfinger discovery to allow finding and @ mentioning fediverse accounts
description: Implement webfinger discovery to allow finding and @ mentioning fediverse accounts
11.summary: Implement ActivityPub server-to-server REST API (inbox/outbox/retrieving/posting)
description: See "General ActivityPub server-to-server flows" section in this doc:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Do organisations want to run their own MoodleNet instance?
description: Users can choose a MoodleNet instance to join and sign in with their social account. Organisations can set up their own instance and enter an API key to access the functionality of Moodle HQ s API-as-a-service (e.g. federated search, profile discovery)
### Response:
1.summary: Spec out admin dashboard for federated instances
description: We should use this issue to talk about longer-term admin features. The MVP admin dashboard issue is ----- Older info: Ive been talking to Gavin have doing some value proposition work. In particular, system admins deploying a MoodleNet instance want to avoid: 1. Potential data loss (files shared which shouldnt be) 2. Leakage of private data, (account information - MoodleNet hub knowing a user exists in their site...) when they SSO 3. Potential use of illegal or unlicensed materials in the site 4. Requiring hosting of YAS (yet another system, with new hosting requirements) and maintenance... etc We can deal with this via an admin dashboard which provides reporting on whats been shared and where. Depending on the feedback we get from partners and institutions, we may need to negotiate around sensible defaults.
2.summary: Delete a user and handle the relations
description: When a user is deleted not all her information is deleted: Comments should be set to empty strings and author should be null Community/Collection/Resource creator should be null Activity actors should be null User it self should be completely deleted This is also needed in because in this data migration we are losing some data we dont know the _attributedTo_ of the old entities.
3.summary: Implement webfinger for MN actors to allow discovery and @ mentions
description: Implement webfinger for actor discovery and @ mentions inter-operable with Mastodon and other fediverse platforms
4.summary: UX for fediverse users to remote-follow MN users
description: .
5.summary: ActivityPub Pagination for lists
description: In ActivityPub you can iterate a long list--_Collection_ in AP vocabulary using _CollectionPage_. Because they are ephimeral, the content of the a page changes continously, the implementation should be different to other AP entities and they shouldnt be stored in the database.
6.summary: Change some AP fields to be more standard
description: Currently, the community of a collection is set using the field _attributedTo._ It also happens with collection resource relation. We have to change to the field _context_. The _attributedTo_ will be the user who created the entity now. The GraphQL API should be updated to reflect these changes. Its also important to review the activity audience the _to_ field of each activity.
7.summary: New collections to store inverse relations
description: We need some new collections to make the inverse relations in the AP vocabulary; ie: The _context_ of a resource is its collection, now we need an AP collection a list in the collection named "resource list" with all the resources in this collection. Similar problem with the community which needs the list of collection that includes. We also need a collection for threads, tlisthe with all the threads in a community or a collection.
8.summary: Configurable URL for AP IDs
description: The Phoenix configuration to build URL may not be the same for the ActivityPub IDs, ie: working behind a proxy. So we need to add a configuration for ActivityPub to build the IDs independently of Phoenix configuration.
9.summary: Use ID instead of localID for any query in GraphQL
description: Because external entities could not have localID, we should always use the ID. This way it is possible to fetch information of entities which arent currently stored in the server.
10.summary: Implement webfinger discovery to allow finding and @ mentioning fediverse accounts
description: Implement webfinger discovery to allow finding and @ mentioning fediverse accounts
11.summary: Implement ActivityPub server-to-server REST API (inbox/outbox/retrieving/posting)
description: See "General ActivityPub server-to-server flows" section in this doc:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Review third party libraries for new versions (3.8)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
| Unsolvable | 1.summary: Upgrade Horde library to 5.2.22
description: creating this issue long in advance before 3.5 libraries upgrade start. We have previously closed several rounds of Horde upgrade because there were "no changes upstream". However says that this repo is deprecated and separate repos should be used. We will need to re-write the upgrade instructions as part of this upgrade Im patching horde for 3.4 release in because its too late to do a proper upgrade now.
2.summary: VideoJS upgrade to 7.6.5 including HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (MPEG-DASH) support
description: This is the latest stable 7.x version of player. For the list of changes see All VideoJS plugins need to be upgraded to the latest release as well. It includes HLS and MPEG-DASH support.
3.summary: Update bootstrap to version 4.3.1
description: Update the Bootstrap JS and SASS to version 4.3.1
4.summary: Upgrade ADODB to 5.20.14
description: AdoDB /lib/adodb/ 5.20.09 5.20.14 Yes
5.summary: Replace PHPExcel with PHPSpreadsheet
description:
6.summary: Upgrade HTML Purifier to 4.10.0
description: HTML Purifier /lib/htmlpurifier/ 4.09.3 4.10.0 Yes
7.summary: Upgrade lib\minify to 1.3.61
description: lib\minify\readme_moodle.txt implies both of these should be upgraded at the same time. MatthiasMullie\Minify /lib/minify/matthiasmullie-minify/ 1.3.51 1.3.61 Yes MatthiasMullie\PathConverter /lib/minify/matthiasmullie-pathconverter/ 1.1.0 1.1.2 Yes
8.summary: Upgrade MatthiasMullie\PathConverter
description: MatthiasMullie\PathConverter /lib/minify/matthiasmullie-pathconverter/ 1.1.0 1.1.2 Yes
9.summary: Remove unused Pear_Auth_Radius library
description: Pear_Auth_Radius /lib/pear/Auth/RADIUS.php 1.1.0 1.1.0 No Not used in core (assignee to re-confirm).
10.summary: Removed unused Pear_Crypt_CHAP library
description: Pear_Crypt_CHAP /lib/pear/Crypt/CHAP.php 1.1 Not used in core (assignee to re-confirm).
11.summary: Upgrade Pear.php
description: Pear.php /lib/pear/PEAR.php 1.4.5 1.10.9 Yes Confirm whether this is actually a useful change with reference .
12.summary: Upgrade PHPMailer to 6.0.7
description: PHPMailer /lib/phpmailer/ 6.0.1 6.0.7 Note: includes several security updates. Confirm whether we are affected by these concerns and whether these therefore must also be backported.
13.summary: Upgrade SimplePie to 1.5.2
description: SimplePie /lib/simplepie/ 1.5.0 1.5.2 Yes As an alternative, look into replacing with a maintained alternative.
14.summary: Upgrade jQuery to 3.4.1
description: jQuery /lib/jquery/ 3.2.1 3.4.1 Yes
15.summary: Upgrade HTML2Text to 4.2.1
description: HTML2Text /lib/html2text/ 4.1.0 4.2.1 Yes
16.summary: Upgrade Markdown to 1.8.0
description: Markdown original+extra /lib/markdown/ 1.7.0 1.8.0 Yes
17.summary: Remove ReCaptcha v1
description: ReCAPTCHA /lib/recaptchalib.php 1.1 DEAD
18.summary: Upgrade RequireJS
description: RequireJS /lib/requirejs/ 2.3.5 2.3.6 Yes The only changes between 2.3.5 and 2.3.6 are documentation.
19.summary: Upgrade loglevel.js to 1.6.2
description: loglevel.js /lib/amd/src/loglevel.js 1.5.1 1.6.2 Can be skipped, or can do this now so that we are on the latest release as the project hasnt seen any other upgrades for 18 months.
20.summary: Upgrade mustache.js to 3.0.1
description: Theres a major version bump here so we want to get on top of it ASAP. Mustache.js /lib/amd/src/mustache.js 2.3.0 3.0.1 Yes
21.summary: Upgrade Sabberworm/PHP-CSS-Parser to 8.3.0
description: PHP-CSS-Parser /lib/php-css-parser/ 8.1.0 8.3.0 Yes Contains many of our fixes, and adds support for `calc()` and alpha values. No deprecations or b/c breakages.
22.summary: Upgrade SCSSPHP to 0.7.5
description: scssphp /lib/scssphp/ 0.7.5 1.0.0 As I mentioned in the comments leafo/scssphp has now moved to scssphp/scssphp so we should migrate to use the newest version with bug fixes etc
23.summary: Upgrade Box::Spout to 3.0.1
description: Spout /lib/spout/ 2.7.3 3.0.0 Yes Upgrade guide: Our use of the library is largely contained in our abstraction but we should ensure upgrade notes are complete and reference the official docs as there are some breaking changes.
24.summary: Upgrade GeoIP2 and MaxMind DB reader
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.6.0 2.9.0 Yes MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.3 1.4.1 Yes Note: The changes may be so minor as to not warrant an upgrade.
25.summary: Upgrade MaxMind DB reader
description: MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.3 1.4.1 Yes
26.summary: Consider upgrade approach for Fontawesome
description: FA 5 is now out but comes with breaking changes from 4 (incons no longer available in the free version). We need to consider how we handle future upgrade. Font Awesome by Dave Gandy - /lib//fonts/ 4.7.0 5.8.2 Yes
27.summary: Upgrade WebRTC to 6.4.0
description: WebRTC adapter /lib/amd/src/adapter.js 6.1.5 6.4.0
28.summary: Upgrade phpCAS to 1.3.7
description: CAS /auth/cas/CAS/ 1.3.5 1.3.7 Yes Alternatively investigate seeing whether anyone in the community would like to take over maintenance of auth_cas. We do not have the expertise in-house to maintain this plugin as well as we would like.
29.summary: Upgrade PHP-ML
description: PHP-ML /lib/mlbackend/php/phpml/ 0.4.1+ 0.8.0 Yes Pinging dmonllao re this one.
30.summary: Upgrade jQuery EU Cookie Law popups to 1.1.2
description: jQuery EU Cookie Law popups /admin/tool/policy/amd/src/jquery-eu-cookie-law-popup.js 1.0.1 1.1.2 Yes Looks like this is primarily a documentation fix.
31.summary: Upgrade MongoDB PHP Library to 1.4.2
description: MongoDB PHP Library /cache/stores/mongodb/MongoDB/ 1.4 1.4.2 Yes
32.summary: Upgrade boost to use Bootstrap 4.3
description: Investigate whether it is possible to upgrade to Bootstrap 4.3. Twitter Bootstrap /theme/boost/scss/bootstrap/ 4.0.0 4.3.1 Yes
33.summary: Upgrade FPDI to v2 API
description: FPDI /mod/assign/feedback/editpdf/fpdi/ 1.6.2 2.2.0 Yes
34.summary: Upgrade TCPDF to 6.2.26
description: TCPDF /lib/tcpdf/ 6.2.13 6.2.26 Yes Used by FPDI and PDF classes.
35.summary: Upgrade PHPMailer
description: PHPMailer /lib/phpmailer/ 6.0.1 6.0.7
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Review third party libraries for new versions (3.8)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review. Libraries review here:
### Response:
1.summary: Upgrade Horde library to 5.2.22
description: creating this issue long in advance before 3.5 libraries upgrade start. We have previously closed several rounds of Horde upgrade because there were "no changes upstream". However says that this repo is deprecated and separate repos should be used. We will need to re-write the upgrade instructions as part of this upgrade Im patching horde for 3.4 release in because its too late to do a proper upgrade now.
2.summary: VideoJS upgrade to 7.6.5 including HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (MPEG-DASH) support
description: This is the latest stable 7.x version of player. For the list of changes see All VideoJS plugins need to be upgraded to the latest release as well. It includes HLS and MPEG-DASH support.
3.summary: Update bootstrap to version 4.3.1
description: Update the Bootstrap JS and SASS to version 4.3.1
4.summary: Upgrade ADODB to 5.20.14
description: AdoDB /lib/adodb/ 5.20.09 5.20.14 Yes
5.summary: Replace PHPExcel with PHPSpreadsheet
description:
6.summary: Upgrade HTML Purifier to 4.10.0
description: HTML Purifier /lib/htmlpurifier/ 4.09.3 4.10.0 Yes
7.summary: Upgrade lib\minify to 1.3.61
description: lib\minify\readme_moodle.txt implies both of these should be upgraded at the same time. MatthiasMullie\Minify /lib/minify/matthiasmullie-minify/ 1.3.51 1.3.61 Yes MatthiasMullie\PathConverter /lib/minify/matthiasmullie-pathconverter/ 1.1.0 1.1.2 Yes
8.summary: Upgrade MatthiasMullie\PathConverter
description: MatthiasMullie\PathConverter /lib/minify/matthiasmullie-pathconverter/ 1.1.0 1.1.2 Yes
9.summary: Remove unused Pear_Auth_Radius library
description: Pear_Auth_Radius /lib/pear/Auth/RADIUS.php 1.1.0 1.1.0 No Not used in core (assignee to re-confirm).
10.summary: Removed unused Pear_Crypt_CHAP library
description: Pear_Crypt_CHAP /lib/pear/Crypt/CHAP.php 1.1 Not used in core (assignee to re-confirm).
11.summary: Upgrade Pear.php
description: Pear.php /lib/pear/PEAR.php 1.4.5 1.10.9 Yes Confirm whether this is actually a useful change with reference .
12.summary: Upgrade PHPMailer to 6.0.7
description: PHPMailer /lib/phpmailer/ 6.0.1 6.0.7 Note: includes several security updates. Confirm whether we are affected by these concerns and whether these therefore must also be backported.
13.summary: Upgrade SimplePie to 1.5.2
description: SimplePie /lib/simplepie/ 1.5.0 1.5.2 Yes As an alternative, look into replacing with a maintained alternative.
14.summary: Upgrade jQuery to 3.4.1
description: jQuery /lib/jquery/ 3.2.1 3.4.1 Yes
15.summary: Upgrade HTML2Text to 4.2.1
description: HTML2Text /lib/html2text/ 4.1.0 4.2.1 Yes
16.summary: Upgrade Markdown to 1.8.0
description: Markdown original+extra /lib/markdown/ 1.7.0 1.8.0 Yes
17.summary: Remove ReCaptcha v1
description: ReCAPTCHA /lib/recaptchalib.php 1.1 DEAD
18.summary: Upgrade RequireJS
description: RequireJS /lib/requirejs/ 2.3.5 2.3.6 Yes The only changes between 2.3.5 and 2.3.6 are documentation.
19.summary: Upgrade loglevel.js to 1.6.2
description: loglevel.js /lib/amd/src/loglevel.js 1.5.1 1.6.2 Can be skipped, or can do this now so that we are on the latest release as the project hasnt seen any other upgrades for 18 months.
20.summary: Upgrade mustache.js to 3.0.1
description: Theres a major version bump here so we want to get on top of it ASAP. Mustache.js /lib/amd/src/mustache.js 2.3.0 3.0.1 Yes
21.summary: Upgrade Sabberworm/PHP-CSS-Parser to 8.3.0
description: PHP-CSS-Parser /lib/php-css-parser/ 8.1.0 8.3.0 Yes Contains many of our fixes, and adds support for `calc()` and alpha values. No deprecations or b/c breakages.
22.summary: Upgrade SCSSPHP to 0.7.5
description: scssphp /lib/scssphp/ 0.7.5 1.0.0 As I mentioned in the comments leafo/scssphp has now moved to scssphp/scssphp so we should migrate to use the newest version with bug fixes etc
23.summary: Upgrade Box::Spout to 3.0.1
description: Spout /lib/spout/ 2.7.3 3.0.0 Yes Upgrade guide: Our use of the library is largely contained in our abstraction but we should ensure upgrade notes are complete and reference the official docs as there are some breaking changes.
24.summary: Upgrade GeoIP2 and MaxMind DB reader
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.6.0 2.9.0 Yes MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.3 1.4.1 Yes Note: The changes may be so minor as to not warrant an upgrade.
25.summary: Upgrade MaxMind DB reader
description: MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.3 1.4.1 Yes
26.summary: Consider upgrade approach for Fontawesome
description: FA 5 is now out but comes with breaking changes from 4 (incons no longer available in the free version). We need to consider how we handle future upgrade. Font Awesome by Dave Gandy - /lib//fonts/ 4.7.0 5.8.2 Yes
27.summary: Upgrade WebRTC to 6.4.0
description: WebRTC adapter /lib/amd/src/adapter.js 6.1.5 6.4.0
28.summary: Upgrade phpCAS to 1.3.7
description: CAS /auth/cas/CAS/ 1.3.5 1.3.7 Yes Alternatively investigate seeing whether anyone in the community would like to take over maintenance of auth_cas. We do not have the expertise in-house to maintain this plugin as well as we would like.
29.summary: Upgrade PHP-ML
description: PHP-ML /lib/mlbackend/php/phpml/ 0.4.1+ 0.8.0 Yes Pinging dmonllao re this one.
30.summary: Upgrade jQuery EU Cookie Law popups to 1.1.2
description: jQuery EU Cookie Law popups /admin/tool/policy/amd/src/jquery-eu-cookie-law-popup.js 1.0.1 1.1.2 Yes Looks like this is primarily a documentation fix.
31.summary: Upgrade MongoDB PHP Library to 1.4.2
description: MongoDB PHP Library /cache/stores/mongodb/MongoDB/ 1.4 1.4.2 Yes
32.summary: Upgrade boost to use Bootstrap 4.3
description: Investigate whether it is possible to upgrade to Bootstrap 4.3. Twitter Bootstrap /theme/boost/scss/bootstrap/ 4.0.0 4.3.1 Yes
33.summary: Upgrade FPDI to v2 API
description: FPDI /mod/assign/feedback/editpdf/fpdi/ 1.6.2 2.2.0 Yes
34.summary: Upgrade TCPDF to 6.2.26
description: TCPDF /lib/tcpdf/ 6.2.13 6.2.26 Yes Used by FPDI and PDF classes.
35.summary: Upgrade PHPMailer
description: PHPMailer /lib/phpmailer/ 6.0.1 6.0.7
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Stop repeating db queries
description: We all know that moodle sends lots of db reads to the db server but while working on (trying to reduce the number of db reads) Ive realized that in some cases this goes too far, for example a mod_assign grading page sends 433 db reads and it is not in a specially big course: About 16 users 8 groups Assignment with team submissions and a few submissions 265 of these 433 are repeated db reads, and this is not an isolated case, Ive tried different mod_assign activities combinations and the numbers are always high, Ive also been browsing through a few pages and sometimes we just have 1-5 repeated db reads, which is "more or less" acceptable knowing that most of our pages have more than 70-80 db reads and moodle is a monster, but there are many cases (not only in mod_assign, this is all around moodle) where we could save a big big of db queries caching results. I know though that sometimes we should repeat the same db query because we have to, but when we repeat that big of queries is because we are doing something wrong and we should prevent it. Attaching a patch to show the number of repeated db reads in case I am missing something and I am wrong, but seems that we have a lot of margin to improve performance even though these queries are cached in the db engine, we are still connecting to the db server. The patch outputs a debugging() message for each repeated query, I know we can not integrate this, it is there just to scare you :) but would be important to show the number of repeated db reads on the footer so we know where and what we can improve
| Unsolvable | 1.summary: Improve filter_data performance on large sites
description: As a follow-on to which removed global text caching, we need to examine the database filter and probably add MUC caching there to improve performance. The database filter is what puts links in texts to database entries. There is quite a lot of processing going on in the background even before the simple text replacement, and this needs to be redone every time the cache is invalidated. Petr has raised that the fully correct way would be to use new events or the as-yet-unwritten hooks to invalidate the caches, but I think that might be too much to do before 2.7, so I want to see a quick solution here even if it may mean relying on less-perfect cache invalidation. Tests showing performance before/after are required.
2.summary: Improve performance when saving administration settings
description: admin_write_settings() includes a admin_get_root(true) as part of its code and all the calls to admin_write_settings() in core are refreshing again the admin tree. We could get rid of the admin_write_settings() one in master, in stables we could add an extra $reloadadmintree argument to admin_write_settings() that can default to true and change the calls to admin_write_settings($data, false)
3.summary: Use the Moodle roles cache
description: There are many queries to mdl_role without any join with other tables, some db engines should cache the queries, but would be better if they dont even reach the db driver
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Stop repeating db queries
description: We all know that moodle sends lots of db reads to the db server but while working on (trying to reduce the number of db reads) Ive realized that in some cases this goes too far, for example a mod_assign grading page sends 433 db reads and it is not in a specially big course: About 16 users 8 groups Assignment with team submissions and a few submissions 265 of these 433 are repeated db reads, and this is not an isolated case, Ive tried different mod_assign activities combinations and the numbers are always high, Ive also been browsing through a few pages and sometimes we just have 1-5 repeated db reads, which is "more or less" acceptable knowing that most of our pages have more than 70-80 db reads and moodle is a monster, but there are many cases (not only in mod_assign, this is all around moodle) where we could save a big big of db queries caching results. I know though that sometimes we should repeat the same db query because we have to, but when we repeat that big of queries is because we are doing something wrong and we should prevent it. Attaching a patch to show the number of repeated db reads in case I am missing something and I am wrong, but seems that we have a lot of margin to improve performance even though these queries are cached in the db engine, we are still connecting to the db server. The patch outputs a debugging() message for each repeated query, I know we can not integrate this, it is there just to scare you :) but would be important to show the number of repeated db reads on the footer so we know where and what we can improve
### Response:
1.summary: Improve filter_data performance on large sites
description: As a follow-on to which removed global text caching, we need to examine the database filter and probably add MUC caching there to improve performance. The database filter is what puts links in texts to database entries. There is quite a lot of processing going on in the background even before the simple text replacement, and this needs to be redone every time the cache is invalidated. Petr has raised that the fully correct way would be to use new events or the as-yet-unwritten hooks to invalidate the caches, but I think that might be too much to do before 2.7, so I want to see a quick solution here even if it may mean relying on less-perfect cache invalidation. Tests showing performance before/after are required.
2.summary: Improve performance when saving administration settings
description: admin_write_settings() includes a admin_get_root(true) as part of its code and all the calls to admin_write_settings() in core are refreshing again the admin tree. We could get rid of the admin_write_settings() one in master, in stables we could add an extra $reloadadmintree argument to admin_write_settings() that can default to true and change the calls to admin_write_settings($data, false)
3.summary: Use the Moodle roles cache
description: There are many queries to mdl_role without any join with other tables, some db engines should cache the queries, but would be better if they dont even reach the db driver
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Follow up: Secondary & Tertiary Navigation improvements 4.0
description: Once lands remove the old navigation UI elements and address found issues which should be added to this epic.
| Unsolvable | 1.summary: Implement tertiary navigation for plugin set 1 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Assignment Lesson Book Chat Choice External Tool
2.summary: Move the user menu in the top bar into the primary navigation menu in the mobile view.
description: When the the screen is resized to the mobile size, the user menu and the language menu is to move into the side panel with the other navigation elements, leaving the messaging and notification icons behind. Talking with the integration team, adding the mobile navigation html and having it hidden is fine, but we have to be aware that behat looks for the first element to "click" regardless of whether it is hidden or not. Edit from Matt This may no longer be required as the usermenu may remain in the navbar and the language menu is in the usermenu
3.summary: Navigation improvements to be made in mobile view
description: Changes need to be made to how the navigation is formatted when in a mobile view. The primary navigation is to be moved into a drawer on the side (left). Please expand this list if other requirements are discovered. Design in:
4.summary: Improve secondarynav appearance in other contexts
description: Currently the secondarynav only appears in pages with COURSE, MODULE, SYSTEM contexts. However there are subpage within these pages where the context changes to something other than the 3 above. In these cases we still need to display the secondarynav that was previously displayed. e.g. during testing it was identified that when navigating to the course/management.php page, the secondary nav wasnt generated. This is because the context is now COURSECAT, which is not handled currently by the secondarynav. Additional points to note/consider/discuss: When editing a blocks settings within a course context, with the current implementation, we still show the course nav. In the category page(when there are more than 1 categories), no secondary nav is displayed. Investigation continues into the other contexts.
5.summary: Implement tertiary navigation for plugin set 2 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Database Wiki File Folder H5P
6.summary: Add page action section.
description: We want to introduce a system that standardizes all "call to action" elements to the top of the main page area. The main candidate for this are all of the course activities. Based on initial discussions, this new system needs to do the following: Display items such as buttons, drop down menus, and select elements. Be able to position the elements either left, center, or right aligned. Allow third party developers the ability to add elements to this area. To accomplish this we propose the following: Add a method(s) to the system (PAGE) renderer to display this area at the top of the region-main-box provide an interface with a basic method to retrieve the html to display in this area. Check the namespace \plugin/actionarea/view for information to render. Basically allow any type of HTML to be inserted into the action area. Add an example module that has an implementation in mod/ \activity/classes/actionarea/view.php A thing to note is that the area is not tied to the context. It can change depending on what was clicked beforehand (see the prototype for the assignment, feedback etc). The prototype location|
7.summary: Language string changes / updates
description: Given the supplied figma design| we need to update the following language strings & usages within primary & secondary navigation . Course Page Course page -> Course Edit settings -> Settings . Module Page Activity -> i.e. Assignment, Book, Quiz Edit settings -> Settings . Book module Generate ims cp -> Download . Chat Module View past sessions -> Past sessions . Choice Module View responses -> Responses NOTE: It was discussed that a followup to this could be to add a new badge thatd contain the of responses on the Responses secondary nav node . Forum module -Forum summary report -> Report- . H5P module -View all attempts -> Attempts- . Workshop module Edit assessment form -> Assessment form Allocate submissions -> Submissions allocation
8.summary: Update the course reports page styling and functionality
description: Given the supplied figma design| we need to match the designs and functionality. Work with Barbara may be required here to confirm expected interactions with the report selection dropdown.
9.summary: Apply styling to both Primary & Secondary menus
description: Given we try to integrate only the plain functionality within the initial navigation epic, we need to ensure that the new navigations match the supplied figma designs| i.e. Underline styling for tab groups, padding etc. It is suggested that we need to grep for other tab groups to ensure consistency amongst UI elements. Requirements taken from : Remove the users name Remove the separating line after the notifications & messages icons Change the icons to use the non filled variants Append a dropdown arrow next to the users image to indicate the existence of a menu
10.summary: Ensure that the secondary navigation is backwards compatible.
description: Third party plugins can insert items into the navigation in two different ways: By using one of the callbacks to extend the navigation. By finding the navigation node and directly adding a new navigation node. We need to ensure that any navigation that is included in both of these situations is included into the secondary navigation. Important: We are not only dealing with single navigation nodes, but also nodes that have children. We must have a solution that allows categories of nodes to be navigated to. Until we have a better solution we will allow drop down menu items to be entered into the secondary navigation similar to how the custom menu is added to the primary navigation.
11.summary: Allow easy setting of the active tab for the navigation views.
description: Sometimes we want to highlight a tab in one of the navigation views when it does not match the set url for that navigation node. Currently making this work requires a lot of additional code and overwriting the views. To try and help third party developers (and ourselves) lets provide a simple method that can be called to set the active tab. Something like: code $PAGE->set_secondary_active_tab($navkey); code Where the navkey is the key given to the node that represents the tab we want active. This could be useful for the primary navigation as well.
12.summary: Implement tertiary navigation for plugin set 3 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Feedback Glossary IMS Content Package Label Page
13.summary: Investigate the secondary navigation in all core activities as a student.
description: Please look at the secondary navigation bar in all core activities as a student and see: If there are any links that are missing. If there are links that look like they should not be in the secondary navigation. Anything else that looks questionable.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Follow up: Secondary & Tertiary Navigation improvements 4.0
description: Once lands remove the old navigation UI elements and address found issues which should be added to this epic.
### Response:
1.summary: Implement tertiary navigation for plugin set 1 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Assignment Lesson Book Chat Choice External Tool
2.summary: Move the user menu in the top bar into the primary navigation menu in the mobile view.
description: When the the screen is resized to the mobile size, the user menu and the language menu is to move into the side panel with the other navigation elements, leaving the messaging and notification icons behind. Talking with the integration team, adding the mobile navigation html and having it hidden is fine, but we have to be aware that behat looks for the first element to "click" regardless of whether it is hidden or not. Edit from Matt This may no longer be required as the usermenu may remain in the navbar and the language menu is in the usermenu
3.summary: Navigation improvements to be made in mobile view
description: Changes need to be made to how the navigation is formatted when in a mobile view. The primary navigation is to be moved into a drawer on the side (left). Please expand this list if other requirements are discovered. Design in:
4.summary: Improve secondarynav appearance in other contexts
description: Currently the secondarynav only appears in pages with COURSE, MODULE, SYSTEM contexts. However there are subpage within these pages where the context changes to something other than the 3 above. In these cases we still need to display the secondarynav that was previously displayed. e.g. during testing it was identified that when navigating to the course/management.php page, the secondary nav wasnt generated. This is because the context is now COURSECAT, which is not handled currently by the secondarynav. Additional points to note/consider/discuss: When editing a blocks settings within a course context, with the current implementation, we still show the course nav. In the category page(when there are more than 1 categories), no secondary nav is displayed. Investigation continues into the other contexts.
5.summary: Implement tertiary navigation for plugin set 2 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Database Wiki File Folder H5P
6.summary: Add page action section.
description: We want to introduce a system that standardizes all "call to action" elements to the top of the main page area. The main candidate for this are all of the course activities. Based on initial discussions, this new system needs to do the following: Display items such as buttons, drop down menus, and select elements. Be able to position the elements either left, center, or right aligned. Allow third party developers the ability to add elements to this area. To accomplish this we propose the following: Add a method(s) to the system (PAGE) renderer to display this area at the top of the region-main-box provide an interface with a basic method to retrieve the html to display in this area. Check the namespace \plugin/actionarea/view for information to render. Basically allow any type of HTML to be inserted into the action area. Add an example module that has an implementation in mod/ \activity/classes/actionarea/view.php A thing to note is that the area is not tied to the context. It can change depending on what was clicked beforehand (see the prototype for the assignment, feedback etc). The prototype location|
7.summary: Language string changes / updates
description: Given the supplied figma design| we need to update the following language strings & usages within primary & secondary navigation . Course Page Course page -> Course Edit settings -> Settings . Module Page Activity -> i.e. Assignment, Book, Quiz Edit settings -> Settings . Book module Generate ims cp -> Download . Chat Module View past sessions -> Past sessions . Choice Module View responses -> Responses NOTE: It was discussed that a followup to this could be to add a new badge thatd contain the of responses on the Responses secondary nav node . Forum module -Forum summary report -> Report- . H5P module -View all attempts -> Attempts- . Workshop module Edit assessment form -> Assessment form Allocate submissions -> Submissions allocation
8.summary: Update the course reports page styling and functionality
description: Given the supplied figma design| we need to match the designs and functionality. Work with Barbara may be required here to confirm expected interactions with the report selection dropdown.
9.summary: Apply styling to both Primary & Secondary menus
description: Given we try to integrate only the plain functionality within the initial navigation epic, we need to ensure that the new navigations match the supplied figma designs| i.e. Underline styling for tab groups, padding etc. It is suggested that we need to grep for other tab groups to ensure consistency amongst UI elements. Requirements taken from : Remove the users name Remove the separating line after the notifications & messages icons Change the icons to use the non filled variants Append a dropdown arrow next to the users image to indicate the existence of a menu
10.summary: Ensure that the secondary navigation is backwards compatible.
description: Third party plugins can insert items into the navigation in two different ways: By using one of the callbacks to extend the navigation. By finding the navigation node and directly adding a new navigation node. We need to ensure that any navigation that is included in both of these situations is included into the secondary navigation. Important: We are not only dealing with single navigation nodes, but also nodes that have children. We must have a solution that allows categories of nodes to be navigated to. Until we have a better solution we will allow drop down menu items to be entered into the secondary navigation similar to how the custom menu is added to the primary navigation.
11.summary: Allow easy setting of the active tab for the navigation views.
description: Sometimes we want to highlight a tab in one of the navigation views when it does not match the set url for that navigation node. Currently making this work requires a lot of additional code and overwriting the views. To try and help third party developers (and ourselves) lets provide a simple method that can be called to set the active tab. Something like: code $PAGE->set_secondary_active_tab($navkey); code Where the navkey is the key given to the node that represents the tab we want active. This could be useful for the primary navigation as well.
12.summary: Implement tertiary navigation for plugin set 3 of 4
description: Given the completion of we will have the functionality for modules to define their own navigation outside of the primary & secondary navigation structures. Given the designs on figma| we need to go through each module and either implement the new "tertiary" functionality or confirm that a module does not need to call the new functionality. This MDL is one of a set of 4 identical MDLs, this has been done to confirm that the workloads are near equal and so work can be done in parallel. This MDL is to review and implement the tertiary navigation for the following modules: Feedback Glossary IMS Content Package Label Page
13.summary: Investigate the secondary navigation in all core activities as a student.
description: Please look at the secondary navigation bar in all core activities as a student and see: If there are any links that are missing. If there are links that look like they should not be in the secondary navigation. Anything else that looks questionable.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Issues related to analytics models editing for 3.7
description: The base issue is although extra work is needed to fully support the creation and the deletion of analytics models, including import and export features. You need to log in to see the list of issues that are part of this epic.
| Unsolvable | 1.summary: Add behat tests for analytics models editing options
description: We need behat tests for the built-in models, it is not very quick to setup the environment to test models like students at risk of dropping out because we need finished courses and current courses, we need a significant amount of students activity... Having behat test could help not only by allowing us to automatically test this, but also to quicky set up the environment and develop against the behat site instead of the "production" (wwwroot) one. Proposed approach to automatically test the behaviour without having to deal with complex context data preparations: Step definitions: We could have a analytics/tests/behat/behat_analytics.php with a _Create model "MODELNAME"_ step where MODELNAME is a closed list of 2 testing models where each MODELNAME value is a method in behat_analytics class. We could have a couple of simple models, one static and one non-static, we can use the static one to test report_insights and the non-static one to test tool_models actions. These models can use very simple core indicators like user set profile or user track forums (both in core_user) so it is easier to prepare the context data for them to work. We dont need to carefully test all internal API details, just the UI, it is not important how good the model is at predicting. As long as we use core indicators, a core analyser (analytics/classes/local/analyser/courses.php would be enough) and a core time splitting method (analytics/classes/local/time_splitting/no_splitting.php) we shouldnt need to add testing logic into production code to make this work (if I am not missing something). _Create model "MODELNAME"_ could: Prepare the MODELNAME context data (as said above not much, just enough to have samples with different predictions) Create a new model using a testing target (analytics/tests/fixtures/test_MODELNAME_target.php) and using basic core indicators. Code to create a model can be copied from admin/tool/models/db/install.php Features: "Manage models" -> tool_models features using a non-static model: Logged in as a manager Go to admin/tool/models/index.php and evaluate the testing model View the evaluation log (no need to check the model performance) Edit the model, add and remove some indicators Check that the changes were correctly applied Enable the model and select a time splitting range Execute "Get predictions" action Check that "Insights" columns lists contexts with available insights and you can select one of them "View insights" -> report_insights features using a static model: Log in as manager Go to admin/tool/models/index.php and get predictions Use admin/tool/models/index.php insights select to view report/insights/insights.php?modelid=X&contextid=Y Check that the sample name is displayed correctly Check that the prediction outcome is correct View the prediction details Click on the suggested action and check that the user lands in the page specified by the testing model Log in as a teacher of one of the courses with insights Check that they receive the notification, that they can click on it and that it leads to the insights page of that model in that context
2.summary: Allow models to be created, deleted, imported and exported
description: This issue belongs to epic. This idea came from a discussion in Moodle HQ analytics chat room. Admins and researchers should be able to share the models they found to be useful. I am not talking about the training data nor the trained models weights, but about the model configuration. Models are composed by: A target A set of indicators A time-splitting method I would suggest a basic export to .json file which would contain something like: code "target": "mod\awesomeness\analytics\target\potential_mentors", "timesplitting": "core\analytics\time_splitting\single_range", "indicators": "\mod\awesomeness\analytics\indicator\gentle", "\mod\awesomeness\analytics\indicator\formal", "\mod\awesomeness\analytics\indicator\skilled", "\mod\awesomeness\analytics\indicator\gentle", "\mod\assign\analytics\indicator\submits_before_deadline", , "moodleversion": "2017010100" code The system would obviously notify users if: Error: Any of the specified classes is not available on the system. Warning: The Moodle major version the model was created for differs from the user site major version
3.summary: Improve install and uninstall procedure Analytics API offered to plugins
description: Hey David, we just tried your Analytics API in a spontaneous DevCamp on the MoodleMootDE 2018 and completed a first small prototype for a new built-in model. First, thanks for your amazing work there. In the progress of the DevCamp, I stumbled over the way, plugins need to install built-in models within a plugin. As also done within your moodle-tool_testanalytics, you need to specify the installation as documented at MoodleDocs| within db/install.php. However, this is not the way other APIs define built-in stuff. Examples that came to my mind are the tasks API, where you specify an array within db/tasks.php or the services API with db/services.php, respectively. I would suggest adding an additional db file such as db/models.php or db/analytics.php for an easy definition of built-in models. The core analytics plugin would have to parse this file and would care about the installation, update and removal of built-in models. I have not fought about concrete implementation details yet and first wanted to hear, what you think about this idea. Cheers, Tobias
4.summary: New target for course completion
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new target for course completion, which indicates whether a student is at risk of not completing a course, according to the course completion criteria of that course; therefore, Completion tracking must be enabled for the course and some course completion criteria have been set. The code for this target is located at moodlesite/lib/classes/analytics/target/course_completion.php where _moodlesite_ is the root directory of your Moodle site. It can be similar to the existing _course_dropout_ target in _core_. There is an example of who it was implemented in tool_inspire| It was later discarded in favour of a solution limited to lack of activity logs during the last quarter of the course. The requirements shared between course-level targets like course dropouts, course completion or course competencies achievement should be abstracted from the current course_dropouts target.
5.summary: New target for course competencies achievement
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new target for course competencies achievement, which indicates whether a student is at risk of not achieving the competencies added to a course. The code for this target is located at moodlesite/lib/classes/analytics/target/course_competencies.php where _moodlesite_ is the root directory of your Moodle site. It can be similar to the existing _course_dropout_ and _course_completion_ targets in _core_. The requirements shared between course-level targets like course dropouts, course completion or course competencies achievement should be abstracted from the current course_dropouts target.
6.summary: Allow default models to be restored
description: With we allow users to create, delete, import and export models. Each moodle component can add models and these models will be added on install or upgrade. If we allow users to delete models we should also allow them to restore the default models. We have different options: Add a restore default model button that allows users to restore a model with its default setup. To block some models from being deleted by users A combination of the two options above I would vote for 3 although it is a bit of extra work although there is something we should clarify before deciding which option is the best: The API was designed considering models to be something similar to what scheduled tasks are. Moodle components can rely on them being available, there is no option to disable analytics models in general. Analytics models is a core API moodle components use so it is always up to the component to use analytics or not. Some people would prefer to disable analytics completely ( so we should decide if we want to stick to this premise or not. If we do I would vote for 1 or 3 If we do not I would vote for 2 or 3 This issue is related to as moodle components need to specify their default models somehow. They are currently adding models through install.php
7.summary: Allow users to choose whether to include the trained model weights in the export or not
description: In we add the possibility to export and import models configurations. The exported config includes the target, the indicators, the time splitting method and the predictions processor that were used in the origin site. We include the trained model weights as well. sanderbangma mentioned that he would prefer to add an option so users can choose whether to include the trained models weights or not. At the moment these model-dependant actions are accessed through an action menu. For this case we have a "Export configuration" menu option, the exported file is downloaded once the option is clicked. If we want users to choose if the weights should be included or not we will need an extra JS modal or something like that before executing the action so they can select. It would be great to have UX team (barbararamiro ashbettridge) input on this.
8.summary: Allow users to overwrite the default model name
description: We currently use the target name as the model name. In we will allow users to create multiple models using the same target so, even if those models will have different configurations, they will share the same name. This issue is about allowing them to rename the models.
9.summary: Evaluate analytics models using the trained ML backend
description: Training data can not be used as test data during models evaluation. The purpose of the evaluation process is to check if the model, trained with data from the site, will generate accurate predictions. In we add the option to export and import trained models so now a model can be trained, although not with data from the site where the model was imported. Sites using models that were trained with other sites data should be able to evaluate how these trained models perform on their site. We need an extra option to admin/tool/analytics/cli/evaluate_model.php and to the models web interface so the performance of trained models can be evaluated using the data on the site as testing data.
10.summary: Provide a "More info" link to extend the information available for the different analytics elements in core
description: This issue is about making sure that users are well informed when using the analytics tool. The create / edit model page includes some elements which meaning is not clear from a simple and short description (e.g. the text of a select boxs option). Targets and Time splitting methods fields already have a help text to explain what they are. We should provide a link to a Moodle Docs page where more info about the available options is displayed.
11.summary: Specify a time-splitting method when evaluating a model using the web UI
description: We have a growing number of time-splitting methods and not all of them are suitable for all models. At the moment the Evaluation option in the web interface evaluates a model using all the default time-splitting methods for models evaluation (there is a site setting for it). The CLI interface for models evaluation include an option to specify a time-splitting method, but this option is not available in the web interface. This issue is about adding this option.
12.summary: New target for students at risk of not getting the minimum grade to pass the course
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new "students at risk target", based on course grades. We can set the grade to pass the course in the grade item of the course, in Grades > Setup. Only those courses whose grade type is "Value" and which have set a grade to pass value will be analysed. The requirements shared between course-level targets like course dropouts, course completion, course competencies achievement or course grade should be abstracted from the current course_dropouts target.
13.summary: Analytics classes location
description: New targets related to course and enrolments have been included in core recently. They have been located in \core_analytics. According to , course-related things should sit under course component dir. This is the comment where the discussion started|
14.summary: Fix test_core_target_course_gradetopass_calculate failure in oracle
description: This test test_core_target_course_gradetopass_calculate is failing in oracle
15.summary: Enable the upcoming activities due model by default
description: The upcoming activities due model was disabled by default for no specific reason. The approach we agreed on (in Moodle 3.4) about enable/disable models by default was that we would disable a model by default if any of these conditions is true: All the models that require a ML backend (because people needs to test their performance them first). All the models that require significant computing power or time. The upcoming activities due insight does not satisfy any of these 2 conditions so it should be enabled by default. Also, once we decide about a default we can not change our choice because we dont know any more who enabled or disabled something intentionally and who just goes with the default.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Issues related to analytics models editing for 3.7
description: The base issue is although extra work is needed to fully support the creation and the deletion of analytics models, including import and export features. You need to log in to see the list of issues that are part of this epic.
### Response:
1.summary: Add behat tests for analytics models editing options
description: We need behat tests for the built-in models, it is not very quick to setup the environment to test models like students at risk of dropping out because we need finished courses and current courses, we need a significant amount of students activity... Having behat test could help not only by allowing us to automatically test this, but also to quicky set up the environment and develop against the behat site instead of the "production" (wwwroot) one. Proposed approach to automatically test the behaviour without having to deal with complex context data preparations: Step definitions: We could have a analytics/tests/behat/behat_analytics.php with a _Create model "MODELNAME"_ step where MODELNAME is a closed list of 2 testing models where each MODELNAME value is a method in behat_analytics class. We could have a couple of simple models, one static and one non-static, we can use the static one to test report_insights and the non-static one to test tool_models actions. These models can use very simple core indicators like user set profile or user track forums (both in core_user) so it is easier to prepare the context data for them to work. We dont need to carefully test all internal API details, just the UI, it is not important how good the model is at predicting. As long as we use core indicators, a core analyser (analytics/classes/local/analyser/courses.php would be enough) and a core time splitting method (analytics/classes/local/time_splitting/no_splitting.php) we shouldnt need to add testing logic into production code to make this work (if I am not missing something). _Create model "MODELNAME"_ could: Prepare the MODELNAME context data (as said above not much, just enough to have samples with different predictions) Create a new model using a testing target (analytics/tests/fixtures/test_MODELNAME_target.php) and using basic core indicators. Code to create a model can be copied from admin/tool/models/db/install.php Features: "Manage models" -> tool_models features using a non-static model: Logged in as a manager Go to admin/tool/models/index.php and evaluate the testing model View the evaluation log (no need to check the model performance) Edit the model, add and remove some indicators Check that the changes were correctly applied Enable the model and select a time splitting range Execute "Get predictions" action Check that "Insights" columns lists contexts with available insights and you can select one of them "View insights" -> report_insights features using a static model: Log in as manager Go to admin/tool/models/index.php and get predictions Use admin/tool/models/index.php insights select to view report/insights/insights.php?modelid=X&contextid=Y Check that the sample name is displayed correctly Check that the prediction outcome is correct View the prediction details Click on the suggested action and check that the user lands in the page specified by the testing model Log in as a teacher of one of the courses with insights Check that they receive the notification, that they can click on it and that it leads to the insights page of that model in that context
2.summary: Allow models to be created, deleted, imported and exported
description: This issue belongs to epic. This idea came from a discussion in Moodle HQ analytics chat room. Admins and researchers should be able to share the models they found to be useful. I am not talking about the training data nor the trained models weights, but about the model configuration. Models are composed by: A target A set of indicators A time-splitting method I would suggest a basic export to .json file which would contain something like: code "target": "mod\awesomeness\analytics\target\potential_mentors", "timesplitting": "core\analytics\time_splitting\single_range", "indicators": "\mod\awesomeness\analytics\indicator\gentle", "\mod\awesomeness\analytics\indicator\formal", "\mod\awesomeness\analytics\indicator\skilled", "\mod\awesomeness\analytics\indicator\gentle", "\mod\assign\analytics\indicator\submits_before_deadline", , "moodleversion": "2017010100" code The system would obviously notify users if: Error: Any of the specified classes is not available on the system. Warning: The Moodle major version the model was created for differs from the user site major version
3.summary: Improve install and uninstall procedure Analytics API offered to plugins
description: Hey David, we just tried your Analytics API in a spontaneous DevCamp on the MoodleMootDE 2018 and completed a first small prototype for a new built-in model. First, thanks for your amazing work there. In the progress of the DevCamp, I stumbled over the way, plugins need to install built-in models within a plugin. As also done within your moodle-tool_testanalytics, you need to specify the installation as documented at MoodleDocs| within db/install.php. However, this is not the way other APIs define built-in stuff. Examples that came to my mind are the tasks API, where you specify an array within db/tasks.php or the services API with db/services.php, respectively. I would suggest adding an additional db file such as db/models.php or db/analytics.php for an easy definition of built-in models. The core analytics plugin would have to parse this file and would care about the installation, update and removal of built-in models. I have not fought about concrete implementation details yet and first wanted to hear, what you think about this idea. Cheers, Tobias
4.summary: New target for course completion
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new target for course completion, which indicates whether a student is at risk of not completing a course, according to the course completion criteria of that course; therefore, Completion tracking must be enabled for the course and some course completion criteria have been set. The code for this target is located at moodlesite/lib/classes/analytics/target/course_completion.php where _moodlesite_ is the root directory of your Moodle site. It can be similar to the existing _course_dropout_ target in _core_. There is an example of who it was implemented in tool_inspire| It was later discarded in favour of a solution limited to lack of activity logs during the last quarter of the course. The requirements shared between course-level targets like course dropouts, course completion or course competencies achievement should be abstracted from the current course_dropouts target.
5.summary: New target for course competencies achievement
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new target for course competencies achievement, which indicates whether a student is at risk of not achieving the competencies added to a course. The code for this target is located at moodlesite/lib/classes/analytics/target/course_competencies.php where _moodlesite_ is the root directory of your Moodle site. It can be similar to the existing _course_dropout_ and _course_completion_ targets in _core_. The requirements shared between course-level targets like course dropouts, course completion or course competencies achievement should be abstracted from the current course_dropouts target.
6.summary: Allow default models to be restored
description: With we allow users to create, delete, import and export models. Each moodle component can add models and these models will be added on install or upgrade. If we allow users to delete models we should also allow them to restore the default models. We have different options: Add a restore default model button that allows users to restore a model with its default setup. To block some models from being deleted by users A combination of the two options above I would vote for 3 although it is a bit of extra work although there is something we should clarify before deciding which option is the best: The API was designed considering models to be something similar to what scheduled tasks are. Moodle components can rely on them being available, there is no option to disable analytics models in general. Analytics models is a core API moodle components use so it is always up to the component to use analytics or not. Some people would prefer to disable analytics completely ( so we should decide if we want to stick to this premise or not. If we do I would vote for 1 or 3 If we do not I would vote for 2 or 3 This issue is related to as moodle components need to specify their default models somehow. They are currently adding models through install.php
7.summary: Allow users to choose whether to include the trained model weights in the export or not
description: In we add the possibility to export and import models configurations. The exported config includes the target, the indicators, the time splitting method and the predictions processor that were used in the origin site. We include the trained model weights as well. sanderbangma mentioned that he would prefer to add an option so users can choose whether to include the trained models weights or not. At the moment these model-dependant actions are accessed through an action menu. For this case we have a "Export configuration" menu option, the exported file is downloaded once the option is clicked. If we want users to choose if the weights should be included or not we will need an extra JS modal or something like that before executing the action so they can select. It would be great to have UX team (barbararamiro ashbettridge) input on this.
8.summary: Allow users to overwrite the default model name
description: We currently use the target name as the model name. In we will allow users to create multiple models using the same target so, even if those models will have different configurations, they will share the same name. This issue is about allowing them to rename the models.
9.summary: Evaluate analytics models using the trained ML backend
description: Training data can not be used as test data during models evaluation. The purpose of the evaluation process is to check if the model, trained with data from the site, will generate accurate predictions. In we add the option to export and import trained models so now a model can be trained, although not with data from the site where the model was imported. Sites using models that were trained with other sites data should be able to evaluate how these trained models perform on their site. We need an extra option to admin/tool/analytics/cli/evaluate_model.php and to the models web interface so the performance of trained models can be evaluated using the data on the site as testing data.
10.summary: Provide a "More info" link to extend the information available for the different analytics elements in core
description: This issue is about making sure that users are well informed when using the analytics tool. The create / edit model page includes some elements which meaning is not clear from a simple and short description (e.g. the text of a select boxs option). Targets and Time splitting methods fields already have a help text to explain what they are. We should provide a link to a Moodle Docs page where more info about the available options is displayed.
11.summary: Specify a time-splitting method when evaluating a model using the web UI
description: We have a growing number of time-splitting methods and not all of them are suitable for all models. At the moment the Evaluation option in the web interface evaluates a model using all the default time-splitting methods for models evaluation (there is a site setting for it). The CLI interface for models evaluation include an option to specify a time-splitting method, but this option is not available in the web interface. This issue is about adding this option.
12.summary: New target for students at risk of not getting the minimum grade to pass the course
description: . Context The Moodle Analytics API| allows Moodle site managers to define prediction models that combine indicators and a target. Targets are the key element that defines the model. Represent the event the model is attempting to predict (the dependent variable in supervised learning, also known as labels). Since Moodle 3.4, Moodle Analytics ships with two built-in targets: students at risk of dropping out; no teaching There was no way to define new models through the UI. After , users can create new predictive models from scratch, combining existing indicators and targets. We are increasing the number of available targets out of the box, to offer more possibilities for the definition of new models. . Goal This issue is about adding a new "students at risk target", based on course grades. We can set the grade to pass the course in the grade item of the course, in Grades > Setup. Only those courses whose grade type is "Value" and which have set a grade to pass value will be analysed. The requirements shared between course-level targets like course dropouts, course completion, course competencies achievement or course grade should be abstracted from the current course_dropouts target.
13.summary: Analytics classes location
description: New targets related to course and enrolments have been included in core recently. They have been located in \core_analytics. According to , course-related things should sit under course component dir. This is the comment where the discussion started|
14.summary: Fix test_core_target_course_gradetopass_calculate failure in oracle
description: This test test_core_target_course_gradetopass_calculate is failing in oracle
15.summary: Enable the upcoming activities due model by default
description: The upcoming activities due model was disabled by default for no specific reason. The approach we agreed on (in Moodle 3.4) about enable/disable models by default was that we would disable a model by default if any of these conditions is true: All the models that require a ML backend (because people needs to test their performance them first). All the models that require significant computing power or time. The upcoming activities due insight does not satisfy any of these 2 conditions so it should be enabled by default. Also, once we decide about a default we can not change our choice because we dont know any more who enabled or disabled something intentionally and who just goes with the default.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: A list of theme issues related to the Moodle 4.0 UX changes
description: To enforce visual consistency across the 4.0 UX this epic lists changes related to the themes only. Please add issues here where styling changes from the UX projects that might affect other UI components
| Unsolvable | 1.summary: Add new course management buttons to my courses
description: Given discussions presented by the UX team it has been raised that a quick UX win could be to add the following buttons to the incoming my courses page: "New course" & "Manage courses" this would allow users from having to navigation into the link farm within site administration or directly typing in /courses to get to the course management page. See the attached screenshot. !Screenshot 2021-07-29 at 09.15.51.png|width=918! EDIT: following recent UX discussions Im adding a note here on how this page should behave: The course overview block title should not be displayed with the string being added to the template inline with the dropdown instead
2.summary: Update Course Index to match the UX team figma designs
description: The visual design of the course index needs to be updated based on the latest figma designs.
3.summary: Turn confirmation page into modals
description: When deleting a block from the dashboard, a whole new page is loaded with the confirmation message. !Screenshot 2021-05-26 at 14.38.12.png|width=700! We need to turn these confirmation messages into modals to make this process more straightforward. Like this: !Screenshot 2021-05-26 at 14.43.15-2.png|width=700! Also, all the text need revision. Using "Yes" and "No" buttons is not a good UX practice. Notice that the text used above is just an example of how we can improve it.
4.summary: Update the page header and include course image / activity icon
description: The page header currently (can) contain these elements - user image (in user contexts) - site logo (frontpage) - page title - navbar (breadcrumb) - a settings menu (cog) - page heading button (turn editing on) - header actions (search on wiki) - course header added by the course format? Suggested improvements for the header are: - add course image on course page - add activity icon on activity page - remove border around the header (do not use the .card class) - -add a back to course action on the activity page-
5.summary: Change edit mode button to look like the figma designs
description: Move the checkbox switch after the edit mode label text Turn the work edit mode to the link colour when editing is on Make the checkbox switch smaller (like the figma designs)
6.summary: Redesign the Moodle login page
description: The Moodle login page should be improve to: - create a better styled login box using bootstraps custom checkbox etc. - allow for customisation of the background image - create a better styled signup box - improve styling of 3rd party signup methods (google / facebook)
7.summary: Update the layouts in theme Boost for version 4.0
description: Update the layouts based on the designs in Figma in the create a course project and the navigation project This includes the collapsed block region moving the add block button new max widths for main content a region for the new course index
8.summary: Update the Moodle frontpage styles
description: Use course cards for the frontpage items - list of courses - list of categories - combolist - enrolled courses Update the search to show suggestions on typing Figma prototype:
9.summary: Update the top navbar html / css
description: Moodles top navbar breaks on mobile designs when custommenuitems are configured The Boost top navbar cannot be styled through theme settings, the theme classic option for a dark navbar is broken. Update the navbar items to use the same css classes and create a single navbar.scss sheet with customisable scss variables for styling Document the new navbar in the Moodle UI component library Design specs: . Navbar - left side . Behaviour . If the user is not logged in: - From LG breakpoint upward (greater than 900px) -- If logocompact is empty: --- Site shortname is displayed on the left side of the navbar --- The site shortname will wrap using ellipsis ... after 20 characters -- If logocompact is not empty --- The image uploaded to logocompact is displayed on the left side of the navbar --- The site shortname is NOT displayed anywhere in the navbar - From MD breakpoint downward (less than 900px) -- Neither logocompact nor shortname is displayed on the navbar . If the user is logged in: - From LG breakpoint upward (greater than 900px) -- If logocompact is empty: --- Site shortname is displayed on the left side of the navbar --- The site shortname will wrap using ellipsis ... after 20 characters -- If logocompact is not empty --- The image uploaded to logocompact is displayed on the left side of the navbar --- The site shortname is NOT displayed anywhere in the navbar -- The menu items are displayed streamlined, next to the site shortname or logocompact --- Home (if enabled) disabled by default --- Dashboard where the user automatically lands when logging in --- My courses --- Site administration --- Custom menus -- The menu items that do not fit in the available space are displayed in the dropdown under "More" - From MD breakpoint downward (less than 900px) -- No shortname or logocompact is displayed in the navbar -- The hamburger menu is displayed --- When clicking the hamburger menu, the following menu items are shown listed inside a drawer that overlaps the page content: ---- Home (if enabled) disabled by default ---- Dashboard where the user automatically lands when logging in ---- My courses ---- Site administration ---- Custom menus --- If logocompact is empty: ---- The site shortname is displayed at the top of the drawer, in the same row as the "X" button that closes it --- If logocompact is not empty ---- The image uploaded to logocompact is displayed at the top of the drawer, in the same row as the "X" button that closes it ---- The site shortname is NOT displayed anywhere in the menu or the navbar . Navbar - right side . Behaviour . If the user is not logged in: - From LG breakpoint upward (greater than 900px) -- Items displayed: --- Language selector ---- Aligned to the right, next to the "Log in" link ---- When clicked, it loads the language list options in a floating container --- Vertical divider --- Log in link ---- Aligned to the right (top right corner) ---- Note: if possible, lets drop the sentence "You are not logged in." and keep only the actual "Log in" link - From SM breakpoint downward (less than 768px) -- Items displayed: --- Language selector ---- Aligned to the left (top left corner) ---- When clicked, it loads the language list options in a floating container --- Log in link ---- Aligned to the right (top right corner) - From 480px downward -- Language selector --- When clicked, it loads the language list options in a full-width container ---- The title of the loaded list is "Language selector" ----- This title should wrap using ellipsis ... if too big ---- "X" icon closes it . If the user is logged in: - From LG breakpoint upward (greater than 900px) -- Items displayed: --- Search (if enabled) --- MoodleCloud usage indicators (MoodleCloud only) need to double-check with MC team --- Moodle Workplace launcher (Workplace only) --- Notifications (no changes) --- Messages (no changes) --- User menu ---- User picture ----- Display user initials if no user picture is uploaded ---- By clicking in the user picture, a floating container with the following items is shown: ----- Profile ----- Grades ----- Calendar ----- Private files ----- Horizontal divider ----- Preferences ----- Language ------ When clicked, it loads the language list options in the same floating container ------- The title of the loaded list is "Language selector" -------- This title should wrap using ellipsis ... if too big ------- Left-arrow icon to go back to the previous items list ----- Switch role to... (if available) ----- Horizontal divider ----- Log out --- Vertical divider --- Edit mode toggle ---- Text and toggle icon ---- The whole area should be clickable - From SM breakpoint downward (less than 768px) -- Edit mode toggle --- Only icon - From 480px downward -- Search (if enabled) -- MoodleCloud usage indicators (MoodleCloud only) need to double-check with MC team -- Moodle Workplace launcher (Workplace only) -- Notifications (no changes) -- Messages (no changes) -- User menu --- User picture ---- By clicking in the user picture, a 100 width container is shown: ----- Profile ----- Grades ----- Calendar ----- Private files ----- Empty gap ----- Preferences ----- Language ------ When clicked, it loads the language list options in the same floating container ------- The title of the loaded list is "Language selector" -------- This title should wrap using ellipsis ... if too big ------- Left-arrow icon to go back to the previous items list ----- Switch role to... (if available) ----- Empty gap ----- Log out
10.summary: Create page drawers for the block and course index areas
description: Remove the current na-drawer and replace it with new drawers for the block region and the course index
11.summary: Update the Moodle activity icons
description: For Moodle 4.0 a new design for the activity icons will be provided by the UX team. EDIT: After review we will apply some categories to the activity icon colours with the aim to standardise and provide guidance to community plugin developers on which colours to use for their icons. We will base this on the purpose categories from the Moodle Plugin database. Colours and categories defined in this spec| -If time allows we should look at allowing plugins to specify which category they belong to, so that Moodle will pick the corresponding icon background colour.- Alternatively, we can define the colours and categories as a guide in the component library and docs.
12.summary: Move the turn editing on button into the navbar
description: The turn editing on button will be moved into the top navbar for consistency
13.summary: Welcome message for users
description: A welcoming message is a cheap initiative that has a great impact on users. The following mockup is an example of how it could look: !Screenshot 2021-06-17 at 17.09.23.png|width=800! However, we need to address some issues: Will it be displayed in the dashboard, replacing its title? Are we having variations of the message? For example: When the user first logs in: "Welcome, $user_first_name!" On following sessions: "Welcome back, $user_first_name!" "Glad to see you again, $user_first_name!" Etc... Do we want to make it easy to extend/customise, or is the string overriding enough for admins to customise it?
14.summary: New footer
description: The new improved footer will float in the bottom right corner of the screen. Like this: !screenshot-1.png|width=800! At the top of my mind, we still need to discuss: What elements should we keep or remove? Fail-safe log out link Lets kick off the conversation on this issue. The UX team will provide mockups that reflect the changes that will arise in this discussion. (y)
15.summary: Update site dashboard to include user greeting
description: Given the attached screenshot it was identified that a small UX win could be to welcome the user on their dashboard. We need to include this within Moodle 4.0 and itll likely need a new language string.
16.summary: Navbar updates
description: Given the supplied figma design| we need to do the following: Remove the users name Remove the separating line after the notifications & messages icons Change the icons to use the non filled variants Append a dropdown arrow next to the users image to indicate the existence of a menu
17.summary: Update styling across top level pages
description: Given the supplied figma design| the page context headers need to be updated on the -Site home / Dashboard & -My Courses pages to match the designs, i.e. Bold font face sans borders & with an underline EDIT 10-Dec-21: updated to latest figma design. Only seems to apply to the My Courses page. Also note the page background is white in the figma prototype, not grey as in the current dashboard & my courses pages.
18.summary: Main container width of Boost pages
description: With the introduction of the drawers layout, the course content now has a fixed width. If possible other pages should have the same width. Plugin pages need to have a way of choosing between a full page width or a fixed width. EDIT: must-fix for 4.0 to meet UX designs
19.summary: Fake blocks now in drawer should be made visible on first visit
description: Fake blocks are often required navigation for an activity To ensure users do not miss the block we should find a solution to make it visible (at least on first visit)
20.summary: Show user initials as a placeholder for the user profile picture
description: When the user pictured is rendered but the user has no profile picture show the user initials instead
21.summary: Removal of back to top link
description: The new page footer button is taking the spot where the back to top link is rendered now. To match the new UX designs this feature needs to be removed.
22.summary: Turn on roundness for theme Boost
description: To match the UX team designs the roundness of elements like buttons and countainers needs to be enabled
23.summary: Remove container borders for theme boost
description: The main content region and the page header borders should be removed for theme boost to reflect the UX designs in Figma
24.summary: Add Expand / Collapse all on the course format
description: Now that the sections can be collapse / expanded we need an Expand / Collapse all function on the course page FIgma prototype|
25.summary: Activity information on the activity page should look like the activity information on the course page
description: Now the course page has a new design for activities, the activity page should show the same design for the same information course page: !course page design.png|thumbnail! activity page: !activity page design.png|thumbnail!
26.summary: rewrite inplace editable to better position the edit icon
description: The current inplace editable functionality can not be matched with the new designs for course activities. The pencil icon needs to be rendered right after the activity title
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: A list of theme issues related to the Moodle 4.0 UX changes
description: To enforce visual consistency across the 4.0 UX this epic lists changes related to the themes only. Please add issues here where styling changes from the UX projects that might affect other UI components
### Response:
1.summary: Add new course management buttons to my courses
description: Given discussions presented by the UX team it has been raised that a quick UX win could be to add the following buttons to the incoming my courses page: "New course" & "Manage courses" this would allow users from having to navigation into the link farm within site administration or directly typing in /courses to get to the course management page. See the attached screenshot. !Screenshot 2021-07-29 at 09.15.51.png|width=918! EDIT: following recent UX discussions Im adding a note here on how this page should behave: The course overview block title should not be displayed with the string being added to the template inline with the dropdown instead
2.summary: Update Course Index to match the UX team figma designs
description: The visual design of the course index needs to be updated based on the latest figma designs.
3.summary: Turn confirmation page into modals
description: When deleting a block from the dashboard, a whole new page is loaded with the confirmation message. !Screenshot 2021-05-26 at 14.38.12.png|width=700! We need to turn these confirmation messages into modals to make this process more straightforward. Like this: !Screenshot 2021-05-26 at 14.43.15-2.png|width=700! Also, all the text need revision. Using "Yes" and "No" buttons is not a good UX practice. Notice that the text used above is just an example of how we can improve it.
4.summary: Update the page header and include course image / activity icon
description: The page header currently (can) contain these elements - user image (in user contexts) - site logo (frontpage) - page title - navbar (breadcrumb) - a settings menu (cog) - page heading button (turn editing on) - header actions (search on wiki) - course header added by the course format? Suggested improvements for the header are: - add course image on course page - add activity icon on activity page - remove border around the header (do not use the .card class) - -add a back to course action on the activity page-
5.summary: Change edit mode button to look like the figma designs
description: Move the checkbox switch after the edit mode label text Turn the work edit mode to the link colour when editing is on Make the checkbox switch smaller (like the figma designs)
6.summary: Redesign the Moodle login page
description: The Moodle login page should be improve to: - create a better styled login box using bootstraps custom checkbox etc. - allow for customisation of the background image - create a better styled signup box - improve styling of 3rd party signup methods (google / facebook)
7.summary: Update the layouts in theme Boost for version 4.0
description: Update the layouts based on the designs in Figma in the create a course project and the navigation project This includes the collapsed block region moving the add block button new max widths for main content a region for the new course index
8.summary: Update the Moodle frontpage styles
description: Use course cards for the frontpage items - list of courses - list of categories - combolist - enrolled courses Update the search to show suggestions on typing Figma prototype:
9.summary: Update the top navbar html / css
description: Moodles top navbar breaks on mobile designs when custommenuitems are configured The Boost top navbar cannot be styled through theme settings, the theme classic option for a dark navbar is broken. Update the navbar items to use the same css classes and create a single navbar.scss sheet with customisable scss variables for styling Document the new navbar in the Moodle UI component library Design specs: . Navbar - left side . Behaviour . If the user is not logged in: - From LG breakpoint upward (greater than 900px) -- If logocompact is empty: --- Site shortname is displayed on the left side of the navbar --- The site shortname will wrap using ellipsis ... after 20 characters -- If logocompact is not empty --- The image uploaded to logocompact is displayed on the left side of the navbar --- The site shortname is NOT displayed anywhere in the navbar - From MD breakpoint downward (less than 900px) -- Neither logocompact nor shortname is displayed on the navbar . If the user is logged in: - From LG breakpoint upward (greater than 900px) -- If logocompact is empty: --- Site shortname is displayed on the left side of the navbar --- The site shortname will wrap using ellipsis ... after 20 characters -- If logocompact is not empty --- The image uploaded to logocompact is displayed on the left side of the navbar --- The site shortname is NOT displayed anywhere in the navbar -- The menu items are displayed streamlined, next to the site shortname or logocompact --- Home (if enabled) disabled by default --- Dashboard where the user automatically lands when logging in --- My courses --- Site administration --- Custom menus -- The menu items that do not fit in the available space are displayed in the dropdown under "More" - From MD breakpoint downward (less than 900px) -- No shortname or logocompact is displayed in the navbar -- The hamburger menu is displayed --- When clicking the hamburger menu, the following menu items are shown listed inside a drawer that overlaps the page content: ---- Home (if enabled) disabled by default ---- Dashboard where the user automatically lands when logging in ---- My courses ---- Site administration ---- Custom menus --- If logocompact is empty: ---- The site shortname is displayed at the top of the drawer, in the same row as the "X" button that closes it --- If logocompact is not empty ---- The image uploaded to logocompact is displayed at the top of the drawer, in the same row as the "X" button that closes it ---- The site shortname is NOT displayed anywhere in the menu or the navbar . Navbar - right side . Behaviour . If the user is not logged in: - From LG breakpoint upward (greater than 900px) -- Items displayed: --- Language selector ---- Aligned to the right, next to the "Log in" link ---- When clicked, it loads the language list options in a floating container --- Vertical divider --- Log in link ---- Aligned to the right (top right corner) ---- Note: if possible, lets drop the sentence "You are not logged in." and keep only the actual "Log in" link - From SM breakpoint downward (less than 768px) -- Items displayed: --- Language selector ---- Aligned to the left (top left corner) ---- When clicked, it loads the language list options in a floating container --- Log in link ---- Aligned to the right (top right corner) - From 480px downward -- Language selector --- When clicked, it loads the language list options in a full-width container ---- The title of the loaded list is "Language selector" ----- This title should wrap using ellipsis ... if too big ---- "X" icon closes it . If the user is logged in: - From LG breakpoint upward (greater than 900px) -- Items displayed: --- Search (if enabled) --- MoodleCloud usage indicators (MoodleCloud only) need to double-check with MC team --- Moodle Workplace launcher (Workplace only) --- Notifications (no changes) --- Messages (no changes) --- User menu ---- User picture ----- Display user initials if no user picture is uploaded ---- By clicking in the user picture, a floating container with the following items is shown: ----- Profile ----- Grades ----- Calendar ----- Private files ----- Horizontal divider ----- Preferences ----- Language ------ When clicked, it loads the language list options in the same floating container ------- The title of the loaded list is "Language selector" -------- This title should wrap using ellipsis ... if too big ------- Left-arrow icon to go back to the previous items list ----- Switch role to... (if available) ----- Horizontal divider ----- Log out --- Vertical divider --- Edit mode toggle ---- Text and toggle icon ---- The whole area should be clickable - From SM breakpoint downward (less than 768px) -- Edit mode toggle --- Only icon - From 480px downward -- Search (if enabled) -- MoodleCloud usage indicators (MoodleCloud only) need to double-check with MC team -- Moodle Workplace launcher (Workplace only) -- Notifications (no changes) -- Messages (no changes) -- User menu --- User picture ---- By clicking in the user picture, a 100 width container is shown: ----- Profile ----- Grades ----- Calendar ----- Private files ----- Empty gap ----- Preferences ----- Language ------ When clicked, it loads the language list options in the same floating container ------- The title of the loaded list is "Language selector" -------- This title should wrap using ellipsis ... if too big ------- Left-arrow icon to go back to the previous items list ----- Switch role to... (if available) ----- Empty gap ----- Log out
10.summary: Create page drawers for the block and course index areas
description: Remove the current na-drawer and replace it with new drawers for the block region and the course index
11.summary: Update the Moodle activity icons
description: For Moodle 4.0 a new design for the activity icons will be provided by the UX team. EDIT: After review we will apply some categories to the activity icon colours with the aim to standardise and provide guidance to community plugin developers on which colours to use for their icons. We will base this on the purpose categories from the Moodle Plugin database. Colours and categories defined in this spec| -If time allows we should look at allowing plugins to specify which category they belong to, so that Moodle will pick the corresponding icon background colour.- Alternatively, we can define the colours and categories as a guide in the component library and docs.
12.summary: Move the turn editing on button into the navbar
description: The turn editing on button will be moved into the top navbar for consistency
13.summary: Welcome message for users
description: A welcoming message is a cheap initiative that has a great impact on users. The following mockup is an example of how it could look: !Screenshot 2021-06-17 at 17.09.23.png|width=800! However, we need to address some issues: Will it be displayed in the dashboard, replacing its title? Are we having variations of the message? For example: When the user first logs in: "Welcome, $user_first_name!" On following sessions: "Welcome back, $user_first_name!" "Glad to see you again, $user_first_name!" Etc... Do we want to make it easy to extend/customise, or is the string overriding enough for admins to customise it?
14.summary: New footer
description: The new improved footer will float in the bottom right corner of the screen. Like this: !screenshot-1.png|width=800! At the top of my mind, we still need to discuss: What elements should we keep or remove? Fail-safe log out link Lets kick off the conversation on this issue. The UX team will provide mockups that reflect the changes that will arise in this discussion. (y)
15.summary: Update site dashboard to include user greeting
description: Given the attached screenshot it was identified that a small UX win could be to welcome the user on their dashboard. We need to include this within Moodle 4.0 and itll likely need a new language string.
16.summary: Navbar updates
description: Given the supplied figma design| we need to do the following: Remove the users name Remove the separating line after the notifications & messages icons Change the icons to use the non filled variants Append a dropdown arrow next to the users image to indicate the existence of a menu
17.summary: Update styling across top level pages
description: Given the supplied figma design| the page context headers need to be updated on the -Site home / Dashboard & -My Courses pages to match the designs, i.e. Bold font face sans borders & with an underline EDIT 10-Dec-21: updated to latest figma design. Only seems to apply to the My Courses page. Also note the page background is white in the figma prototype, not grey as in the current dashboard & my courses pages.
18.summary: Main container width of Boost pages
description: With the introduction of the drawers layout, the course content now has a fixed width. If possible other pages should have the same width. Plugin pages need to have a way of choosing between a full page width or a fixed width. EDIT: must-fix for 4.0 to meet UX designs
19.summary: Fake blocks now in drawer should be made visible on first visit
description: Fake blocks are often required navigation for an activity To ensure users do not miss the block we should find a solution to make it visible (at least on first visit)
20.summary: Show user initials as a placeholder for the user profile picture
description: When the user pictured is rendered but the user has no profile picture show the user initials instead
21.summary: Removal of back to top link
description: The new page footer button is taking the spot where the back to top link is rendered now. To match the new UX designs this feature needs to be removed.
22.summary: Turn on roundness for theme Boost
description: To match the UX team designs the roundness of elements like buttons and countainers needs to be enabled
23.summary: Remove container borders for theme boost
description: The main content region and the page header borders should be removed for theme boost to reflect the UX designs in Figma
24.summary: Add Expand / Collapse all on the course format
description: Now that the sections can be collapse / expanded we need an Expand / Collapse all function on the course page FIgma prototype|
25.summary: Activity information on the activity page should look like the activity information on the course page
description: Now the course page has a new design for activities, the activity page should show the same design for the same information course page: !course page design.png|thumbnail! activity page: !activity page design.png|thumbnail!
26.summary: rewrite inplace editable to better position the edit icon
description: The current inplace editable functionality can not be matched with the new designs for course activities. The pencil icon needs to be rendered right after the activity title
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Atto accessibility issues
description: This epic contains the collection of accessibility issues related to the atto editor.
| Unsolvable | 1.summary: Atto dosent add "img-responsive" class tag when i use drag and drop
description: i can see code:java class="img-responsive" code when i upload image it using the image button of atto toolbar BUT i cant see code:java class="img-responsive" code tag when i upload image it using drag and drop . i want to use drag and drop property for atto but also i want to atto add class="img-responsive" tag in my images html .How can i solve this issue?
2.summary: Make unordered and ordered lists indent consistently
description: Regular bullet lists entered in the ATTO editor indent differently from numeric lists. This is visible on demo.moodle.net in attached screenshot.
3.summary: ATTO clear formatting should remove span and div-tags
description: Hello, ATTO-toolbar button "clear formatting" should remove all span and div tags from apasted text, these tags usally breaks the whole course layout and prevent editing it at all before removing them from HTML-code. Attached is an example word document which has multiple different span-tags.
4.summary: Prevent internal empty lines within an ordered list item
description: Accessibility rules require that ordered list items should have no internal empty lines, ie tags, as list items need to be semantically distinct to make sense. The Atto ordered list plugin currently allows the user to create an ordered list with items containing internal empty lines, by hitting Shift+Return. Some users add these for padding or multi-line items, but they break the list for assistive technology, due to being only a visual new line, and not a semantic new line. tags should ideally not be used anywhere to create a visual effect of two separate items, the content should instead be in different logical blocks. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
5.summary: Prevent internal empty lines within an unordered list item
description: Accessibility rules require that unordered list items should have no internal empty lines, ie tags, as list items need to be semantically distinct to make sense. The Atto unordered list plugin currently allows the user to create an unordered list with items containing internal empty lines, by hitting Shift+Return. Some users add these for padding or multi-line items, but they break the list for assistive technology, due to being only a visual new line, and not a semantic new line. tags should ideally not be used anywhere to create a visual effect of two separate items, the content should instead be in different logical blocks. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
6.summary: Too easy to forget to add alt to images dropped or pasted into Atto HTML editor
description: For accessibility, significant images should have a meaningful alt="..." attribute, and decorative images should have alt="". If you drag and drop an image into Atto (or, use to paste an image) then it is created with no alt, but it is not clear to the casual editor that something is missing. I suggest: Images with no alt attribute get highlighted. There is client-side validation, which shows a validation message under the editor if any images are missing alt-text (in exactly the same way that a Required atto field gets client-side validation - see Question text field when creating a new true-false field for an example.) The client-side validation should be backed-up by server-side validation. That could look like this - the three images in the editor are 1) a decorative pattern with alt="", 2) a real photo with proper alt text, and 3) a photo (of inaccessible pinnacle :)) with no alt attribute at all. !Possible mock-up.png! (Perhaps the error should also contain more of a call to action. Perhaps add "Please edit the image properties to fix this.) Note, I was playing, for 1. CSS like code:css.editor_atto_content img:not(alt) box-shadow: 0 0 10px 3px 800; code does what we want.
7.summary: Unbalanced html tags can make pages completely unusable
description: If you enter code in an editor (or textarea) with unbalanced div tags, script tags, or html comments, it can completely break page rendering. At some point, it was decided that teachers are inherently trusted because there are some things they have to be able to do that would give them XSS capability. Because of that, we do absolutely no sanitization of teacher content in places like course sections, and we very frequently run into problems where they paste content from somewhere and it has unbalanced tags that then makes it impossible to fix via the UI.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Atto accessibility issues
description: This epic contains the collection of accessibility issues related to the atto editor.
### Response:
1.summary: Atto dosent add "img-responsive" class tag when i use drag and drop
description: i can see code:java class="img-responsive" code when i upload image it using the image button of atto toolbar BUT i cant see code:java class="img-responsive" code tag when i upload image it using drag and drop . i want to use drag and drop property for atto but also i want to atto add class="img-responsive" tag in my images html .How can i solve this issue?
2.summary: Make unordered and ordered lists indent consistently
description: Regular bullet lists entered in the ATTO editor indent differently from numeric lists. This is visible on demo.moodle.net in attached screenshot.
3.summary: ATTO clear formatting should remove span and div-tags
description: Hello, ATTO-toolbar button "clear formatting" should remove all span and div tags from apasted text, these tags usally breaks the whole course layout and prevent editing it at all before removing them from HTML-code. Attached is an example word document which has multiple different span-tags.
4.summary: Prevent internal empty lines within an ordered list item
description: Accessibility rules require that ordered list items should have no internal empty lines, ie tags, as list items need to be semantically distinct to make sense. The Atto ordered list plugin currently allows the user to create an ordered list with items containing internal empty lines, by hitting Shift+Return. Some users add these for padding or multi-line items, but they break the list for assistive technology, due to being only a visual new line, and not a semantic new line. tags should ideally not be used anywhere to create a visual effect of two separate items, the content should instead be in different logical blocks. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
5.summary: Prevent internal empty lines within an unordered list item
description: Accessibility rules require that unordered list items should have no internal empty lines, ie tags, as list items need to be semantically distinct to make sense. The Atto unordered list plugin currently allows the user to create an unordered list with items containing internal empty lines, by hitting Shift+Return. Some users add these for padding or multi-line items, but they break the list for assistive technology, due to being only a visual new line, and not a semantic new line. tags should ideally not be used anywhere to create a visual effect of two separate items, the content should instead be in different logical blocks. This code was migrated from the Brickfield Education Labs Editor accessibility efforts.
6.summary: Too easy to forget to add alt to images dropped or pasted into Atto HTML editor
description: For accessibility, significant images should have a meaningful alt="..." attribute, and decorative images should have alt="". If you drag and drop an image into Atto (or, use to paste an image) then it is created with no alt, but it is not clear to the casual editor that something is missing. I suggest: Images with no alt attribute get highlighted. There is client-side validation, which shows a validation message under the editor if any images are missing alt-text (in exactly the same way that a Required atto field gets client-side validation - see Question text field when creating a new true-false field for an example.) The client-side validation should be backed-up by server-side validation. That could look like this - the three images in the editor are 1) a decorative pattern with alt="", 2) a real photo with proper alt text, and 3) a photo (of inaccessible pinnacle :)) with no alt attribute at all. !Possible mock-up.png! (Perhaps the error should also contain more of a call to action. Perhaps add "Please edit the image properties to fix this.) Note, I was playing, for 1. CSS like code:css.editor_atto_content img:not(alt) box-shadow: 0 0 10px 3px 800; code does what we want.
7.summary: Unbalanced html tags can make pages completely unusable
description: If you enter code in an editor (or textarea) with unbalanced div tags, script tags, or html comments, it can completely break page rendering. At some point, it was decided that teachers are inherently trusted because there are some things they have to be able to do that would give them XSS capability. Because of that, we do absolutely no sanitization of teacher content in places like course sections, and we very frequently run into problems where they paste content from somewhere and it has unbalanced tags that then makes it impossible to fix via the UI.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Calendar Improvements - followup
description: Calendar Improvements - followup to
| Unsolvable | 1.summary: Improve the calendar monthly view for better support for visual impairment
description: Take a look at the colours used for the month view of the calendar and make sure they are appropriate for visually impaired users.
2.summary: Add support for drag/drop of lesson activity action events
description: Allow the action events created by the lesson activity to be dragged and dropped in the calendar UI.
3.summary: Add support for drag/drop of workshop activity action events
description: Allow the action events created by the workshop activity to be dragged and dropped in the calendar UI.
4.summary: Add support for drag/drop of database activity action events
description: Allow the action events created by the database activity to be dragged and dropped in the calendar UI.
5.summary: Add support for drag/drop of the scorm activity action events
description: Allow the action events created by the scorm activity to be dragged and dropped in the calendar UI.
6.summary: Add support for drag/drop of activity completion events
description: Use the callbacks added by to allow dragging and dropping of activity completion action events in the calendar UI.
7.summary: Improve screen reader accessibility on calendar monthly view
description: The calendar monthly view needs to be screen reader accessible
8.summary: Add support for drag/drop of chat activity action events
description: Allow the action events created by the chat activity to be dragged and dropped in the calendar UI.
9.summary: Improve the keyboard navigation on the calendar monthly view
description: The calendar monthly view needs to be keyboard accessible
10.summary: Show event start time on monthly view
description: Display the events start time on the monthly calendar view. Perhaps a hover tooltip that shows it (though that isnt mobile friendly). Need to think of a good way, if possible.
11.summary: Consider adding link from day view to month view
description: When in the day view, it is not possible to navigate to the whole month view
12.summary: WS Fetchers should take an array of course IDs
description: Were talking about allowing events from multiples courses/categories in the future. To make this simpler now, we should change the existing WS to take an array of course IDs rather than a single course ID. The background code already supports this.
13.summary: Look at use of MutationObserver to remove stale handlers
description: See in the calendar_threemonth.
14.summary: Review calendar exporters and add automated tests
description: We have a bunch of new exporters for calendar, would be good to review those exporters making sure it does not have unused stuff and duplicated properties and code. Also would be great create automated tests for those exporters.
15.summary: Sanitise event exporters
description: The calendar_event_exporter and the event_exporter duplicate some logic (e.g. the URL) which should be moved to the base. Also, perhaps it shouldnt be called url, but typeurl or something like that. Its too vague.
16.summary: Drag and drop of repeated events in monthly view may need to be improved
description: The implementation of drag and drop in treats each of the repeated events as individual events rather than a group so dragging one doesnt affect the others. We may want to change that so that dragging one gives the user the option to have it affect the entire series.
17.summary: Rename user event type
description: The user event type is not very personal. I suggest we rename them to personal events everywhere. Pinging tsala for advice here too.
18.summary: limit the number of events shown at once
description: When more than X events are present on a day, we should add a Show more... and hide some of those.
19.summary: Stop loading parent record in repeat collection
description: The repeat collection constructor loads the parent record to check that the given id corresponds to a calendar event record however this results in an addition DB query for every event that is loaded, even if the event collection isnt used. We can just skip doing this query and trust the calling code to load the correct thing (especially since its all packed into the factory anyway) and only load the parent record when its required.
20.summary: Remove redundancy in calendar exporters for calendar month view
description: The exporters for the calendar month view are doing a few redundant calculations that can be removed.
21.summary: Check course enrolment later in event factory early bailout check
description: The early bailout check for the event factory checks that the user is enrolled in the course for a course event. This is just one of many checks that it does however it is one of the more expensive checks in terms of DB queries so it should only be done once weve performed all of the lighter weight checks and rules them out of the early bailout.
22.summary: Batch load groups in calendar_set_filters
description: The calendar_set_filters function currently loads the groups for each course one course at a time in a loop. We should just load all of the groups in a single query to reduce the number of DB queries and improve the performance.
23.summary: Load the calendar blocks after page load
description: We should load the calendar block and the 3 month block on the calendar page asynchronously after page load rather than blocking the page from rendering. Loading this content can be time consuming and its likely not the primary focus of the page given its a block so we shouldnt delay loading the page for it.
24.summary: Use related cache to load course modules during event export
description: Use the events related cache to batch load and cache the course module instances for activity events. Each instance may have multiple events. It would be better to load all of the modules up front and provide each of them to the exporter as required rather than load each module instance (potentially multiple times) as each event is exported.
25.summary: Lazy load context in calendar_event
description: The calendar_event class load the context in the constructor if one isnt provided in the constructor args. This is unnecessary and potentially causes a DB hit for no reason. Instead the class should just load the context when its actually needed. Its fairly simple in this case because weve overridden the magic getter function.
26.summary: Allow contexts to be passed into external format functions
description: The external format functions currently only take contexts by id and will then load the context within the function. This potentially adds an additional DB read if weve already loaded the context because we cant just simply pass it in. Instead the functions should take the id (for backwards compatibility) and the context itself. It can then load the context only if one isnt provided.
27.summary: Preload contexts in course_filter_selector
description: For larger users the course_filter_selector can load more courses than can be held in the course context cache which means each of them loads the context from the DB again in a loop. Instead we should just preload all of the contexts for the required courses in a single query. We could even have it check if the number courses are likely to exceed the context static cache limit and only do the preloading if it looks like well thrash the cache otherwise.
28.summary: Calendar: events from site home to be considered site events
description: An activity created on Site home is considered a course event as course 1 is actually the Site Home. The issue is that students and teacher dont realise that so it is confusing when on the calendar if you click on Hide site events it doesnt hide does events, but if you click on Hide course events it does. (Im saying students and teacher, but IMHO for admins isnt obvious either) Any event related to Site Home should be categorised under site events. To reproduce that create a chat on site home and go to the created event. Open the calendar and check that if you click on Hide course events it hides it, so it is categorised under course event.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Calendar Improvements - followup
description: Calendar Improvements - followup to
### Response:
1.summary: Improve the calendar monthly view for better support for visual impairment
description: Take a look at the colours used for the month view of the calendar and make sure they are appropriate for visually impaired users.
2.summary: Add support for drag/drop of lesson activity action events
description: Allow the action events created by the lesson activity to be dragged and dropped in the calendar UI.
3.summary: Add support for drag/drop of workshop activity action events
description: Allow the action events created by the workshop activity to be dragged and dropped in the calendar UI.
4.summary: Add support for drag/drop of database activity action events
description: Allow the action events created by the database activity to be dragged and dropped in the calendar UI.
5.summary: Add support for drag/drop of the scorm activity action events
description: Allow the action events created by the scorm activity to be dragged and dropped in the calendar UI.
6.summary: Add support for drag/drop of activity completion events
description: Use the callbacks added by to allow dragging and dropping of activity completion action events in the calendar UI.
7.summary: Improve screen reader accessibility on calendar monthly view
description: The calendar monthly view needs to be screen reader accessible
8.summary: Add support for drag/drop of chat activity action events
description: Allow the action events created by the chat activity to be dragged and dropped in the calendar UI.
9.summary: Improve the keyboard navigation on the calendar monthly view
description: The calendar monthly view needs to be keyboard accessible
10.summary: Show event start time on monthly view
description: Display the events start time on the monthly calendar view. Perhaps a hover tooltip that shows it (though that isnt mobile friendly). Need to think of a good way, if possible.
11.summary: Consider adding link from day view to month view
description: When in the day view, it is not possible to navigate to the whole month view
12.summary: WS Fetchers should take an array of course IDs
description: Were talking about allowing events from multiples courses/categories in the future. To make this simpler now, we should change the existing WS to take an array of course IDs rather than a single course ID. The background code already supports this.
13.summary: Look at use of MutationObserver to remove stale handlers
description: See in the calendar_threemonth.
14.summary: Review calendar exporters and add automated tests
description: We have a bunch of new exporters for calendar, would be good to review those exporters making sure it does not have unused stuff and duplicated properties and code. Also would be great create automated tests for those exporters.
15.summary: Sanitise event exporters
description: The calendar_event_exporter and the event_exporter duplicate some logic (e.g. the URL) which should be moved to the base. Also, perhaps it shouldnt be called url, but typeurl or something like that. Its too vague.
16.summary: Drag and drop of repeated events in monthly view may need to be improved
description: The implementation of drag and drop in treats each of the repeated events as individual events rather than a group so dragging one doesnt affect the others. We may want to change that so that dragging one gives the user the option to have it affect the entire series.
17.summary: Rename user event type
description: The user event type is not very personal. I suggest we rename them to personal events everywhere. Pinging tsala for advice here too.
18.summary: limit the number of events shown at once
description: When more than X events are present on a day, we should add a Show more... and hide some of those.
19.summary: Stop loading parent record in repeat collection
description: The repeat collection constructor loads the parent record to check that the given id corresponds to a calendar event record however this results in an addition DB query for every event that is loaded, even if the event collection isnt used. We can just skip doing this query and trust the calling code to load the correct thing (especially since its all packed into the factory anyway) and only load the parent record when its required.
20.summary: Remove redundancy in calendar exporters for calendar month view
description: The exporters for the calendar month view are doing a few redundant calculations that can be removed.
21.summary: Check course enrolment later in event factory early bailout check
description: The early bailout check for the event factory checks that the user is enrolled in the course for a course event. This is just one of many checks that it does however it is one of the more expensive checks in terms of DB queries so it should only be done once weve performed all of the lighter weight checks and rules them out of the early bailout.
22.summary: Batch load groups in calendar_set_filters
description: The calendar_set_filters function currently loads the groups for each course one course at a time in a loop. We should just load all of the groups in a single query to reduce the number of DB queries and improve the performance.
23.summary: Load the calendar blocks after page load
description: We should load the calendar block and the 3 month block on the calendar page asynchronously after page load rather than blocking the page from rendering. Loading this content can be time consuming and its likely not the primary focus of the page given its a block so we shouldnt delay loading the page for it.
24.summary: Use related cache to load course modules during event export
description: Use the events related cache to batch load and cache the course module instances for activity events. Each instance may have multiple events. It would be better to load all of the modules up front and provide each of them to the exporter as required rather than load each module instance (potentially multiple times) as each event is exported.
25.summary: Lazy load context in calendar_event
description: The calendar_event class load the context in the constructor if one isnt provided in the constructor args. This is unnecessary and potentially causes a DB hit for no reason. Instead the class should just load the context when its actually needed. Its fairly simple in this case because weve overridden the magic getter function.
26.summary: Allow contexts to be passed into external format functions
description: The external format functions currently only take contexts by id and will then load the context within the function. This potentially adds an additional DB read if weve already loaded the context because we cant just simply pass it in. Instead the functions should take the id (for backwards compatibility) and the context itself. It can then load the context only if one isnt provided.
27.summary: Preload contexts in course_filter_selector
description: For larger users the course_filter_selector can load more courses than can be held in the course context cache which means each of them loads the context from the DB again in a loop. Instead we should just preload all of the contexts for the required courses in a single query. We could even have it check if the number courses are likely to exceed the context static cache limit and only do the preloading if it looks like well thrash the cache otherwise.
28.summary: Calendar: events from site home to be considered site events
description: An activity created on Site home is considered a course event as course 1 is actually the Site Home. The issue is that students and teacher dont realise that so it is confusing when on the calendar if you click on Hide site events it doesnt hide does events, but if you click on Hide course events it does. (Im saying students and teacher, but IMHO for admins isnt obvious either) Any event related to Site Home should be categorised under site events. To reproduce that create a chat on site home and go to the created event. Open the calendar and check that if you click on Hide course events it hides it, so it is categorised under course event.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: MUA Project: Download course content
description: This epic covers deliverable elements of the MUA "Download all" project described in . Issues created in this epic must be linked back to the relevant user stories that they solve. The intent of this issue is to bring together the project into a single issue covering most of the functionality and submit for integration. Minimum issues required are: ZipStream library Course content export API creation Implementation in at least two activities Settings pages UI functionality Additional activity implementation can be performed once the initial work has landed if required (though I suspect that all four of those identified here will be possible to land immediately).
| Solvable | 1.summary: Add ZipStream library to core
description: Look to add the ZipStream library to core: Without using composer Will need a new wrapper in core\zipstream to extend ZipStream\ZipStream and definition in lib/classes/component.php Wrapper should have a Moodle abstraction to get an instance with a default configuration suitable for most cases, like: code $writer = \core\zipstream::get_stream_writer($filename, $options); // OR $writer = \core\zipstream::get_file_writer($filename, $filepath, $options); code Note: For the get_file_writer option it is possible to pass a stream resource (i.e. one opened by fopen). See for information - its the setOutputStream($fd) option. Our own \core\zipstream should also offer functions: code public function add_file_from_stored_file(string $name, stored_file $file, ?FileOptions $options = null): void; public function add_file_from_string(string $name, string $filecontent, ?FileOptions $options = null): void; public function add_file_from_path(string $name, string $path, ?FileOptions $options = null): void; code
2.summary: Create course content export API
description: . API details The proposed API for course export is a part of a new API for content. The content API will include features for: identifying, locating, and controlling access of files within a component, or subsystem, which are a part of the File Storage API, or are served via one of the pluginfile.php endpoints ( / ) identifying, locating, and describing text areas within Moodle; and exporitng content stored within a component, or subsystem. The new API will be the content API, and will _not_ be a subsystem as it is expected to become more and more integral to parts of Moodle. All core classes will be located in the core\content namespace, with subsystems and components placing their code and extensions of this API in frankenstyle_component\content. The Content Export API will be located within the core\content\export namespace, and with subsystems and components placing their code and extensions of this API in frankenstyle_component\content\export. . API Components The API is made up of several core component types: The zipwriter, located in core\content\export\zipwriter is a wrapper around the ZipStream\ZipStream library and adds additional functionality and business logic related specifically to the export of content. It also includes helpers to add all pluginfiles which relate to a textarea, rewriting the references in that textarea to point to the exported files. Exporters, located in core\content\export\exporters are the classes which perform the work of collecting all relevant content together, and adding it to the zipwriter for a given context; Exportable Items, located in core\content\export\exportable_items and extending the abstract core\content\export\exportable_item class are helpers which describe the content being exported and prepare it for export. These cover cases such as the export of a single stored_file object, all stored_file instances within a specific filearea in the file_storage API, and the ecport of a text field within the database. These exportable_items allow an indivdual component (subsystem or plugin) to describe in an abstract way the content that they include. Each exportable item additionally includes the logic to actually add the content it describes to the zipwriter archive. Items which have been exported, located in core\content\export\exported_item which provide a generic way for a component to describe what was exported in such a way that can be used for a human-readable HTML file. This includes features such as a title, shown to the user, a list of files, and any string content (typically a text field like a description) that relates to the exported item. This API is designed to support the export of _course_ content including activities. At a sutiable time in the future it would be possible to extend it to support the export of blocks within a course, and other parts of the site, including course categories, or any other arbitrary context. . Exporters The exporters included in core\content\export\exporters as standard include: The abstract component_exporter which all other exporters must extend. It includes helpers used to fetch the context being exported, the name of the component being exported, and the zipwriter. It also includes helpers to export a set of exportable items. It describes a get_exportables() function which, by default, returns an empty array. The abstract mod_instance_exporter, which extends the abstract component_exporter, and is intended to be extended by activities implementing the API. For example, the mod_page component defines the mod_page\content\exporter which extends the mod_instance_exporter. This class adds helpers for fetching the cm_info and activity name. The mod_exporter which is used to export generic data which is defined in core. This is required as the "intro" feature of activities is _not_ an instance feature, but a part of of the general API for activities. For an activity support the intro field, it just has to declare that it supports the feature and core handles the rest. This class does not define its own list of exportables, but rather takes in the list of exportables from an activity and handles their export. It is a feature of the core\content\export API itself, and is not a part of the public API. It is declared final and cannot be extended. It is only called by the core API. Essentially the calling code would look a little like the following: code foreach ($contexts as $context) $component = get_component_from_context($context); // Some made up function to get the mod_name from an activity context. $exportables = ; // Fetch the exportables that the activity instance defines. $classname = component_exporter::get_classname_for_component($component); if (class_exists($classname)) $exporter = new $classname($context, $component, $user, $archive); $exportables = $exporter->get_exportables(); // Pass to the core mod_exporter to handle the remaining export. $modexporter = new \core\content\export\exportables\mod_exporter($context, $component, $user, $archive); $modexporter->export_exportables($exportables); code The export_exportables function is responsible for fetching the module intro, should the activity support it, adding all exportable content defined in the activity to the zipwriter, and generating a human-readable module index within the zip archive. The course_exporter, which is used to export a whole course. Again this is not a part of the public API, and only called by core\content itself. It does not return anything in the get_exportables() function but defines an export_course function which takes a list of all contexts which were successfully included in the export. This function adds the course index to the zip stream, which includes all course sections, and links to each activity within the course. Where an activity was included in the downloaded content, all links to the activity point to the module index created by the module_exporter. Where an activity was _not_ included in the downloaded content, links will point to the live site. This will be used in the future to support cases where a specific activity has been configured to not be exported. This allows the course structure to remain and all data to be shown in context, but for those activities not exported to point to the live site instead. . Course module exporters Any individual activity/course module can define its own exporter. Those included in this patch are for: mod_page - to export the Content part of a Page activity; mod_folder - to export all files and folders within the activity; and mod_resource - to export the single file within the activity. Each activity extends the core\content\export\exporters\mod_instance_exporter class, must override the get_exportables function, and have that function return a list of exportable_item instances. . Exportable items Exportable items are used to describe all content to be exported in an abstract and simplified way so as to reduce duplication across the codebase. All content is exported as either Text, or a collection of Files. No other types are supported or expected at this time. Three standard item types are defined in core, but where these do not fit a component is able to write its own exportable_item type. Most activities will likely export an exportable_textarea, which takes a table name, field name, and row ID. For text areas which can have files embedded it also takes an optional filearea, and itemid which are used to fetch the file from the File Storage API, and an optional pluginfileitemid which is the itemid used in the /pluginfile.php/ URL. When adding to the archive, all files in the filearea/itemid will be added to the zip archive. As each file is added, the content will be rewritten to find any use of in the text which relates to that specific file, and rewrite it to point to the version stored in the zip archive. After all files have been exported and the content is rewritten, any remaining uses of are rewritten to point to the live site, using the tokenpluginfile.php endpoint which allows viewing without requiring a current login. For activities which purely export files, two additional types have been defined: the exportable_stored_file, which allows for a single file to be exported; and the exportable_filearea, which allows for all files within a filearea/itemid combination for a specific component + context combination to be exported . Exported items In order that exported content can be adequately described in a human-readable format, all exported content must be described in an exported_item. This includes a Title, any string content, and two lists of files. It is consumed by the course_exporter and mod_exporter to create template data used in the Mustache templates.
3.summary: Course content download - add site admin and course level settings, implement in course user interface
description: As per mockups at Path to be: Home => Site administration => Courses => Course download Settings include: Enable course download Maximum download file size (maximum size of any individual file)
4.summary: Add "Download course content" option to course UI
description: The plan for this project is to add a single option to either: the course settings menu (for teachers); or !69560-student-menu.png|thumbnail! instead of the course settings cog if there is no menu (for students). !69560-teacher-menu.png|thumbnail! Need to confirm how this behaves on theme_classic too. After selecting the download option, a modal will open to confirm the download: !69560-modal.png|thumbnail! Need to confirm whether we can easily tell the size of the downloaded content - this may need an additional call adding to the coursecontentexport\exporter API. Need to respect both the course + site settings (, ) and user capability to download content. New capability: Name: moodle/course:downloadcontentexport Captype: read contextlevel: course archetype: student + teacher + editingteacher + manager = allow
5.summary: Implement coursecontentexport API for mod_page
description: Implement coursecontentexport API for mod_page
6.summary: Implement coursecontentexport API for mod_folder
description: Implement coursecontentexport API for mod_folder. Need to determine the level of granularity required here but I would recommend that we list all top-level items, i.e. given the following folder structure within the module: code Intro.pdf Lectures notes 20200813.ppt 20200820.ppt 20200827.ppt Videos 20200813 Lecture.mov 20200820 Examples.mov Lecture.mov 20200827 Lecture.mov code The following course contentitems would be returned for selection: || Name || type || id || | Intro.pdf | file | 3453 | | Lectures notes | folder | 399 | | Videos | folder | 99499 | See notes in for requirements re modname_supports() requirements.
7.summary: Implement content export API for mod_resource
description: Implement for mod_resource. A single contentitem would be returned with the file name of the file in the resource. The type and id of the contentitem are inconsequential because there is only one item in a file resource. This will also require definition of a new FEATURE_COURSECONTENTEXPORT constant and definition in resource_supports() in mod/resource/lib.php.
8.summary: Implement content export API for mod_label
description: Implement content export API for mod_label
9.summary: Implement course download behat testing
description: Add behat tests for the various site/course level settings and access to course content download.
10.summary: Confirm default maximum size per file in course downloads
description: The maximum size per file included in course downloads has been set to 50MB. We need to confirm/finalise whether we stick with that, or update it to another value.
11.summary: Implement course content download setting in bulk course upload
description: Course bulk upload should allow setting whether course content download is enabled or disabled on the course. This is blocked by , as the final course setting needs to be finalised before it can be implemented in bulk upload.
12.summary: Add common module settings for course content download
description: We need to add common module settings for course content download, so when the content download is enabled at the course-level, exporting of individual activities can be controlled: To keep this simple, it can use Enabled/Disabled, and follow the logic of "if course download is enabled, will this activity be part of the download". This means it would be enabled by default, so that if course download is enabled, the default would be all activities are part of the export (and means if course download is disabled, no activities can be exported, so this value is irrelevant). Allow _changes_ to the settings to be controlled by the same capability as the course-level setting. Need to ensure that an existing configuration is not modified by a user who does not have permission - i.e. privileged user sets it up with different settings, teacher updating the activity/course in other ways does not unset those values (ie the value could be visible but locked for teachers editing the activity without capability to edit this setting).
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: MUA Project: Download course content
description: This epic covers deliverable elements of the MUA "Download all" project described in . Issues created in this epic must be linked back to the relevant user stories that they solve. The intent of this issue is to bring together the project into a single issue covering most of the functionality and submit for integration. Minimum issues required are: ZipStream library Course content export API creation Implementation in at least two activities Settings pages UI functionality Additional activity implementation can be performed once the initial work has landed if required (though I suspect that all four of those identified here will be possible to land immediately).
### Response:
1.summary: Add ZipStream library to core
description: Look to add the ZipStream library to core: Without using composer Will need a new wrapper in core\zipstream to extend ZipStream\ZipStream and definition in lib/classes/component.php Wrapper should have a Moodle abstraction to get an instance with a default configuration suitable for most cases, like: code $writer = \core\zipstream::get_stream_writer($filename, $options); // OR $writer = \core\zipstream::get_file_writer($filename, $filepath, $options); code Note: For the get_file_writer option it is possible to pass a stream resource (i.e. one opened by fopen). See for information - its the setOutputStream($fd) option. Our own \core\zipstream should also offer functions: code public function add_file_from_stored_file(string $name, stored_file $file, ?FileOptions $options = null): void; public function add_file_from_string(string $name, string $filecontent, ?FileOptions $options = null): void; public function add_file_from_path(string $name, string $path, ?FileOptions $options = null): void; code
2.summary: Create course content export API
description: . API details The proposed API for course export is a part of a new API for content. The content API will include features for: identifying, locating, and controlling access of files within a component, or subsystem, which are a part of the File Storage API, or are served via one of the pluginfile.php endpoints ( / ) identifying, locating, and describing text areas within Moodle; and exporitng content stored within a component, or subsystem. The new API will be the content API, and will _not_ be a subsystem as it is expected to become more and more integral to parts of Moodle. All core classes will be located in the core\content namespace, with subsystems and components placing their code and extensions of this API in frankenstyle_component\content. The Content Export API will be located within the core\content\export namespace, and with subsystems and components placing their code and extensions of this API in frankenstyle_component\content\export. . API Components The API is made up of several core component types: The zipwriter, located in core\content\export\zipwriter is a wrapper around the ZipStream\ZipStream library and adds additional functionality and business logic related specifically to the export of content. It also includes helpers to add all pluginfiles which relate to a textarea, rewriting the references in that textarea to point to the exported files. Exporters, located in core\content\export\exporters are the classes which perform the work of collecting all relevant content together, and adding it to the zipwriter for a given context; Exportable Items, located in core\content\export\exportable_items and extending the abstract core\content\export\exportable_item class are helpers which describe the content being exported and prepare it for export. These cover cases such as the export of a single stored_file object, all stored_file instances within a specific filearea in the file_storage API, and the ecport of a text field within the database. These exportable_items allow an indivdual component (subsystem or plugin) to describe in an abstract way the content that they include. Each exportable item additionally includes the logic to actually add the content it describes to the zipwriter archive. Items which have been exported, located in core\content\export\exported_item which provide a generic way for a component to describe what was exported in such a way that can be used for a human-readable HTML file. This includes features such as a title, shown to the user, a list of files, and any string content (typically a text field like a description) that relates to the exported item. This API is designed to support the export of _course_ content including activities. At a sutiable time in the future it would be possible to extend it to support the export of blocks within a course, and other parts of the site, including course categories, or any other arbitrary context. . Exporters The exporters included in core\content\export\exporters as standard include: The abstract component_exporter which all other exporters must extend. It includes helpers used to fetch the context being exported, the name of the component being exported, and the zipwriter. It also includes helpers to export a set of exportable items. It describes a get_exportables() function which, by default, returns an empty array. The abstract mod_instance_exporter, which extends the abstract component_exporter, and is intended to be extended by activities implementing the API. For example, the mod_page component defines the mod_page\content\exporter which extends the mod_instance_exporter. This class adds helpers for fetching the cm_info and activity name. The mod_exporter which is used to export generic data which is defined in core. This is required as the "intro" feature of activities is _not_ an instance feature, but a part of of the general API for activities. For an activity support the intro field, it just has to declare that it supports the feature and core handles the rest. This class does not define its own list of exportables, but rather takes in the list of exportables from an activity and handles their export. It is a feature of the core\content\export API itself, and is not a part of the public API. It is declared final and cannot be extended. It is only called by the core API. Essentially the calling code would look a little like the following: code foreach ($contexts as $context) $component = get_component_from_context($context); // Some made up function to get the mod_name from an activity context. $exportables = ; // Fetch the exportables that the activity instance defines. $classname = component_exporter::get_classname_for_component($component); if (class_exists($classname)) $exporter = new $classname($context, $component, $user, $archive); $exportables = $exporter->get_exportables(); // Pass to the core mod_exporter to handle the remaining export. $modexporter = new \core\content\export\exportables\mod_exporter($context, $component, $user, $archive); $modexporter->export_exportables($exportables); code The export_exportables function is responsible for fetching the module intro, should the activity support it, adding all exportable content defined in the activity to the zipwriter, and generating a human-readable module index within the zip archive. The course_exporter, which is used to export a whole course. Again this is not a part of the public API, and only called by core\content itself. It does not return anything in the get_exportables() function but defines an export_course function which takes a list of all contexts which were successfully included in the export. This function adds the course index to the zip stream, which includes all course sections, and links to each activity within the course. Where an activity was included in the downloaded content, all links to the activity point to the module index created by the module_exporter. Where an activity was _not_ included in the downloaded content, links will point to the live site. This will be used in the future to support cases where a specific activity has been configured to not be exported. This allows the course structure to remain and all data to be shown in context, but for those activities not exported to point to the live site instead. . Course module exporters Any individual activity/course module can define its own exporter. Those included in this patch are for: mod_page - to export the Content part of a Page activity; mod_folder - to export all files and folders within the activity; and mod_resource - to export the single file within the activity. Each activity extends the core\content\export\exporters\mod_instance_exporter class, must override the get_exportables function, and have that function return a list of exportable_item instances. . Exportable items Exportable items are used to describe all content to be exported in an abstract and simplified way so as to reduce duplication across the codebase. All content is exported as either Text, or a collection of Files. No other types are supported or expected at this time. Three standard item types are defined in core, but where these do not fit a component is able to write its own exportable_item type. Most activities will likely export an exportable_textarea, which takes a table name, field name, and row ID. For text areas which can have files embedded it also takes an optional filearea, and itemid which are used to fetch the file from the File Storage API, and an optional pluginfileitemid which is the itemid used in the /pluginfile.php/ URL. When adding to the archive, all files in the filearea/itemid will be added to the zip archive. As each file is added, the content will be rewritten to find any use of in the text which relates to that specific file, and rewrite it to point to the version stored in the zip archive. After all files have been exported and the content is rewritten, any remaining uses of are rewritten to point to the live site, using the tokenpluginfile.php endpoint which allows viewing without requiring a current login. For activities which purely export files, two additional types have been defined: the exportable_stored_file, which allows for a single file to be exported; and the exportable_filearea, which allows for all files within a filearea/itemid combination for a specific component + context combination to be exported . Exported items In order that exported content can be adequately described in a human-readable format, all exported content must be described in an exported_item. This includes a Title, any string content, and two lists of files. It is consumed by the course_exporter and mod_exporter to create template data used in the Mustache templates.
3.summary: Course content download - add site admin and course level settings, implement in course user interface
description: As per mockups at Path to be: Home => Site administration => Courses => Course download Settings include: Enable course download Maximum download file size (maximum size of any individual file)
4.summary: Add "Download course content" option to course UI
description: The plan for this project is to add a single option to either: the course settings menu (for teachers); or !69560-student-menu.png|thumbnail! instead of the course settings cog if there is no menu (for students). !69560-teacher-menu.png|thumbnail! Need to confirm how this behaves on theme_classic too. After selecting the download option, a modal will open to confirm the download: !69560-modal.png|thumbnail! Need to confirm whether we can easily tell the size of the downloaded content - this may need an additional call adding to the coursecontentexport\exporter API. Need to respect both the course + site settings (, ) and user capability to download content. New capability: Name: moodle/course:downloadcontentexport Captype: read contextlevel: course archetype: student + teacher + editingteacher + manager = allow
5.summary: Implement coursecontentexport API for mod_page
description: Implement coursecontentexport API for mod_page
6.summary: Implement coursecontentexport API for mod_folder
description: Implement coursecontentexport API for mod_folder. Need to determine the level of granularity required here but I would recommend that we list all top-level items, i.e. given the following folder structure within the module: code Intro.pdf Lectures notes 20200813.ppt 20200820.ppt 20200827.ppt Videos 20200813 Lecture.mov 20200820 Examples.mov Lecture.mov 20200827 Lecture.mov code The following course contentitems would be returned for selection: || Name || type || id || | Intro.pdf | file | 3453 | | Lectures notes | folder | 399 | | Videos | folder | 99499 | See notes in for requirements re modname_supports() requirements.
7.summary: Implement content export API for mod_resource
description: Implement for mod_resource. A single contentitem would be returned with the file name of the file in the resource. The type and id of the contentitem are inconsequential because there is only one item in a file resource. This will also require definition of a new FEATURE_COURSECONTENTEXPORT constant and definition in resource_supports() in mod/resource/lib.php.
8.summary: Implement content export API for mod_label
description: Implement content export API for mod_label
9.summary: Implement course download behat testing
description: Add behat tests for the various site/course level settings and access to course content download.
10.summary: Confirm default maximum size per file in course downloads
description: The maximum size per file included in course downloads has been set to 50MB. We need to confirm/finalise whether we stick with that, or update it to another value.
11.summary: Implement course content download setting in bulk course upload
description: Course bulk upload should allow setting whether course content download is enabled or disabled on the course. This is blocked by , as the final course setting needs to be finalised before it can be implemented in bulk upload.
12.summary: Add common module settings for course content download
description: We need to add common module settings for course content download, so when the content download is enabled at the course-level, exporting of individual activities can be controlled: To keep this simple, it can use Enabled/Disabled, and follow the logic of "if course download is enabled, will this activity be part of the download". This means it would be enabled by default, so that if course download is enabled, the default would be all activities are part of the export (and means if course download is disabled, no activities can be exported, so this value is irrelevant). Allow _changes_ to the settings to be controlled by the same capability as the course-level setting. Need to ensure that an existing configuration is not modified by a user who does not have permission - i.e. privileged user sets it up with different settings, teacher updating the activity/course in other ways does not unset those values (ie the value could be visible but locked for teachers editing the activity without capability to edit this setting).
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Participant page filters project
description: Collection of issues for the Participant page filters project
| Unsolvable | 1.summary: Add global and/or/not (jointype)
description: We need to add the global and/or/not to the UI to match the prototype
2.summary: Create filter classes
description: Rather than passing in arbitrary strings, arrays, ints, and other values into tablelib to describe filter values, it would be beneficial to describe possible values more accurately. I would like to propose that we implement a set of value classes for filtering. code abstract class filterset public function __construct(filter, int $jointype): void; public function add_filter(string $name, filter $filter): self; public function validate(): bool // Ensure that only specified filter types are here. // Use a new function to get the description of those - e.g. $this->get_valid_filtertypes(); abstract class filter const JOINTYPE_NONE = 0; const JOINTYPE_ANY = 1; const JOINTYPE_ALL = 2; public function __construct(int $jointype, array $values): void; public function add_value($value): self; class group extends filter public function add_value(int $value): self $this->values = $value; public function validate(?int $courseid): bool // Check that theyre all valid groups in the (optionally-specified) course. code
3.summary: Move participant page refresh to fragments web service
description: So that we can update the table via a fragment
4.summary: Create a single filter for tables and the AMD structure behind this
description: The following is an approximation of the filter language used: code filterset = jointtype (filter (", " filter)) jointype = "All" / "Any" / "None" filter = (jointype filterthing ?= filtervalues) filterthing = "Group" / "Role" / "Keyword" / ... filtervalues = filtervalue ("," filtervalue) filtervalue = quoted-string code The initial part of the project will be to create a single filter. That is to say: A dropdown to select a pre-defined enumerated list for the Join Type (All, Any, None) for the current filter A dropdown to select a pre-defined enumerated list for the filterthing (Group, Role, etc.) for the current filter A way to select the values For the initial work: we will only be creating a working interface, it will not have any effect on the data. Purely visual. I would advise chosing Status as this is a simple, enumerated list, with static values and low complexity; We will only create the initial filter. Not a full filterset The follow-on work will then comprise of: Adding the remaining enumerated types (Groups, Roles, Enrolment methods) combining multiple filters into a filterset Adding the date since type. This is a _single_ value filter (number days) and no jointype Adding support for non-enumerated types (date since, keyword) The initial work will _not_ be plumbed in. It will be an isolated interface until the backend is ready to receive it.
5.summary: Add groups enumerated filter type to the participants filter
description: Add groups as the final enumerated filter type to the new participants filter.
6.summary: Add non-enumerated filter types to the participants filter
description: Add the "Keyword" (text input) and "Inactive for more than" (predefined dropdown options)_ filter types to the participants filter.
7.summary: Implement submitting participants filter to update the page
description: Introduce the AJAX submission of the participants filter, where values are submitted and the page is updated. This will also include things like updating the "Number of participants: 123" text on the page (if we are keeping that - TBC).
8.summary: Tweak styling of autocomplete functionality
description: Tweak all styling to get as close as possible to the mockups
9.summary: Update participants page for bulk actions
description: Bulk actions are participants-page specific. Need to update them to remove the set_selectall() fn in participants table
10.summary: Update the participants filter to support filtering with additional logic operators
description: Currently the participants_search class supports Any type filtering (intra/inter filter joins using logical OR). That class and related functions need to be updated to support the remaining two condition types, All and None (logical AND and NOT). This includes both joins within each filter, as well as the logical operators applied _between_ filters (ie the all/any/none join type set for the filterset when multiple filters are applied concurrently). Unit tests also need to be written (or uncommented where relevant).
11.summary: Update fetching of participants to support multiple values per filter
description: Currently, fetching of participants (ie user/lib.php:function user_get_participants, user_get_total_participants and related calls) only support submitting a single value per filter type. These need to be updated to support filtering by multiple values per filter type. For this issue, this will be restricted to the "Any" (logical OR) case.
12.summary: Add additional participants filter types and the ability to add multiple conditions to a filter set
description: Add the Roles and Enrolment Methods enumerated filter types to the new participants filter. Also, enable the "+ Add condition" functionality, so that multiple filters can be added concurrently. For this issue, only AND will be applied between each filter.
13.summary: Add the ability to set the join type between filters in the participants filter
description: Introduce the ability to join filter conditions in a filter set by "All", "Any" and "None" join (match) types. As shown in this step| of the Invision design.
14.summary: Limit "Add condition" button
description: Limit the number of times that the "Add condition" can be pressed to the total number of available conditions.
15.summary: Remove existing unified filter from the participants page
description: Once the new participants page filter is in place, the existing unified filter can be removed from that page.
16.summary: Remove old Unified filter
description: Remove the old unified filter Update behat tests to use the new UI
17.summary: Enrolment actions no longer work after dynamic table actions
description: The current participant table code for Viewing, Editing, and Removing enrolments binds to specific instances of buttons. When we reload the table those event handlers are dropped. We need to update the code to make it safe to work with the dynamic table code.
18.summary: "Show all count" link not updated on search
description: When a query is applied we do not update the "Show all count" link. We should _not_ update the "Number of participants" count because this is worded as being the total number of participants in the course. BUT we may which to change it to something more useful, like: code Showing 120 of 3000 participants code That is, to show the total number of people in the course (3000) and the number that are shown in the filter (120).
19.summary: "Enrol users" should not reload the page
description: When enrolling a user we should not need to reload the page.
20.summary: Update participants filtering by enrolment method and status to support remaining logical operators
description: The enrolment method and status filtering of participants currently only support Any type filtering (logical OR). Additional functionality needs to be implemented to support the remaining two condition types, All and None (logical AND and NOT). Unit tests for these also need to be added (or uncommented where relevant). In addition, unit tests need to be added for logical operators applied on the filterset itself (ie all/any/none _between_ filters), when multiple filter types are applied concurrently.
21.summary: Add text after participants filter outer match type (filterset join) to make its behaviour clearer
description: To improve the context/understanding of the filter, we should add "of the following:" text after the match type dropdown at the top of the filterset. This should be implemented as per the linked prototype screen (as discussed and agreed with Sander and Barbara). Note: When testing, to see the relevant section where the text is added, you must have at least two filter rows added to the participants filter (with only one, it will be hidden).
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Participant page filters project
description: Collection of issues for the Participant page filters project
### Response:
1.summary: Add global and/or/not (jointype)
description: We need to add the global and/or/not to the UI to match the prototype
2.summary: Create filter classes
description: Rather than passing in arbitrary strings, arrays, ints, and other values into tablelib to describe filter values, it would be beneficial to describe possible values more accurately. I would like to propose that we implement a set of value classes for filtering. code abstract class filterset public function __construct(filter, int $jointype): void; public function add_filter(string $name, filter $filter): self; public function validate(): bool // Ensure that only specified filter types are here. // Use a new function to get the description of those - e.g. $this->get_valid_filtertypes(); abstract class filter const JOINTYPE_NONE = 0; const JOINTYPE_ANY = 1; const JOINTYPE_ALL = 2; public function __construct(int $jointype, array $values): void; public function add_value($value): self; class group extends filter public function add_value(int $value): self $this->values = $value; public function validate(?int $courseid): bool // Check that theyre all valid groups in the (optionally-specified) course. code
3.summary: Move participant page refresh to fragments web service
description: So that we can update the table via a fragment
4.summary: Create a single filter for tables and the AMD structure behind this
description: The following is an approximation of the filter language used: code filterset = jointtype (filter (", " filter)) jointype = "All" / "Any" / "None" filter = (jointype filterthing ?= filtervalues) filterthing = "Group" / "Role" / "Keyword" / ... filtervalues = filtervalue ("," filtervalue) filtervalue = quoted-string code The initial part of the project will be to create a single filter. That is to say: A dropdown to select a pre-defined enumerated list for the Join Type (All, Any, None) for the current filter A dropdown to select a pre-defined enumerated list for the filterthing (Group, Role, etc.) for the current filter A way to select the values For the initial work: we will only be creating a working interface, it will not have any effect on the data. Purely visual. I would advise chosing Status as this is a simple, enumerated list, with static values and low complexity; We will only create the initial filter. Not a full filterset The follow-on work will then comprise of: Adding the remaining enumerated types (Groups, Roles, Enrolment methods) combining multiple filters into a filterset Adding the date since type. This is a _single_ value filter (number days) and no jointype Adding support for non-enumerated types (date since, keyword) The initial work will _not_ be plumbed in. It will be an isolated interface until the backend is ready to receive it.
5.summary: Add groups enumerated filter type to the participants filter
description: Add groups as the final enumerated filter type to the new participants filter.
6.summary: Add non-enumerated filter types to the participants filter
description: Add the "Keyword" (text input) and "Inactive for more than" (predefined dropdown options)_ filter types to the participants filter.
7.summary: Implement submitting participants filter to update the page
description: Introduce the AJAX submission of the participants filter, where values are submitted and the page is updated. This will also include things like updating the "Number of participants: 123" text on the page (if we are keeping that - TBC).
8.summary: Tweak styling of autocomplete functionality
description: Tweak all styling to get as close as possible to the mockups
9.summary: Update participants page for bulk actions
description: Bulk actions are participants-page specific. Need to update them to remove the set_selectall() fn in participants table
10.summary: Update the participants filter to support filtering with additional logic operators
description: Currently the participants_search class supports Any type filtering (intra/inter filter joins using logical OR). That class and related functions need to be updated to support the remaining two condition types, All and None (logical AND and NOT). This includes both joins within each filter, as well as the logical operators applied _between_ filters (ie the all/any/none join type set for the filterset when multiple filters are applied concurrently). Unit tests also need to be written (or uncommented where relevant).
11.summary: Update fetching of participants to support multiple values per filter
description: Currently, fetching of participants (ie user/lib.php:function user_get_participants, user_get_total_participants and related calls) only support submitting a single value per filter type. These need to be updated to support filtering by multiple values per filter type. For this issue, this will be restricted to the "Any" (logical OR) case.
12.summary: Add additional participants filter types and the ability to add multiple conditions to a filter set
description: Add the Roles and Enrolment Methods enumerated filter types to the new participants filter. Also, enable the "+ Add condition" functionality, so that multiple filters can be added concurrently. For this issue, only AND will be applied between each filter.
13.summary: Add the ability to set the join type between filters in the participants filter
description: Introduce the ability to join filter conditions in a filter set by "All", "Any" and "None" join (match) types. As shown in this step| of the Invision design.
14.summary: Limit "Add condition" button
description: Limit the number of times that the "Add condition" can be pressed to the total number of available conditions.
15.summary: Remove existing unified filter from the participants page
description: Once the new participants page filter is in place, the existing unified filter can be removed from that page.
16.summary: Remove old Unified filter
description: Remove the old unified filter Update behat tests to use the new UI
17.summary: Enrolment actions no longer work after dynamic table actions
description: The current participant table code for Viewing, Editing, and Removing enrolments binds to specific instances of buttons. When we reload the table those event handlers are dropped. We need to update the code to make it safe to work with the dynamic table code.
18.summary: "Show all count" link not updated on search
description: When a query is applied we do not update the "Show all count" link. We should _not_ update the "Number of participants" count because this is worded as being the total number of participants in the course. BUT we may which to change it to something more useful, like: code Showing 120 of 3000 participants code That is, to show the total number of people in the course (3000) and the number that are shown in the filter (120).
19.summary: "Enrol users" should not reload the page
description: When enrolling a user we should not need to reload the page.
20.summary: Update participants filtering by enrolment method and status to support remaining logical operators
description: The enrolment method and status filtering of participants currently only support Any type filtering (logical OR). Additional functionality needs to be implemented to support the remaining two condition types, All and None (logical AND and NOT). Unit tests for these also need to be added (or uncommented where relevant). In addition, unit tests need to be added for logical operators applied on the filterset itself (ie all/any/none _between_ filters), when multiple filter types are applied concurrently.
21.summary: Add text after participants filter outer match type (filterset join) to make its behaviour clearer
description: To improve the context/understanding of the filter, we should add "of the following:" text after the match type dropdown at the top of the filterset. This should be implemented as per the linked prototype screen (as discussed and agreed with Sander and Barbara). Note: When testing, to see the relevant section where the text is added, you must have at least two filter rows added to the participants filter (with only one, it will be hidden).
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: UX / UI analytics improvements for 3.8
description: List of UX / UI improvements to analytics for Moodle 3.8.
| Unsolvable | 1.summary: Analytics models should be sorted by name and not last modified
description: Since the model lists are ordered by time modified every time you change something in a model it climbs on top of the page, a better UX, in my opinion, would be just to leave it order by ID, instead of enabled, timemodified
2.summary: Insight notifications improvements
description: A UX review of the existing insights resulted in a list of improvements for our insights and for the current predictive models: (moved from ) The Actions menu includes options Acknowledged and Not useful with no explanation as to what happens if you click on them. If you follow the link Not useful in the email it also takes you to your Dashboard where a message is displayed Your action has been saved. with no explanation. hina from the UX team at Moodle HQ proposes to replace these buttons for a "Was this useful? Yes / No" Targets should be able to set the body of an insight (both for insights for multiple predictions and for insights for single predictions) so it is clear what the insight is about We need text bodies for the existing insights The upcoming activities due insight should include information about the upcoming activities (see screenshot attached below for an idea of how it will look like). The no teaching model should be reworded Target name to :Courses at risk of not starting (replace No Teaching) Change indicator titles to: Teacher availability and Student enrolment !photo_2019-08-29_11-05-33.jpg!
3.summary: Add bulk actions for analytics insights
description: It is possible for a teacher to receive many notifications of insights at once from learning analytics. The teacher should be able to select some or all of the insights and take action in bulk, e.g. send message, acknowledge, mark as not useful, etc. A confirmation screen is recommended before executing bulk actions.
4.summary: Show information about the indicator calculated value
description: The screenshot below is from the predictions details page (including the new indicators table with the visible caption and no table headers) We discussed with Hina and Elizabeth the possibility to include information about the indicators calculation in the insights page, right below the value of each indicator value. hina, I cant recall if the calculation info should be always shown or it should only appear when the user clicks in a expand icon or something like that, any tips? I assume that we will have some length restrictions on the explanatory text if it is always shown. !Screenshot from 2019-09-04 07-31-20.png|thumbnail! To have separate language strings to explain the value calculation may be better than to reuse and expand indicators help text, as all indicators should have a help button, but not all the indicators require an explanation on how the value is calculated or what does it mean. emdalton1 is keen to work on these new strings, this is the list of indicators we have in 3.8: Course accessed after end date Course accessed before start date Any write action Any write action in the course Read actions amount Activities due Completion tracking enabled There are no students There are no teachers Course potential cognitive depth Course potential social breadth User profile is completed User is tracking forums Category is empty Test setting is set User activity User is suspended Assignment cognitive Assignment social Book cognitive Book social Chat cognitive Chat social Choice cognitive Choice social Database cognitive Database social Feedback cognitive Feedback social Folder cognitive Folder social Forum cognitive Forum social Glossary cognitive Glossary social IMS pkg cognitive IMS pkg social Label cognitive Label social Lesson cognitive Lesson social LTI cognitive LTI social Page cognitive Page social Quiz cognitive Quiz social File cognitive File social SCORM cognitive SCORM social Survey cognitive Survey social URL cognitive URL social Wiki cognitive Wiki social Workshop cognitive Workshop social I will wait until the language strings are ready to modify the template to show the info. This issue would be a good opportunity to review our current indicators help strings. All the indicators related to the community of inquiry model assume that the reader knows what cognitive depth and and social breadth mean.
5.summary: Rename the effectiveness report to "Insight results"
description: We went through the effectiveness report during the UX review we had with hina and emdalton1. The conclusion was that the report name is not intuitive enough. We could rename it to "Insight results". This is how the report looks like currently: !Screenshot from 2019-09-09 09-47-33.png|thumbnail! A possible replacement for the current view would be this: !Screenshot from 2019-09-09 09-47-19.png|thumbnail!
6.summary: Add a help text next to the model name in the insights report
description: During one of the UX improvement meetings it was suggested that an explanatory text about the model could be included in the insights report. A help icon next to the heading could be less intrusive than a static notification text that gets displayed on every page load. !insights-report-help.png|thumbnail!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: UX / UI analytics improvements for 3.8
description: List of UX / UI improvements to analytics for Moodle 3.8.
### Response:
1.summary: Analytics models should be sorted by name and not last modified
description: Since the model lists are ordered by time modified every time you change something in a model it climbs on top of the page, a better UX, in my opinion, would be just to leave it order by ID, instead of enabled, timemodified
2.summary: Insight notifications improvements
description: A UX review of the existing insights resulted in a list of improvements for our insights and for the current predictive models: (moved from ) The Actions menu includes options Acknowledged and Not useful with no explanation as to what happens if you click on them. If you follow the link Not useful in the email it also takes you to your Dashboard where a message is displayed Your action has been saved. with no explanation. hina from the UX team at Moodle HQ proposes to replace these buttons for a "Was this useful? Yes / No" Targets should be able to set the body of an insight (both for insights for multiple predictions and for insights for single predictions) so it is clear what the insight is about We need text bodies for the existing insights The upcoming activities due insight should include information about the upcoming activities (see screenshot attached below for an idea of how it will look like). The no teaching model should be reworded Target name to :Courses at risk of not starting (replace No Teaching) Change indicator titles to: Teacher availability and Student enrolment !photo_2019-08-29_11-05-33.jpg!
3.summary: Add bulk actions for analytics insights
description: It is possible for a teacher to receive many notifications of insights at once from learning analytics. The teacher should be able to select some or all of the insights and take action in bulk, e.g. send message, acknowledge, mark as not useful, etc. A confirmation screen is recommended before executing bulk actions.
4.summary: Show information about the indicator calculated value
description: The screenshot below is from the predictions details page (including the new indicators table with the visible caption and no table headers) We discussed with Hina and Elizabeth the possibility to include information about the indicators calculation in the insights page, right below the value of each indicator value. hina, I cant recall if the calculation info should be always shown or it should only appear when the user clicks in a expand icon or something like that, any tips? I assume that we will have some length restrictions on the explanatory text if it is always shown. !Screenshot from 2019-09-04 07-31-20.png|thumbnail! To have separate language strings to explain the value calculation may be better than to reuse and expand indicators help text, as all indicators should have a help button, but not all the indicators require an explanation on how the value is calculated or what does it mean. emdalton1 is keen to work on these new strings, this is the list of indicators we have in 3.8: Course accessed after end date Course accessed before start date Any write action Any write action in the course Read actions amount Activities due Completion tracking enabled There are no students There are no teachers Course potential cognitive depth Course potential social breadth User profile is completed User is tracking forums Category is empty Test setting is set User activity User is suspended Assignment cognitive Assignment social Book cognitive Book social Chat cognitive Chat social Choice cognitive Choice social Database cognitive Database social Feedback cognitive Feedback social Folder cognitive Folder social Forum cognitive Forum social Glossary cognitive Glossary social IMS pkg cognitive IMS pkg social Label cognitive Label social Lesson cognitive Lesson social LTI cognitive LTI social Page cognitive Page social Quiz cognitive Quiz social File cognitive File social SCORM cognitive SCORM social Survey cognitive Survey social URL cognitive URL social Wiki cognitive Wiki social Workshop cognitive Workshop social I will wait until the language strings are ready to modify the template to show the info. This issue would be a good opportunity to review our current indicators help strings. All the indicators related to the community of inquiry model assume that the reader knows what cognitive depth and and social breadth mean.
5.summary: Rename the effectiveness report to "Insight results"
description: We went through the effectiveness report during the UX review we had with hina and emdalton1. The conclusion was that the report name is not intuitive enough. We could rename it to "Insight results". This is how the report looks like currently: !Screenshot from 2019-09-09 09-47-33.png|thumbnail! A possible replacement for the current view would be this: !Screenshot from 2019-09-09 09-47-19.png|thumbnail!
6.summary: Add a help text next to the model name in the insights report
description: During one of the UX improvement meetings it was suggested that an explanatory text about the model could be included in the insights report. A help icon next to the heading could be less intrusive than a static notification text that gets displayed on every page load. !insights-report-help.png|thumbnail!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: META: Dev site reboot
description: Dev site to have a dark blue colour scheme. - front page
| Solvable | 1.summary: Create a separate skin for the dev docs
description: The dev docs should have a dark blue colour scheme, whereas the user docs should be purple.
2.summary: Upgrade dev.moodle.org and add sites bar and new theme
description: Dark blue colour scheme, moodleclean theme. Upgrade checklist:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: META: Dev site reboot
description: Dev site to have a dark blue colour scheme. - front page
### Response:
1.summary: Create a separate skin for the dev docs
description: The dev docs should have a dark blue colour scheme, whereas the user docs should be purple.
2.summary: Upgrade dev.moodle.org and add sites bar and new theme
description: Dark blue colour scheme, moodleclean theme. Upgrade checklist:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Define high-level technical architecture
description: See issues included in this epic.
| Solvable | 1.summary: Specify criteria for technology/protocol/standards choices
description: WIP
2.summary: Create diagrams to represent each option
description: WIP
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Define high-level technical architecture
description: See issues included in this epic.
### Response:
1.summary: Specify criteria for technology/protocol/standards choices
description: WIP
2.summary: Create diagrams to represent each option
description: WIP
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Assessment Analytics Working group priority issues
description: These issues are generated from the work of the Assessment Analytics working group| that took place at MootAu15| The issues relate mainly to assignment feedback and how that can be made more relevant and useful.
| Unsolvable | 1.summary: Feedback Response Rating - Allow students to indicate whether feedback was helpful
description: As a means of encouraging students to reflect on feedback given to them and to offer teachers/markers an indication of the value the student places on the provided feedback, controls that allow students to rate feedback should be added to the Assignment module. It may be possible to achieve this as an Assignment Feedback plugin. Settings Settings would need to be added to the Assignment settings page. These could be controlled site-wide by administrators along with other Assignment settings. This functionality needs to be turned off by default as only a small subset of teachers will use this. It should be able to be controlled by the teacher/admin when setting up an assignment. The selection of usefulness is based on a scale. The scale can be based on a new default scale with elements not useful, useful, extremely useful, or possibly it could simply be a plus-one/thumbs-up scale, achieved with a single value scale. The teacher/institution should be able to add/modify/select an appropriate scale and use different scales for different assignments. Display for student The main part of this is a drop-down list added to the assignment page so that when it is viewed by a student, the student has the potential to choose an option from the scale. The rating will be for the entire feedback on a submission (not individual pieces of the feedback or rubric criteria). Where there are resubmissions, the rating should be associated with individual submissions. There is currently the potential for students to engage in a dialogue with a marker through the comments feature used in the assignment. This could be brought alongside the rating to bring these two together. !Student view.png|thumbnail! Display for teacher/marker If this feature were enabled, the teacher would see an additional column in the Assignment marking table with the rating provided by each student. The comment on the feedback could also be shown in a column, although this is not so critical. When viewing the students submission, the rating will be shown with the feedback. Where there are resubmissions, the rating should be associated with individual submissions. A completion condition should be added related to providing a rating on feedback. This could them be used with activity restrictions to prevent a student from proceeding to the next assignment without rating feedback from a past assignment. !Teacher view.png|thumbnail! For the course examiner/convener/manager Possibly a report showing feedback from all students in an assignment and perhaps over an entire course. The ratings might be grouped by marker, which could be useful where multiple markers are used. This interface is less critical than the interface for student and teacher/marker. Some considerations The rating will be associated with a submission and feedback on the submission, so usually the submitting student and the marker will be known. Where blind marking is used, this should be respected in all interfaces. The prompts used to request a rating and a comment should be well-considered. They do not need to be configurable (except through string changes). Suggestions are: Please provide a rating for your assignment feedback Please comment on your assignment feedback A mechanism to encourage students to provide the feedback should be considered. Perhaps there can be something that prompts them if they leave the page without leaving feedback. As the page is normally something that is viewed, rather than being a form, forcing feedback might not be possible.
2.summary: Record whether students have viewed feedback
description: Currently there is no record of whether a student has viewed feedback in the Assignment module. There is an event that is triggered when a student views the assignment page, but this is the same when there is feedback present or not. Adding an event An event should be triggered each time the student views the assignment page while feedback is present. Recording views A record that the student has viewed feedback also needs to be added to the database with the submission. Even though an event would be logged, this is necessary for efficiency and to associate the view with the submission. Recording/updating a time-stamp for the last view was considered to be the best means of showing that/when the student has viewed the feedback. Showing views to teachers/markers In the Assignment marking page, teachers/markers will be able to see whether a student has viewed their feedback. !Feedback viewed in marking table.png|thumbnail! They may wish to contact students who have not yet viewed their feedback. It was suggested that this could be achieved by adding a mass action on the Assignment marking page (). Also, teachers will see feedback of students and whether they have viewed it while marking subsequent assignments (). Add a completion condition A completion condition should be added to for viewing feedback so that teachers could control access to subsequent assignments before a student has viewed (and hopefully learned from) the current assignment.
3.summary: Show feedback from past assignments when marking
description: When marking an individual assignment, show all forms of feedback from previous assignments, with feedback rating (MDL_51754) and viewing (whether they have viewed the feedback) (MDL_51761) ...from all past graded assignments in the course. !Teacher view of past feedback.png|thumbnail! Each past assignments feedback will be expandable and loaded on-demand (using AJAX). Some considerations Past feedback should not be show during blind marking. Teachers/markers should only be able to see feedback from past assignments they have permission to grade. This could be achieved as a feedback plugin, on by default and possibly controllable by teachers (or possibly mandatory). Where there were multiple attempts in a past assignment, only the last feedback (with related rating and viewing) should be shown. There should be a link back to a past assignment in case the teacher/marker wants to see the feedback in context. This must work with backup and restore. Showing feedback from past assignments in other courses should also be considered. Teachers should only be able to see feedback they would normally be able to see. There might be some sort of control to govern this so that it can be turned on/off.
4.summary: Shorten feedback shown in the Gradebook User report
description: Currently the user report shows the entire feedback comment to students. This is bad because: Such feedback can be lengthy and Feedback should be shown in a primary location so that views of feedback can be recorded. When feedback is shown in the User report, it should be truncated and a "More..." link should be added to entice the student to the assignment page to see the feedback in context.
5.summary: Create a Feedback block on the Dashboard
description: In order to encourage students to view their Assignment feedback, the addition of a block on the Dashboard page may help. The block would show the latest N pieces of feedback from across courses. Links will not disappear after they are shown (unlike the Course overview bloc), until they drop off the top N. The block would include a short snippet (20-30 letters) of feedback with a "More..." link to take students to the full feedback. Marks would not be shown in the block. Where there is no feedback comment, the link could be generic, such as "See your feedback..." At the top of the block, this may be prefaced with a statement "You have received feedback on the following assignments." (although that may be unnecessary.)
6.summary: Allow messages to be sent from the Assignment marking page
description: It would be useful to be able to sent a message to a selection of students from the Assignment page. Reminding students who have not yet submitted Contacting students who have not viewed feedback Making an announcement to a selection of students (such as an extension or potential to resubmit) There are already checkboxes for mass actions on the page, this functionality would only require an additional action to be added to the "With selected..." drop-down.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Assessment Analytics Working group priority issues
description: These issues are generated from the work of the Assessment Analytics working group| that took place at MootAu15| The issues relate mainly to assignment feedback and how that can be made more relevant and useful.
### Response:
1.summary: Feedback Response Rating - Allow students to indicate whether feedback was helpful
description: As a means of encouraging students to reflect on feedback given to them and to offer teachers/markers an indication of the value the student places on the provided feedback, controls that allow students to rate feedback should be added to the Assignment module. It may be possible to achieve this as an Assignment Feedback plugin. Settings Settings would need to be added to the Assignment settings page. These could be controlled site-wide by administrators along with other Assignment settings. This functionality needs to be turned off by default as only a small subset of teachers will use this. It should be able to be controlled by the teacher/admin when setting up an assignment. The selection of usefulness is based on a scale. The scale can be based on a new default scale with elements not useful, useful, extremely useful, or possibly it could simply be a plus-one/thumbs-up scale, achieved with a single value scale. The teacher/institution should be able to add/modify/select an appropriate scale and use different scales for different assignments. Display for student The main part of this is a drop-down list added to the assignment page so that when it is viewed by a student, the student has the potential to choose an option from the scale. The rating will be for the entire feedback on a submission (not individual pieces of the feedback or rubric criteria). Where there are resubmissions, the rating should be associated with individual submissions. There is currently the potential for students to engage in a dialogue with a marker through the comments feature used in the assignment. This could be brought alongside the rating to bring these two together. !Student view.png|thumbnail! Display for teacher/marker If this feature were enabled, the teacher would see an additional column in the Assignment marking table with the rating provided by each student. The comment on the feedback could also be shown in a column, although this is not so critical. When viewing the students submission, the rating will be shown with the feedback. Where there are resubmissions, the rating should be associated with individual submissions. A completion condition should be added related to providing a rating on feedback. This could them be used with activity restrictions to prevent a student from proceeding to the next assignment without rating feedback from a past assignment. !Teacher view.png|thumbnail! For the course examiner/convener/manager Possibly a report showing feedback from all students in an assignment and perhaps over an entire course. The ratings might be grouped by marker, which could be useful where multiple markers are used. This interface is less critical than the interface for student and teacher/marker. Some considerations The rating will be associated with a submission and feedback on the submission, so usually the submitting student and the marker will be known. Where blind marking is used, this should be respected in all interfaces. The prompts used to request a rating and a comment should be well-considered. They do not need to be configurable (except through string changes). Suggestions are: Please provide a rating for your assignment feedback Please comment on your assignment feedback A mechanism to encourage students to provide the feedback should be considered. Perhaps there can be something that prompts them if they leave the page without leaving feedback. As the page is normally something that is viewed, rather than being a form, forcing feedback might not be possible.
2.summary: Record whether students have viewed feedback
description: Currently there is no record of whether a student has viewed feedback in the Assignment module. There is an event that is triggered when a student views the assignment page, but this is the same when there is feedback present or not. Adding an event An event should be triggered each time the student views the assignment page while feedback is present. Recording views A record that the student has viewed feedback also needs to be added to the database with the submission. Even though an event would be logged, this is necessary for efficiency and to associate the view with the submission. Recording/updating a time-stamp for the last view was considered to be the best means of showing that/when the student has viewed the feedback. Showing views to teachers/markers In the Assignment marking page, teachers/markers will be able to see whether a student has viewed their feedback. !Feedback viewed in marking table.png|thumbnail! They may wish to contact students who have not yet viewed their feedback. It was suggested that this could be achieved by adding a mass action on the Assignment marking page (). Also, teachers will see feedback of students and whether they have viewed it while marking subsequent assignments (). Add a completion condition A completion condition should be added to for viewing feedback so that teachers could control access to subsequent assignments before a student has viewed (and hopefully learned from) the current assignment.
3.summary: Show feedback from past assignments when marking
description: When marking an individual assignment, show all forms of feedback from previous assignments, with feedback rating (MDL_51754) and viewing (whether they have viewed the feedback) (MDL_51761) ...from all past graded assignments in the course. !Teacher view of past feedback.png|thumbnail! Each past assignments feedback will be expandable and loaded on-demand (using AJAX). Some considerations Past feedback should not be show during blind marking. Teachers/markers should only be able to see feedback from past assignments they have permission to grade. This could be achieved as a feedback plugin, on by default and possibly controllable by teachers (or possibly mandatory). Where there were multiple attempts in a past assignment, only the last feedback (with related rating and viewing) should be shown. There should be a link back to a past assignment in case the teacher/marker wants to see the feedback in context. This must work with backup and restore. Showing feedback from past assignments in other courses should also be considered. Teachers should only be able to see feedback they would normally be able to see. There might be some sort of control to govern this so that it can be turned on/off.
4.summary: Shorten feedback shown in the Gradebook User report
description: Currently the user report shows the entire feedback comment to students. This is bad because: Such feedback can be lengthy and Feedback should be shown in a primary location so that views of feedback can be recorded. When feedback is shown in the User report, it should be truncated and a "More..." link should be added to entice the student to the assignment page to see the feedback in context.
5.summary: Create a Feedback block on the Dashboard
description: In order to encourage students to view their Assignment feedback, the addition of a block on the Dashboard page may help. The block would show the latest N pieces of feedback from across courses. Links will not disappear after they are shown (unlike the Course overview bloc), until they drop off the top N. The block would include a short snippet (20-30 letters) of feedback with a "More..." link to take students to the full feedback. Marks would not be shown in the block. Where there is no feedback comment, the link could be generic, such as "See your feedback..." At the top of the block, this may be prefaced with a statement "You have received feedback on the following assignments." (although that may be unnecessary.)
6.summary: Allow messages to be sent from the Assignment marking page
description: It would be useful to be able to sent a message to a selection of students from the Assignment page. Reminding students who have not yet submitted Contacting students who have not viewed feedback Making an announcement to a selection of students (such as an extension or potential to resubmit) There are already checkboxes for mass actions on the page, this functionality would only require an additional action to be added to the "With selected..." drop-down.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Replacement for the course and category management pages
description: This issue has been created to look at a possible replacement for the course and category management pages within Moodle. The management system we currently have is getting pretty antiquated and could really do with a make over and could be greatly streamlined to get all of the desired/common features onto fewer pages. It would also be great if the process of adding, moving and deleting categories could be simplified and likely JS enhancement could help this (think AJAX loading and drag + drop).
| Unsolvable | 1.summary: Add functionality to duplicate a course within the selected category
description: Thanks Hartmut for the suggestion! Please see this comment:
2.summary: Write Behat tests for this new UI
description: This is two parts really: Write behat tests for this. Remove behat tests for the old interfaces.
3.summary: Remove deprecated course management files
description: As part of the work done on several files were deprecated. These should be removed after the release of 2.6 and before the release of 2.7.
4.summary: Allow categories in the management interface to be sorted by drag and drop
description: Raised by Ankit on .
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Replacement for the course and category management pages
description: This issue has been created to look at a possible replacement for the course and category management pages within Moodle. The management system we currently have is getting pretty antiquated and could really do with a make over and could be greatly streamlined to get all of the desired/common features onto fewer pages. It would also be great if the process of adding, moving and deleting categories could be simplified and likely JS enhancement could help this (think AJAX loading and drag + drop).
### Response:
1.summary: Add functionality to duplicate a course within the selected category
description: Thanks Hartmut for the suggestion! Please see this comment:
2.summary: Write Behat tests for this new UI
description: This is two parts really: Write behat tests for this. Remove behat tests for the old interfaces.
3.summary: Remove deprecated course management files
description: As part of the work done on several files were deprecated. These should be removed after the release of 2.6 and before the release of 2.7.
4.summary: Allow categories in the management interface to be sorted by drag and drop
description: Raised by Ankit on .
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Update Dock JS to use Shifter, and be more performant
description: Update the Dock JS to use Shifter, and improve performance aspects.
| Unsolvable | 1.summary: Convert the dock to a YUI module.
description: This is an easy one.... ;) Convert the dock into a YUI module that gets built by shifter.
2.summary: Change naming pattern for dock-loader to use submodule naming pattern
description: As discussed in , this should use an appropriate submodule name - e.g. moodle-core-dock-loader rather than moodle-core-dockloader.
3.summary: Change the dock action icons to be rendered into the HTML
description: Currently the dock action icons are added by JS during execution. However this is bad for front end performance and it would be much more effecient to render them if required when producing the pages HTML. This would also free up the loader so that it didnt need to recognised blocks (processing their ids and stubs)
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Update Dock JS to use Shifter, and be more performant
description: Update the Dock JS to use Shifter, and improve performance aspects.
### Response:
1.summary: Convert the dock to a YUI module.
description: This is an easy one.... ;) Convert the dock into a YUI module that gets built by shifter.
2.summary: Change naming pattern for dock-loader to use submodule naming pattern
description: As discussed in , this should use an appropriate submodule name - e.g. moodle-core-dock-loader rather than moodle-core-dockloader.
3.summary: Change the dock action icons to be rendered into the HTML
description: Currently the dock action icons are added by JS during execution. However this is bad for front end performance and it would be much more effecient to render them if required when producing the pages HTML. This would also free up the loader so that it didnt need to recognised blocks (processing their ids and stubs)
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: New JS Framework
description: Implement a new JS Framework based on the doc and discussion here: Components: RequireJS Grunt JQuery UI (with accessibility wrapper)
| Unsolvable | 1.summary: RequireJS AMD Javascript loader
description: Add the RequireJS + hooks required to load AMD modules.
2.summary: Templates for renderers
description: Docs link: Forum link: Add mustache support for templates. Allow identical calling from php or javascript.
3.summary: Unified Ajax script handler
description: Create a core ajax script handler (and AMD wrapper) with these features: Can call any registered webservice using sesskey as a token Can call multiple functions in one request and return separate responses Can register callbacks to receive the response from: Success of all requests Any single failure Success or failure of any specific request It will be a big improvement if we can stop building separate AJAX apis and web service APIs, as well as many separate AJAX handlers with no consistent responses/error handling.
4.summary: Delete the yui versions of the bootstrap plugins
description: We have jquery now - lets use the less buggy upstream versions.
5.summary: Add an AMD log module
description: We could wrap Y.log for now - but I like this look of this:
6.summary: Reorganise the dev docs linking to new JS tooling
description: Once the new JS infrastructure is in place we need to make sure that all the beautiful documentation which has been created is moved front and centre in the dev wiki and structured well so that developers know how to do things in the brave new world. We should also: A) remove all outdated JS docs B) update the remaining ones to list old and new ways of doing things Note: we should be careful to provide some information for people developing on legacy versions.
7.summary: Add Less compilation task to GruntJS
description: It would be nice if we have a GruntJS task to replicate the same functionality that running "mdk css -c" yields.
8.summary: Log to the JS console when uncached strings are fetch via ajax
description: This will allow developers to see what strings they should add to strings_for_js calls in their pages.
9.summary: Cache strings and templates in browser storage (localstorage)
description: Use a AMD library to hide browser differences.
10.summary: Add a tool to browse templates in the current theme.
description: The idea is that a special comment could be added to the template that would mark it as suitable for displaying in the tool. The comment can include sample "context" data in json format so that the tool can render the template with some sample content. This would then allow you to view all the defined templates in a custom theme, or switch languages etc. This tool does not necessarily have to be in core (there are mixed opinions on dev tools in core). It can live in plugin land as long as the syntax for the comments is agreed - and added to core templates by default. This issue supersedes (Element library).
11.summary: Make the template library smarter when displaying documentation
description: - The admin tool templatelibrary should indicate where the file was found (current theme, component directory, etc...). The notification templates for theme_base are still in the wrong directory (was missed in ). - The admin tool templatelibrary should display the documentation from the core template, I dont think custom templates should be responsible for adding documentation, in fact they should not even specific options to their templates.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: New JS Framework
description: Implement a new JS Framework based on the doc and discussion here: Components: RequireJS Grunt JQuery UI (with accessibility wrapper)
### Response:
1.summary: RequireJS AMD Javascript loader
description: Add the RequireJS + hooks required to load AMD modules.
2.summary: Templates for renderers
description: Docs link: Forum link: Add mustache support for templates. Allow identical calling from php or javascript.
3.summary: Unified Ajax script handler
description: Create a core ajax script handler (and AMD wrapper) with these features: Can call any registered webservice using sesskey as a token Can call multiple functions in one request and return separate responses Can register callbacks to receive the response from: Success of all requests Any single failure Success or failure of any specific request It will be a big improvement if we can stop building separate AJAX apis and web service APIs, as well as many separate AJAX handlers with no consistent responses/error handling.
4.summary: Delete the yui versions of the bootstrap plugins
description: We have jquery now - lets use the less buggy upstream versions.
5.summary: Add an AMD log module
description: We could wrap Y.log for now - but I like this look of this:
6.summary: Reorganise the dev docs linking to new JS tooling
description: Once the new JS infrastructure is in place we need to make sure that all the beautiful documentation which has been created is moved front and centre in the dev wiki and structured well so that developers know how to do things in the brave new world. We should also: A) remove all outdated JS docs B) update the remaining ones to list old and new ways of doing things Note: we should be careful to provide some information for people developing on legacy versions.
7.summary: Add Less compilation task to GruntJS
description: It would be nice if we have a GruntJS task to replicate the same functionality that running "mdk css -c" yields.
8.summary: Log to the JS console when uncached strings are fetch via ajax
description: This will allow developers to see what strings they should add to strings_for_js calls in their pages.
9.summary: Cache strings and templates in browser storage (localstorage)
description: Use a AMD library to hide browser differences.
10.summary: Add a tool to browse templates in the current theme.
description: The idea is that a special comment could be added to the template that would mark it as suitable for displaying in the tool. The comment can include sample "context" data in json format so that the tool can render the template with some sample content. This would then allow you to view all the defined templates in a custom theme, or switch languages etc. This tool does not necessarily have to be in core (there are mixed opinions on dev tools in core). It can live in plugin land as long as the syntax for the comments is agreed - and added to core templates by default. This issue supersedes (Element library).
11.summary: Make the template library smarter when displaying documentation
description: - The admin tool templatelibrary should indicate where the file was found (current theme, component directory, etc...). The notification templates for theme_base are still in the wrong directory (was missed in ). - The admin tool templatelibrary should display the documentation from the core template, I dont think custom templates should be responsible for adding documentation, in fact they should not even specific options to their templates.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.2
description: In Moodle 4.2 we can remove functionality that was deprecated in 3.10 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Final deprecation of plagiarism functions
description: Do the final deprecation of: plagiarism_save_form_elements() plagiarism_get_form_elements_module() plagiarism_plugin::get_form_elements_module() plagiarism_plugin::save_form_elements() The first two files need to be moved into deprecatedlib.php and the body of the function removed. The second two methods just need to be removed. Code calling these functions should be removed from mod_assign, mod_forum, and mod_workshop. plagiarism_load_available_plugins method should be deprecated too.
2.summary: Replace XMPP library in Moodle to something supported and move from core to message/output/jabber
description: just had a chat with Nathan Fritz, I guess its self-explanatory: (15:52:32) Marina: Hello Nathan, my name is Marina Glancy and I work for Moodle HQ (15:53:24) Marina: We are preparing Moodle for PHP7 at the moment and found an issue in XMPP (15:53:32) Marina: for more details (15:53:39) Fritzy: okay... (15:54:00) Marina: do you maintain source code in svn only? no github? (15:54:09) Fritzy: I havent supported that library in a long time -- since before I was on github. (15:54:33) Fritzy: is the most recent (he was going to start maintaining it) (15:54:45) Marina: thats a shame, should we just patch it in our product then? (15:55:08) Fritzy: Yup. If your developers want to take it over, thatd be great too. (15:55:16) Fritzy: Feel free to publish it on Github. (15:55:28) Fritzy: I can give you an MIT version (15:55:32) Marina: last commit 5 years ago :( (15:55:46) Fritzy: Yup, pretty old. There are better maintained XMPP libraries for PHP (15:56:01) Fritzy: (15:56:35) Fritzy: (15:57:34) Fritzy: In any case, if you like I can make a fork in a more permissive license. But yeah, Id recomend moving to something more maintained
3.summary: Search: Remove support for add_documents function with 5 return values deprecated in Moodle 3.10
description: The change in means the add_documents function in search engine plugins is expected to return 6 values. There is backwards compatibility for 5 return values in two places (the index and index_context functions in search/classes/manager.php) which should be deleted in Moodle 4.2. Note: I have currently added this as a subtask of my main item, it should be moved to a sub-task of the epic for deprecations in 4.2, but this doesnt exist yet.
4.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.10
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.10 should be replaced with exceptions in 4.2. This includes all functions in lib/deprecatedlib.php that say since 3.10 (or earlier). If any functions from this file do not have this comment but also need to be finally deprecated in 4.2 - please list them in this issue description.
5.summary: Remove behat steps deprecated in 3.10
description: Go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.10 (or earlier). Please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed.
6.summary: Remove strings deprecated in 3.10
description: Remove strings from language files under the heading "Deprecated in Moodle 3.10" and the respective lines in deprecated.txt files See also
7.summary: Remove old classes renamed in 3.10
description: This issue is about to review all the /db/renamedclasses.php that were renamed "since" Moodle 3.10 or earlier and remove them completely from core, adding a note in the corresponding upgrade.txt files.
8.summary: Final deprecation of messaging functions
description: Identified more functions that were no longer required and were deprecated. This issue aims to do the final deprecation of these functios. To find them grep for this MDL.
9.summary: Final removal of methods deprecated in 69050
description: deprecated a few methods which should be removed in Moodle 4.2: filetypes_util::is_whitelisted() filetypes_util::get_not_whitelisted() mustache_helper_collection::strip_blacklisted_helpers()
10.summary: Final deprecation of phpunit/dbunit methods in advanced_testcase
description: Part of and , phpunit/dbunit was removed from core (because it was not available anymore). That implied removing some advanced_testcase methods using it and switching to our own phpunit_dataset class. The methods to be completely removed here are: - createXMLDataSet() - createCsvDataSet() - createArrayDataSet() - loadDataSet() and, also, the associated unit tests covering the current deprecation debugging. In lib/upgrade.txt you can find information about the deprecation replacements. At the end, there shouldnt be any occurrence of any of the above in core (or "DBUnit" / "dbunit" in general).
11.summary: Final deprecation of function: serialise_tool_proxy()
description: The function, `serialise_tool_proxy()`, should be removed in Moodle 4.2. It was deprecated in 3.10+master in . It is currently not used anywhere in the core Moodle project. It is currently located in `/mod/lti/locallib.php`. You can see the original deprecation message in `mod/lti/upgrade.txt`.
12.summary: Revert the changes for forcing the course overview block for the app in 4.0
description: Some changes were introduced in to always return the course overview block via Web Services for the mobile app. This was a temporary hack just to be removed in 4.1
13.summary: Final deprecation of legacy log store
description: -Step one of deprecation was done in Moodle 3.1.- Hasnt been done yet We now move to phase 2 : This issues is tricky, removing this store could have serious ramifications. Please discuss amongst HQ. Perhaps we should just leave this as it is so that we do not break old reports. Things that can be done: Remove the deprecation notice from the admin/index.php page (admin/renderer.php - legacy_log_store_error() can be removed.) The string legacylogstoreinuse should be deprecated / removed from lang/en/moodle.php
14.summary: Final deprecation of customfields select get_options_array() method
description: The get_options_array method of the select customfield type was deprecated in Finish the deprecation process here, and remove its implementation
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 4.2
description: In Moodle 4.2 we can remove functionality that was deprecated in 3.10 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Final deprecation of plagiarism functions
description: Do the final deprecation of: plagiarism_save_form_elements() plagiarism_get_form_elements_module() plagiarism_plugin::get_form_elements_module() plagiarism_plugin::save_form_elements() The first two files need to be moved into deprecatedlib.php and the body of the function removed. The second two methods just need to be removed. Code calling these functions should be removed from mod_assign, mod_forum, and mod_workshop. plagiarism_load_available_plugins method should be deprecated too.
2.summary: Replace XMPP library in Moodle to something supported and move from core to message/output/jabber
description: just had a chat with Nathan Fritz, I guess its self-explanatory: (15:52:32) Marina: Hello Nathan, my name is Marina Glancy and I work for Moodle HQ (15:53:24) Marina: We are preparing Moodle for PHP7 at the moment and found an issue in XMPP (15:53:32) Marina: for more details (15:53:39) Fritzy: okay... (15:54:00) Marina: do you maintain source code in svn only? no github? (15:54:09) Fritzy: I havent supported that library in a long time -- since before I was on github. (15:54:33) Fritzy: is the most recent (he was going to start maintaining it) (15:54:45) Marina: thats a shame, should we just patch it in our product then? (15:55:08) Fritzy: Yup. If your developers want to take it over, thatd be great too. (15:55:16) Fritzy: Feel free to publish it on Github. (15:55:28) Fritzy: I can give you an MIT version (15:55:32) Marina: last commit 5 years ago :( (15:55:46) Fritzy: Yup, pretty old. There are better maintained XMPP libraries for PHP (15:56:01) Fritzy: (15:56:35) Fritzy: (15:57:34) Fritzy: In any case, if you like I can make a fork in a more permissive license. But yeah, Id recomend moving to something more maintained
3.summary: Search: Remove support for add_documents function with 5 return values deprecated in Moodle 3.10
description: The change in means the add_documents function in search engine plugins is expected to return 6 values. There is backwards compatibility for 5 return values in two places (the index and index_context functions in search/classes/manager.php) which should be deleted in Moodle 4.2. Note: I have currently added this as a subtask of my main item, it should be moved to a sub-task of the epic for deprecations in 4.2, but this doesnt exist yet.
4.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.10
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.10 should be replaced with exceptions in 4.2. This includes all functions in lib/deprecatedlib.php that say since 3.10 (or earlier). If any functions from this file do not have this comment but also need to be finally deprecated in 4.2 - please list them in this issue description.
5.summary: Remove behat steps deprecated in 3.10
description: Go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.10 (or earlier). Please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed.
6.summary: Remove strings deprecated in 3.10
description: Remove strings from language files under the heading "Deprecated in Moodle 3.10" and the respective lines in deprecated.txt files See also
7.summary: Remove old classes renamed in 3.10
description: This issue is about to review all the /db/renamedclasses.php that were renamed "since" Moodle 3.10 or earlier and remove them completely from core, adding a note in the corresponding upgrade.txt files.
8.summary: Final deprecation of messaging functions
description: Identified more functions that were no longer required and were deprecated. This issue aims to do the final deprecation of these functios. To find them grep for this MDL.
9.summary: Final removal of methods deprecated in 69050
description: deprecated a few methods which should be removed in Moodle 4.2: filetypes_util::is_whitelisted() filetypes_util::get_not_whitelisted() mustache_helper_collection::strip_blacklisted_helpers()
10.summary: Final deprecation of phpunit/dbunit methods in advanced_testcase
description: Part of and , phpunit/dbunit was removed from core (because it was not available anymore). That implied removing some advanced_testcase methods using it and switching to our own phpunit_dataset class. The methods to be completely removed here are: - createXMLDataSet() - createCsvDataSet() - createArrayDataSet() - loadDataSet() and, also, the associated unit tests covering the current deprecation debugging. In lib/upgrade.txt you can find information about the deprecation replacements. At the end, there shouldnt be any occurrence of any of the above in core (or "DBUnit" / "dbunit" in general).
11.summary: Final deprecation of function: serialise_tool_proxy()
description: The function, `serialise_tool_proxy()`, should be removed in Moodle 4.2. It was deprecated in 3.10+master in . It is currently not used anywhere in the core Moodle project. It is currently located in `/mod/lti/locallib.php`. You can see the original deprecation message in `mod/lti/upgrade.txt`.
12.summary: Revert the changes for forcing the course overview block for the app in 4.0
description: Some changes were introduced in to always return the course overview block via Web Services for the mobile app. This was a temporary hack just to be removed in 4.1
13.summary: Final deprecation of legacy log store
description: -Step one of deprecation was done in Moodle 3.1.- Hasnt been done yet We now move to phase 2 : This issues is tricky, removing this store could have serious ramifications. Please discuss amongst HQ. Perhaps we should just leave this as it is so that we do not break old reports. Things that can be done: Remove the deprecation notice from the admin/index.php page (admin/renderer.php - legacy_log_store_error() can be removed.) The string legacylogstoreinuse should be deprecated / removed from lang/en/moodle.php
14.summary: Final deprecation of customfields select get_options_array() method
description: The get_options_array method of the select customfield type was deprecated in Finish the deprecation process here, and remove its implementation
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Convert existing log reading analysis to use the proposed system.
description: Assuming to system proposed in Logging_2| is implemented we will need to convert any places that read from the log table to use the new system.
| Unsolvable | 1.summary: Replace usages of the log table in admin/handlevirus.php
description: See usages|
2.summary: Replace usages of the log table in backup/util/helper/backup_cron_helper.class.php
description: See usages|
3.summary: Replace usages of the log table in backup/util/structure/backup_nested_element.class.php
description: See usages|
4.summary: Replace usages of the log table in blocks/recent_activity/block_recent_activity.php
description: See usages|
5.summary: Replace usages of the log table in course/lib.php
description: See usages|
6.summary: Replace usages of the log table in lib/cronlib.php
description: See usages|
7.summary: Replace usages of the log table in lib/datalib.php
description: See usages|
8.summary: Replace usages of the log table in lib/deprecatedlib.php
description: See usages|
9.summary: Replace usages of the log table in lib/statslib.php
description: See usages|
10.summary: Replace usages of the log table in lib/uploadlib.php
description: See usages|
11.summary: Replace usages of the log table in mod/book/lib.php
description: See usages|
12.summary: Replace usages of the log table in mod/folder/lib.php
description: See usages|
13.summary: Replace usages of the log table in mod/imscp/lib.php
description: See usages|
14.summary: Replace usages of the log table in mod/page/lib.php
description: See usages|
15.summary: Replace usages of the log table in mod/resource/lib.php
description: See usages|
16.summary: Replace usages of the log table in mod/url/lib.php
description: See usages|
17.summary: Replace usages of the log table in mod/workshop/allocation/scheduled/lib.php
description: See usages|
18.summary: Replace usages of the log table in report/log/graph.php
description: See usages|
19.summary: Replace usages of the log table in report/participation/index.php
description: See usages|
20.summary: Replace usages of the log table in report/outline/index.php
description: See usages|
21.summary: Check there are no existing reads from the log table in core
description: Grep the code yo!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Convert existing log reading analysis to use the proposed system.
description: Assuming to system proposed in Logging_2| is implemented we will need to convert any places that read from the log table to use the new system.
### Response:
1.summary: Replace usages of the log table in admin/handlevirus.php
description: See usages|
2.summary: Replace usages of the log table in backup/util/helper/backup_cron_helper.class.php
description: See usages|
3.summary: Replace usages of the log table in backup/util/structure/backup_nested_element.class.php
description: See usages|
4.summary: Replace usages of the log table in blocks/recent_activity/block_recent_activity.php
description: See usages|
5.summary: Replace usages of the log table in course/lib.php
description: See usages|
6.summary: Replace usages of the log table in lib/cronlib.php
description: See usages|
7.summary: Replace usages of the log table in lib/datalib.php
description: See usages|
8.summary: Replace usages of the log table in lib/deprecatedlib.php
description: See usages|
9.summary: Replace usages of the log table in lib/statslib.php
description: See usages|
10.summary: Replace usages of the log table in lib/uploadlib.php
description: See usages|
11.summary: Replace usages of the log table in mod/book/lib.php
description: See usages|
12.summary: Replace usages of the log table in mod/folder/lib.php
description: See usages|
13.summary: Replace usages of the log table in mod/imscp/lib.php
description: See usages|
14.summary: Replace usages of the log table in mod/page/lib.php
description: See usages|
15.summary: Replace usages of the log table in mod/resource/lib.php
description: See usages|
16.summary: Replace usages of the log table in mod/url/lib.php
description: See usages|
17.summary: Replace usages of the log table in mod/workshop/allocation/scheduled/lib.php
description: See usages|
18.summary: Replace usages of the log table in report/log/graph.php
description: See usages|
19.summary: Replace usages of the log table in report/participation/index.php
description: See usages|
20.summary: Replace usages of the log table in report/outline/index.php
description: See usages|
21.summary: Check there are no existing reads from the log table in core
description: Grep the code yo!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Downloads site migration and upgrade
description: downloads.moodle.org is out of the K8s infrastructure and uses Moodle 3.5 version. Initial review|
| Unsolvable | 1.summary: Moodle 4.1 branches for download.moodle.org
description: Create the Moodle 4.1 branches for download.moodle.org in the repository sites (
2.summary: Download Server migration: plan migration dates and plan communication
description: We discussed that the date could be either week commencing 3rd April or 24th April - to be discussed and confirmed with ICT and Victor. Use this ticket to confirm time and plan where/ when we will communication to users about it. How many weeks before and where do we tell people?
3.summary: Migration day
description: Our preparations for the migration are almost complete, and we have discussed conducting it after the minors are released on June 12th. However, we still need to coordinate with the relevant teams, including Communities (vmdef), Integration (stronk7), and ICT (eduardcercos), to determine a specific date and outline the tasks that need to be completed on that day.
4.summary: Modify cron on packaging.moodle.org
description: Modify cron on packaging.moodle.org
5.summary: Sync packages data
description: Moodle packages will continue being hosted on the Hetzner server, and the metadata (size, names, download URL) of those packages needs to be available on the download.moodle.org site. Additional effort is needed to document this process.
6.summary: "Updates API" migration
description: The Updates API is the interface that enables developers and Moodle LMS instances to access the available updates of the core or a particular plugin. . Repository: serverscripts| . Endpoints: updates.php: given a Moodle branch and version, and optionally a list of third-party plugins, returns the available updates for them. pluginfo.php: to get information about a specific plugin. pluglist.php: provides the list of all available plugins in the Plugins directory There are two additional scripts to generate the information the API requires: calculate_pluginsinfo.php: fetches the plugins information from the plugins directory (moodle.org server) and generates a json file with it. calculate_releasesinfo.php: generates a json file with the Moodle releases packages data. It is invoked on moodle-package-extract-and-postprocess. The endpoint queries are recorded in files (a file per day/month/year) in the data/logs folder. There are two scripts to process these logs (via cron), storing the statistics in the data/stats folder: make_daily_stats.php: generates the stats for a single day. make_monthly_stats.php: generates the stats for a single month. . Path /var/www/vhosts/download.moodle.org/html-extra/api . Folder structure: one folder for each API version; the last Moodle versions use 1.3 _current_: link referencing the folder of the API version in use _data_: folder with files required and generated by the API: _logs_: files where queries to the endpoints are recorded _stats_: files with the generated statistics by year, month and day plugins.json: plugins info file generated by calculate_pluginsinfo.php releases.json: releases info file, generated by calculate_releasesinfo.php . cron entries Linux jobs to keep the API code and the stats updated : code:bash Puppet Name: downloadmoodleorg auto-deploy updates-api 6 /var/www/vhosts/download.moodle.org/bin/moodle-autodeploy-updates_api > /dev/null 2>&1 Puppet Name: downloadmoodleorg update plugins info /15 /var/www/vhosts/download.moodle.org/bin/moodle-updatepluginsinfo > /dev/null 2>&1 Puppet Name: downloadmoodleorg calculate daily stats 20 5 /var/www/vhosts/download.moodle.org/bin/moodle-updatedailystats > /dev/null 2>&1 Puppet Name: downloadmoodleorg calculate monthly stats 30 5 1 /var/www/vhosts/download.moodle.org/bin/moodle-updatemonthlystats > /dev/null 2>&1 code After migrating to the new server, the Updates API endpoints and additional scripts MUST work.
7.summary: Release and language packages downloads
description: . Release packages Packaging Moodle releases involves the process of creating a distribution-ready package. The packages are compressed and distributed in a platform-specific format (Windows/macOS) or portable across different platforms (tgz/zip format). The server where packaging happens is business.srv.in.moodle.com (Hetzner). A set of scripts, invoked by cron, monitors the moodle.git repository for changes, and when there are new commits, they trigger the packaging process. The packages are available for download via a Moodle instance, which is currently running version 3.5, as due to server limitations, it has not been possible to upgrade. The local_downloadmoodleorg| plugin gets the information about the available packages by inspecting the local files and displays them on multiple pages: These URLs are redirected to the allreleases.php| script. . Language packages Also, language packages can be downloaded in the URL x.y the Moodle version. This page shows all the available language packs available for the specific version. Language packs are created in the lang site and sent to the current download server. Requests to this URL are redirected to the langpack.php| script. All packages available for download on the current server MUST be downloadable from the new server.
8.summary: Customise the new theme for Downloads
description: Update Staging to Boost theme, apply the custom theme to the Downloads staging site and compare with the current theme for any amendments needed. Implement any required changes onto Staging.
9.summary: Review/discover other services for Downloads site
description: Identify whether other services or assets need migrating to the new Download server.
10.summary: Implement final local_downloadmoodleorg changes
description: During the code review, it was decided to add capabilities and integrity checks to the web service for managing package information files.
11.summary: packaging.moodle.org Apache web server configuration
description: Mainly handling redirections as a file server.
12.summary: Keep packaging.moodle.org serverscripts updated
description: The term "serverscripts" refers to a collection of scripts that are used for creating and managing packages after each Moodle roll or release. These scripts may include some that are not directly related to the packages, and they may be located on either the download.moodle.org server or the packaging.moodle.org server. It is important to ensure that these scripts are located in the appropriate place and that changes are automatically deployed on a regular basis.
13.summary: Moodle 4.2 branches for download.moodle.org
description: After the release of the new version, site branches must also be updated to include the new version.
14.summary: Create the docker images in the community-docker repository
description: Create the Docker images for the staging and production sites. ICT controls base images; the images within this repository are sites/services managed by the community team. Add IP filter in nginx configuration to only allow packaging.moodle.org send the packages.json file.
15.summary: Create Kubernetes configuration files in community-kube repository
description: The "community-kube" repository is a place where the configuration files for the Kubernetes infrastructure of each site are stored. New configurations will be created for the staging and production sites. The created configurations specify the settings and parameters needed to run Kubernetes on these sites.
16.summary: Prepare serverscripts repository
description: The serverscripts repository has a branch called download_migration| that contains scripts divided into two folders - one for running on packaging.moodle.org and the other for running on download.moodle.org. This branch needs to be updated with the latest changes from the master branch.
17.summary: Clone serverscripts repository on download.moodle.org
description: Clone serverscripts repository on download.moodle.org
18.summary: Setup cron on download.moodle.org
description: Set up cron on download.moodle.org based on existing downloadmoodleorg and root crontabs.
19.summary: Upgrade and setup Moodle instance
description: Upgrade and setup Moodle instance
20.summary: Web service user in download.moodle.org
description: Create WS user in download.moodle.org and set token as an environment variable in packaging.moodle.org
21.summary: Configuration files: cfg.php and api/configure.php
description: Configuration files: cfg.php, api/configure.php and package.json.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Downloads site migration and upgrade
description: downloads.moodle.org is out of the K8s infrastructure and uses Moodle 3.5 version. Initial review|
### Response:
1.summary: Moodle 4.1 branches for download.moodle.org
description: Create the Moodle 4.1 branches for download.moodle.org in the repository sites (
2.summary: Download Server migration: plan migration dates and plan communication
description: We discussed that the date could be either week commencing 3rd April or 24th April - to be discussed and confirmed with ICT and Victor. Use this ticket to confirm time and plan where/ when we will communication to users about it. How many weeks before and where do we tell people?
3.summary: Migration day
description: Our preparations for the migration are almost complete, and we have discussed conducting it after the minors are released on June 12th. However, we still need to coordinate with the relevant teams, including Communities (vmdef), Integration (stronk7), and ICT (eduardcercos), to determine a specific date and outline the tasks that need to be completed on that day.
4.summary: Modify cron on packaging.moodle.org
description: Modify cron on packaging.moodle.org
5.summary: Sync packages data
description: Moodle packages will continue being hosted on the Hetzner server, and the metadata (size, names, download URL) of those packages needs to be available on the download.moodle.org site. Additional effort is needed to document this process.
6.summary: "Updates API" migration
description: The Updates API is the interface that enables developers and Moodle LMS instances to access the available updates of the core or a particular plugin. . Repository: serverscripts| . Endpoints: updates.php: given a Moodle branch and version, and optionally a list of third-party plugins, returns the available updates for them. pluginfo.php: to get information about a specific plugin. pluglist.php: provides the list of all available plugins in the Plugins directory There are two additional scripts to generate the information the API requires: calculate_pluginsinfo.php: fetches the plugins information from the plugins directory (moodle.org server) and generates a json file with it. calculate_releasesinfo.php: generates a json file with the Moodle releases packages data. It is invoked on moodle-package-extract-and-postprocess. The endpoint queries are recorded in files (a file per day/month/year) in the data/logs folder. There are two scripts to process these logs (via cron), storing the statistics in the data/stats folder: make_daily_stats.php: generates the stats for a single day. make_monthly_stats.php: generates the stats for a single month. . Path /var/www/vhosts/download.moodle.org/html-extra/api . Folder structure: one folder for each API version; the last Moodle versions use 1.3 _current_: link referencing the folder of the API version in use _data_: folder with files required and generated by the API: _logs_: files where queries to the endpoints are recorded _stats_: files with the generated statistics by year, month and day plugins.json: plugins info file generated by calculate_pluginsinfo.php releases.json: releases info file, generated by calculate_releasesinfo.php . cron entries Linux jobs to keep the API code and the stats updated : code:bash Puppet Name: downloadmoodleorg auto-deploy updates-api 6 /var/www/vhosts/download.moodle.org/bin/moodle-autodeploy-updates_api > /dev/null 2>&1 Puppet Name: downloadmoodleorg update plugins info /15 /var/www/vhosts/download.moodle.org/bin/moodle-updatepluginsinfo > /dev/null 2>&1 Puppet Name: downloadmoodleorg calculate daily stats 20 5 /var/www/vhosts/download.moodle.org/bin/moodle-updatedailystats > /dev/null 2>&1 Puppet Name: downloadmoodleorg calculate monthly stats 30 5 1 /var/www/vhosts/download.moodle.org/bin/moodle-updatemonthlystats > /dev/null 2>&1 code After migrating to the new server, the Updates API endpoints and additional scripts MUST work.
7.summary: Release and language packages downloads
description: . Release packages Packaging Moodle releases involves the process of creating a distribution-ready package. The packages are compressed and distributed in a platform-specific format (Windows/macOS) or portable across different platforms (tgz/zip format). The server where packaging happens is business.srv.in.moodle.com (Hetzner). A set of scripts, invoked by cron, monitors the moodle.git repository for changes, and when there are new commits, they trigger the packaging process. The packages are available for download via a Moodle instance, which is currently running version 3.5, as due to server limitations, it has not been possible to upgrade. The local_downloadmoodleorg| plugin gets the information about the available packages by inspecting the local files and displays them on multiple pages: These URLs are redirected to the allreleases.php| script. . Language packages Also, language packages can be downloaded in the URL x.y the Moodle version. This page shows all the available language packs available for the specific version. Language packs are created in the lang site and sent to the current download server. Requests to this URL are redirected to the langpack.php| script. All packages available for download on the current server MUST be downloadable from the new server.
8.summary: Customise the new theme for Downloads
description: Update Staging to Boost theme, apply the custom theme to the Downloads staging site and compare with the current theme for any amendments needed. Implement any required changes onto Staging.
9.summary: Review/discover other services for Downloads site
description: Identify whether other services or assets need migrating to the new Download server.
10.summary: Implement final local_downloadmoodleorg changes
description: During the code review, it was decided to add capabilities and integrity checks to the web service for managing package information files.
11.summary: packaging.moodle.org Apache web server configuration
description: Mainly handling redirections as a file server.
12.summary: Keep packaging.moodle.org serverscripts updated
description: The term "serverscripts" refers to a collection of scripts that are used for creating and managing packages after each Moodle roll or release. These scripts may include some that are not directly related to the packages, and they may be located on either the download.moodle.org server or the packaging.moodle.org server. It is important to ensure that these scripts are located in the appropriate place and that changes are automatically deployed on a regular basis.
13.summary: Moodle 4.2 branches for download.moodle.org
description: After the release of the new version, site branches must also be updated to include the new version.
14.summary: Create the docker images in the community-docker repository
description: Create the Docker images for the staging and production sites. ICT controls base images; the images within this repository are sites/services managed by the community team. Add IP filter in nginx configuration to only allow packaging.moodle.org send the packages.json file.
15.summary: Create Kubernetes configuration files in community-kube repository
description: The "community-kube" repository is a place where the configuration files for the Kubernetes infrastructure of each site are stored. New configurations will be created for the staging and production sites. The created configurations specify the settings and parameters needed to run Kubernetes on these sites.
16.summary: Prepare serverscripts repository
description: The serverscripts repository has a branch called download_migration| that contains scripts divided into two folders - one for running on packaging.moodle.org and the other for running on download.moodle.org. This branch needs to be updated with the latest changes from the master branch.
17.summary: Clone serverscripts repository on download.moodle.org
description: Clone serverscripts repository on download.moodle.org
18.summary: Setup cron on download.moodle.org
description: Set up cron on download.moodle.org based on existing downloadmoodleorg and root crontabs.
19.summary: Upgrade and setup Moodle instance
description: Upgrade and setup Moodle instance
20.summary: Web service user in download.moodle.org
description: Create WS user in download.moodle.org and set token as an environment variable in packaging.moodle.org
21.summary: Configuration files: cfg.php and api/configure.php
description: Configuration files: cfg.php, api/configure.php and package.json.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Prepare Moodle for PHP 7.1
description: And again, more deprecations in the PHP language that moodle has to work with. PHP 7.1 is expected in December 2016, we should aim to make Moodle 3.2 compatible with it.
| Unsolvable | 1.summary: Add environment check for versions where PHP 7.1 is NOT supported
description: Add env check to 3.0 and 3.1 similar to the one added to previous versions for php7 see
2.summary: enrollib has sloppy casting from array to string that doesnt work in php 7.1
description: Test the LTI provider - fix bugs (Sorry I lost the file with errors that I saw).
3.summary: Group mform elements call non-static function statically and fail in php 7.1
description: Fatal error. $this used in static context.
4.summary: Review mcrypt functions in Moodle
description: PHP 7.1 is depreciating Mcrypt, and it will be completely removed in 7.1+1 (moved to PECL actually). An initial grep showed that it only seems to be used in various 3rd party libraries that are used by Moodle, and I would note that on our production site we dont have it installed, and havent received any complaints. That being said, this should still probably be looked over in more detail.
5.summary: PHP 7.1: "Illegal string offset text" when running unittests on questions formats
description: Not sure yet what/where is the cause, see full results in the file attached to Typical backtrace (other question formats are also affected): code 28) qformat_examview_test::test_import_fill_in_the_blank Illegal string offset text /home/moodle/moodles/m/moodle/question/format.php:676 /home/moodle/moodles/m/moodle/question/format/examview/format.php:251 /home/moodle/moodles/m/moodle/question/format/examview/format.php:208 /home/moodle/moodles/m/moodle/question/format/examview/format.php:177 /home/moodle/moodles/m/moodle/question/format/examview/tests/examviewformat_test.php:186 /home/moodle/moodles/m/moodle/lib/phpunit/classes/advanced_testcase.php:80 code
6.summary: PHP7.1 incorrect number of arguments can no longer be suppressed with @
description: we have failures on PHP 7.1 similar to this (see full unittest results on issue ): code 8) core_moodlelib_testcase::test_clean_param_array Error: Too few arguments to function clean_param_array(), 1 passed in /home/moodle/moodles/m/moodle/lib/tests/moodlelib_test.php on line 428 and at least 2 expected /home/moodle/moodles/m/moodle/lib/moodlelib.php:752 /home/moodle/moodles/m/moodle/lib/tests/moodlelib_test.php:428 /home/moodle/moodles/m/moodle/lib/phpunit/classes/advanced_testcase.php:80 To re-run: vendor/bin/phpunit core_moodlelib_testcase lib/tests/moodlelib_test.php code
7.summary: Move the radius authentication plugin to contrib
description: Radius is now using the mcrypt php functions which are deprecated as of php 7.1 (see here| for details). The suggestion has been that we move this authentication plugin and the supporting libraries into contrib. Libraries to be moved as well (double check they are not used elsewhere): lib/pear/Auth lib/pear/Crypt
8.summary: Add debugging message when MoodleQuickForm::createElement is called statically
description: In we have removed static calls to non-static function MoodleQuickForm::createElement in core form elements for php7.1 compatibility. However if developers still continue doing it in their plugins they will not give any warning unless they test their plugins on php 7.1 . We need to add a debugging message in Moodle so they fix the plugins and make them compatible with 7.1 Similar debugging message was added under to prevent plugin developers from calling constructors by class names and only use __construct()
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Prepare Moodle for PHP 7.1
description: And again, more deprecations in the PHP language that moodle has to work with. PHP 7.1 is expected in December 2016, we should aim to make Moodle 3.2 compatible with it.
### Response:
1.summary: Add environment check for versions where PHP 7.1 is NOT supported
description: Add env check to 3.0 and 3.1 similar to the one added to previous versions for php7 see
2.summary: enrollib has sloppy casting from array to string that doesnt work in php 7.1
description: Test the LTI provider - fix bugs (Sorry I lost the file with errors that I saw).
3.summary: Group mform elements call non-static function statically and fail in php 7.1
description: Fatal error. $this used in static context.
4.summary: Review mcrypt functions in Moodle
description: PHP 7.1 is depreciating Mcrypt, and it will be completely removed in 7.1+1 (moved to PECL actually). An initial grep showed that it only seems to be used in various 3rd party libraries that are used by Moodle, and I would note that on our production site we dont have it installed, and havent received any complaints. That being said, this should still probably be looked over in more detail.
5.summary: PHP 7.1: "Illegal string offset text" when running unittests on questions formats
description: Not sure yet what/where is the cause, see full results in the file attached to Typical backtrace (other question formats are also affected): code 28) qformat_examview_test::test_import_fill_in_the_blank Illegal string offset text /home/moodle/moodles/m/moodle/question/format.php:676 /home/moodle/moodles/m/moodle/question/format/examview/format.php:251 /home/moodle/moodles/m/moodle/question/format/examview/format.php:208 /home/moodle/moodles/m/moodle/question/format/examview/format.php:177 /home/moodle/moodles/m/moodle/question/format/examview/tests/examviewformat_test.php:186 /home/moodle/moodles/m/moodle/lib/phpunit/classes/advanced_testcase.php:80 code
6.summary: PHP7.1 incorrect number of arguments can no longer be suppressed with @
description: we have failures on PHP 7.1 similar to this (see full unittest results on issue ): code 8) core_moodlelib_testcase::test_clean_param_array Error: Too few arguments to function clean_param_array(), 1 passed in /home/moodle/moodles/m/moodle/lib/tests/moodlelib_test.php on line 428 and at least 2 expected /home/moodle/moodles/m/moodle/lib/moodlelib.php:752 /home/moodle/moodles/m/moodle/lib/tests/moodlelib_test.php:428 /home/moodle/moodles/m/moodle/lib/phpunit/classes/advanced_testcase.php:80 To re-run: vendor/bin/phpunit core_moodlelib_testcase lib/tests/moodlelib_test.php code
7.summary: Move the radius authentication plugin to contrib
description: Radius is now using the mcrypt php functions which are deprecated as of php 7.1 (see here| for details). The suggestion has been that we move this authentication plugin and the supporting libraries into contrib. Libraries to be moved as well (double check they are not used elsewhere): lib/pear/Auth lib/pear/Crypt
8.summary: Add debugging message when MoodleQuickForm::createElement is called statically
description: In we have removed static calls to non-static function MoodleQuickForm::createElement in core form elements for php7.1 compatibility. However if developers still continue doing it in their plugins they will not give any warning unless they test their plugins on php 7.1 . We need to add a debugging message in Moodle so they fix the plugins and make them compatible with 7.1 Similar debugging message was added under to prevent plugin developers from calling constructors by class names and only use __construct()
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Plugins
summary: Improvements to the export features
description: The export features of Scheduler have not really been reviewed since the 1.9 version, and the code is in need od refactoring/rewriting. Im collecting here all the current issues and feature requests relating to exports.
| Unsolvable | 1.summary: Add "export/print sign-up list" feature
description: It would be nice to have a feature for each scheduler instance where you could export a list of students who have signed up for that particular scheduler. Theres a need at my school to have a print-out of people whove signed up for a scheduler so that role can be taken during the scheduled meeting. I think an ideal solution would have a button at the bottom of each scheduler, under all of the sign-up slots, that says "Export Sign-up Sheet." Using this button would download a .csv or .xls file that includes each students name, email, time slot theyve signed up for, moodle course, and scheduler name. Other info could be added as well since its easy to delete that extraneous info from a spreadsheet. A less ideal solution would just have a printable output screen of all of the above information with no "download as" feature. While not editable, it would still be a huge improvement.
2.summary: Add additional export fields to scheduler
description: It would be very nice to have users username and email addresses added as additional fields which are exported from the scheduler. Currently, only the users First and Lastname are exported, which are not unique user identifiers.
3.summary: Additional items to include when exporting
description: When exporting data from a scheduler, the output is rather basic. It currently only includes: Date Start Time End time Slot Type Teacher (or whatever your attender role is named) Attendee Some information that would be very helpful to add is: Attendee email address Meeting location Grade (if enabled) Comments and notes left for each slot/student Some improvements to the existing exports are: Split up names into separate firstname and lastname columns (so that they are sortable) for both attenders and attendees. Currently, the first/lastname are included in a single cell making it difficult to sort. If more than one student can sign up for a slot, create a new ROW for each student (which would hold notes for the individuals) that belongs to that slot. Currently, if there is more than one student in a single slot, it will add all of them to a single cell. Thats about all Ive thought of for now... the important thing is adding the email addresses, meeting locations, and comments/notes.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Plugins
summary: Improvements to the export features
description: The export features of Scheduler have not really been reviewed since the 1.9 version, and the code is in need od refactoring/rewriting. Im collecting here all the current issues and feature requests relating to exports.
### Response:
1.summary: Add "export/print sign-up list" feature
description: It would be nice to have a feature for each scheduler instance where you could export a list of students who have signed up for that particular scheduler. Theres a need at my school to have a print-out of people whove signed up for a scheduler so that role can be taken during the scheduled meeting. I think an ideal solution would have a button at the bottom of each scheduler, under all of the sign-up slots, that says "Export Sign-up Sheet." Using this button would download a .csv or .xls file that includes each students name, email, time slot theyve signed up for, moodle course, and scheduler name. Other info could be added as well since its easy to delete that extraneous info from a spreadsheet. A less ideal solution would just have a printable output screen of all of the above information with no "download as" feature. While not editable, it would still be a huge improvement.
2.summary: Add additional export fields to scheduler
description: It would be very nice to have users username and email addresses added as additional fields which are exported from the scheduler. Currently, only the users First and Lastname are exported, which are not unique user identifiers.
3.summary: Additional items to include when exporting
description: When exporting data from a scheduler, the output is rather basic. It currently only includes: Date Start Time End time Slot Type Teacher (or whatever your attender role is named) Attendee Some information that would be very helpful to add is: Attendee email address Meeting location Grade (if enabled) Comments and notes left for each slot/student Some improvements to the existing exports are: Split up names into separate firstname and lastname columns (so that they are sortable) for both attenders and attendees. Currently, the first/lastname are included in a single cell making it difficult to sort. If more than one student can sign up for a slot, create a new ROW for each student (which would hold notes for the individuals) that belongs to that slot. Currently, if there is more than one student in a single slot, it will add all of them to a single cell. Thats about all Ive thought of for now... the important thing is adding the email addresses, meeting locations, and comments/notes.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Improve the course UI
description: The Course UI is build on the core course renderers and the course format renderers. Over time UI has degraded because of theme and navigation changes. The course editing looks particularly bad on mobile devices. To improve the Course UI these steps could be taken: Back to the drawing board: Look at the course UX and flow Course navigation can be complex and users can easily loose the course context. Alberto has designed some improved navigation for courses and it would help to look at the work done again. Unify the Course renderer and course format renderer Moodle supports custom course formats, but course formats do not have enough control over rendering the activity instances. If the methods in the core course renderer that control sections and activies are moved the the course format base renderer custom course formats would have far more control. Use moustache templates for course format HTML Current course formats and the core course renderer use the html_writer class for most of the HTML used in course pages. Transferring these to moustache templates and updating the HTML for Bootstrap 4 would make it look more consistent and would make maintenance easier. With new templates in place we can reduce the amount of css needed to render the course page. Improve mobile design With new HTML in place we can work on improving the mobile design of the course pages Replace legacy JavaScript Moodle courses use legacy YUI code for things like completion tracking and moving around activities and sections. This JavaScript can be updated to use modern AMD JavaScript and for the moving of activities the new AMD Drag & Drop library created by marina can be used. Consider course formats on the Plugins DB Consider the effects of upgrading the Course renderers on the custom course formats existing on the plugins DB. Justification Educators have to be able to add activities with ease and there should be no confusion on managing and positioning activities in a course. Plugin / theme developers should be able to use simple templates to create a customized learning experience. We have to maintain our user interface and make sure they are clean and consistent. The course page look has degraded over time. Stakeholders This will make the UI less cluttered for course managers / teachers, especially in editing mode. The course page and course page navigation could be improved for end users. Highlighted sections don t look right. The alignment of page elements is off. Labels with images and videos don t look great. Any theme designer could use the new renderers to provide a custom course experience with less trouble. This will be valuable to the Moodle partners. Plugin developers could create a new course format with little effort.
| Unsolvable | 1.summary: Work on converting the course format renderer to templates
description: Currently Moodles course formats are run heavily though the renderer in course/format This can be better handled as it primarily echos out html_writer items, we can add new functions to better build our renderable objects and parse them with templates. Doing this would have at least a couple of big benefits: Help ease developers pains in tracing diverging code paths Allow course format creators and themes customise the look and feel of a course format without creating a new course format for the same functionality but different styles
2.summary: Rewrite course renderers to use templates
description: Current course renderers use the html_writer class to render course elements like: Course sections Activities Courses shown on the front-page These need to be changed to use moustache templates so the course UI can be improved
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Improve the course UI
description: The Course UI is build on the core course renderers and the course format renderers. Over time UI has degraded because of theme and navigation changes. The course editing looks particularly bad on mobile devices. To improve the Course UI these steps could be taken: Back to the drawing board: Look at the course UX and flow Course navigation can be complex and users can easily loose the course context. Alberto has designed some improved navigation for courses and it would help to look at the work done again. Unify the Course renderer and course format renderer Moodle supports custom course formats, but course formats do not have enough control over rendering the activity instances. If the methods in the core course renderer that control sections and activies are moved the the course format base renderer custom course formats would have far more control. Use moustache templates for course format HTML Current course formats and the core course renderer use the html_writer class for most of the HTML used in course pages. Transferring these to moustache templates and updating the HTML for Bootstrap 4 would make it look more consistent and would make maintenance easier. With new templates in place we can reduce the amount of css needed to render the course page. Improve mobile design With new HTML in place we can work on improving the mobile design of the course pages Replace legacy JavaScript Moodle courses use legacy YUI code for things like completion tracking and moving around activities and sections. This JavaScript can be updated to use modern AMD JavaScript and for the moving of activities the new AMD Drag & Drop library created by marina can be used. Consider course formats on the Plugins DB Consider the effects of upgrading the Course renderers on the custom course formats existing on the plugins DB. Justification Educators have to be able to add activities with ease and there should be no confusion on managing and positioning activities in a course. Plugin / theme developers should be able to use simple templates to create a customized learning experience. We have to maintain our user interface and make sure they are clean and consistent. The course page look has degraded over time. Stakeholders This will make the UI less cluttered for course managers / teachers, especially in editing mode. The course page and course page navigation could be improved for end users. Highlighted sections don t look right. The alignment of page elements is off. Labels with images and videos don t look great. Any theme designer could use the new renderers to provide a custom course experience with less trouble. This will be valuable to the Moodle partners. Plugin developers could create a new course format with little effort.
### Response:
1.summary: Work on converting the course format renderer to templates
description: Currently Moodles course formats are run heavily though the renderer in course/format This can be better handled as it primarily echos out html_writer items, we can add new functions to better build our renderable objects and parse them with templates. Doing this would have at least a couple of big benefits: Help ease developers pains in tracing diverging code paths Allow course format creators and themes customise the look and feel of a course format without creating a new course format for the same functionality but different styles
2.summary: Rewrite course renderers to use templates
description: Current course renderers use the html_writer class to render course elements like: Course sections Activities Courses shown on the front-page These need to be changed to use moustache templates so the course UI can be improved
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Prepare mod_feedback to be enabled by default
description: Mod feedback is installed, but not enabled by default. Martin requested it be enabled by default starting from 3.0. Same applies to block_feedback After some discussion, it was decided that it was not safe enough to do so this stage so this has been decoded to move this to 3.1 and make it an Epic to add all the associated issues. So proceeding. At very least: - First step should include to review all the unresolved component issues| tracking important ones under the Epic umbrella. - Then add tasks about to add both QA and unit/acceptance tests. - Then UX review. QA TESTS REQUIRED: 1. Basic feedback functionality - adding questions, answering, viewing analysis, basically covered by + add that label must contain embedded files 2. Anonymous feedbacks: create anonym feedback, answer as students, view as teacher (created to cover with behat) 3. Mapping feedbacks to courses (wow, hidden functionality): see for related bug 4. Feedback with dependencies 5. Export/import 6. Saving as template, using from template
| Unsolvable | 1.summary: Is it possible to export the data collected in Feedback to a .csv file?
description: Is it possible to export the data collected in Feedback to a .csv file?
2.summary: Allow non-alpha characters in the label in feedback
description: In mod/feedback/item/feedback_item_form_class.php, there is one line of code: code 62 $mform->setType(label, PARAM_ALPHANUM); code I think it should be PARAM_TEXT since PARAM_ALPHANUM will filter out all non-alpha chars, such as Chinese and Japanese. PS. Since label is very important to be a reference and is shown everywhere, why not set is as required field? There is always empty "()" shown before question name when the label is not set. I think it is ugly. Reproduction steps: Create a feedback activity Edit questions Add one question of any type Fill the form and ensure input " " into label Submit the form Edit the question and the label is empty
3.summary: Excel export from Feedback should name file the same as the activity
description: At the moment the export from Feedback names the Excel export Feedback.xls. If you have a few to do, this is inconvenient as this file has to be renamed every time. It would be much nicer if the file was named similarly to the feedback activity plus the timestamp (or something similar)
4.summary: Unable to select multiple values in drop-down menu while mapping site-wide feedback to courses
description: After creating a feedback activity on the site front page and attempting to map the feedback to courses, if the search result returns more than one course in the drop-down menu you are unable to select multiple courses - despite the tool-tip to the right indicating you should be able to. Have noted that a possible cause is that the results drop down field seems to have been declared in the HTML as select instead of select multiple. Have been able to reproduce this in 2.4, 2.5, and 2.7 (assuming this is likely also present in 2.6). Steps to reproduce: Create a feedback activity on the site front page Inside the activity, click on the Map feedback to courses button In the course search field, enter a term that will return at least 2 results from your available courses Take note of the help tip to the right of Map Feedback to courses button that states Multiple courses may be selected by holding down the Apple or Ctrl key whilst clicking on the course names Attempt to select multiple courses from the search results drop-down menu
5.summary: Feedback: Maximum characters accepted is 5 by default
description: On the feedback activity the Maximum characters accepted is 5 by default, which will be much too small for the majority of fields. There isnt a way to change this to a higher value in the Moodle Site Admin interface. Ideally this should be set to 255 characters and be able to be overridden in the Moodle Site Admin settings for the Feedback activity.
6.summary: Feedback: do not allow empty pages to be shown
description: We assume that we have an activity like this: !1.png|thumbnail! We could create a new setting in module settings (disableemptypages) so that if it was active , pages with no visible questions wouldnt be shown. What do you think?
7.summary: Behat tests for all feedback question types
description: add behat tests for all feedback question types
8.summary: Allow auth users on frontpage to view and complete feedback by default
description: I found an inconsistency in default privileges - guests are allowed to view feedbacks but authenticated users not.
9.summary: Remove file mod/feedback/complete_guest.php as it 95 repeats complete.php
description: Files complete_guest.php and complete.php are almost identical. All difference in logic can be done using if (isloggedin() && !isguestuser()) blocks Removing duplicating code will make it much easier to maintain feedback module
10.summary: Behat tests for feedback templates
description: Add behat tests for feedback templates
11.summary: Feedback responses page clean up and behat tests
description: Feedback responses page clean up and behat tests
12.summary: Convert feedback to use moodleform
description: This is a major overhaul of the feedback module Moodleforms are used for completion, editing, previewing (print.php), viewing templates and viewing individual responses Lots of feedback code is refactored and is easier to follow now Resolves - when a page contains only unavailable items it is skipped The UI is also much better now
13.summary: Enable mod_feedback and block_feedback by default
description: Enable mod_feedback and block_feedback by default
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Prepare mod_feedback to be enabled by default
description: Mod feedback is installed, but not enabled by default. Martin requested it be enabled by default starting from 3.0. Same applies to block_feedback After some discussion, it was decided that it was not safe enough to do so this stage so this has been decoded to move this to 3.1 and make it an Epic to add all the associated issues. So proceeding. At very least: - First step should include to review all the unresolved component issues| tracking important ones under the Epic umbrella. - Then add tasks about to add both QA and unit/acceptance tests. - Then UX review. QA TESTS REQUIRED: 1. Basic feedback functionality - adding questions, answering, viewing analysis, basically covered by + add that label must contain embedded files 2. Anonymous feedbacks: create anonym feedback, answer as students, view as teacher (created to cover with behat) 3. Mapping feedbacks to courses (wow, hidden functionality): see for related bug 4. Feedback with dependencies 5. Export/import 6. Saving as template, using from template
### Response:
1.summary: Is it possible to export the data collected in Feedback to a .csv file?
description: Is it possible to export the data collected in Feedback to a .csv file?
2.summary: Allow non-alpha characters in the label in feedback
description: In mod/feedback/item/feedback_item_form_class.php, there is one line of code: code 62 $mform->setType(label, PARAM_ALPHANUM); code I think it should be PARAM_TEXT since PARAM_ALPHANUM will filter out all non-alpha chars, such as Chinese and Japanese. PS. Since label is very important to be a reference and is shown everywhere, why not set is as required field? There is always empty "()" shown before question name when the label is not set. I think it is ugly. Reproduction steps: Create a feedback activity Edit questions Add one question of any type Fill the form and ensure input " " into label Submit the form Edit the question and the label is empty
3.summary: Excel export from Feedback should name file the same as the activity
description: At the moment the export from Feedback names the Excel export Feedback.xls. If you have a few to do, this is inconvenient as this file has to be renamed every time. It would be much nicer if the file was named similarly to the feedback activity plus the timestamp (or something similar)
4.summary: Unable to select multiple values in drop-down menu while mapping site-wide feedback to courses
description: After creating a feedback activity on the site front page and attempting to map the feedback to courses, if the search result returns more than one course in the drop-down menu you are unable to select multiple courses - despite the tool-tip to the right indicating you should be able to. Have noted that a possible cause is that the results drop down field seems to have been declared in the HTML as select instead of select multiple. Have been able to reproduce this in 2.4, 2.5, and 2.7 (assuming this is likely also present in 2.6). Steps to reproduce: Create a feedback activity on the site front page Inside the activity, click on the Map feedback to courses button In the course search field, enter a term that will return at least 2 results from your available courses Take note of the help tip to the right of Map Feedback to courses button that states Multiple courses may be selected by holding down the Apple or Ctrl key whilst clicking on the course names Attempt to select multiple courses from the search results drop-down menu
5.summary: Feedback: Maximum characters accepted is 5 by default
description: On the feedback activity the Maximum characters accepted is 5 by default, which will be much too small for the majority of fields. There isnt a way to change this to a higher value in the Moodle Site Admin interface. Ideally this should be set to 255 characters and be able to be overridden in the Moodle Site Admin settings for the Feedback activity.
6.summary: Feedback: do not allow empty pages to be shown
description: We assume that we have an activity like this: !1.png|thumbnail! We could create a new setting in module settings (disableemptypages) so that if it was active , pages with no visible questions wouldnt be shown. What do you think?
7.summary: Behat tests for all feedback question types
description: add behat tests for all feedback question types
8.summary: Allow auth users on frontpage to view and complete feedback by default
description: I found an inconsistency in default privileges - guests are allowed to view feedbacks but authenticated users not.
9.summary: Remove file mod/feedback/complete_guest.php as it 95 repeats complete.php
description: Files complete_guest.php and complete.php are almost identical. All difference in logic can be done using if (isloggedin() && !isguestuser()) blocks Removing duplicating code will make it much easier to maintain feedback module
10.summary: Behat tests for feedback templates
description: Add behat tests for feedback templates
11.summary: Feedback responses page clean up and behat tests
description: Feedback responses page clean up and behat tests
12.summary: Convert feedback to use moodleform
description: This is a major overhaul of the feedback module Moodleforms are used for completion, editing, previewing (print.php), viewing templates and viewing individual responses Lots of feedback code is refactored and is easier to follow now Resolves - when a page contains only unavailable items it is skipped The UI is also much better now
13.summary: Enable mod_feedback and block_feedback by default
description: Enable mod_feedback and block_feedback by default
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Replace existing reports in Core based on Configurable Reports
description: This Epic is related to the proposal to construct a UI for creating and editing learning analytics models: This is a proposal to replace as many Core reports as possible using the forms-based Configurable Reports tool (if it is integrated into core per ). The reason for this proposal is to allow site administrators to create copies of these reports for modification using the form-based interface. Moodle core standard reports should be protected from modification, even by site administrators, allowing only copies to be edited. Note that Configurable Reports already supports definition of roles in contexts allowed to access the report. Customized Configurable Reports can also be shared through XML files and can be acquired from a built-in link to a report repository. In theory, this standardization could also make reports easier to maintain and share code. This is an Epic so that each linked issue can reference a single Core report. For each of these reports, a summary is provided, along with how to access the report (in a Boost-based theme), inferred audience(s) and purpose, then suggestions for features necessary to implement the existing report in the form-based feature of Configurable Reports, including filters and chart.js enhancements. Part of the rationale for conducting this analysis was to ensure that a built-in reporting tool (proposed as Configurable Reports) would be able to handle all common use cases, by ensuring that it can support existing reports.
| Unsolvable | 1.summary: Replace/enhance Participants report using form-based editable report
description: . Location: Navigation block Course Gear menu / Users tab / Enroled users . Description: This report provides a list of all participants in a course to each of the participants in the course, including: First name (sortable) Surname (sortable) Roles Groups Last access to course (sortable) Instructors/managers also see: email address status of enrolment Participant names or avatars can be clicked to view detail, or can be selected to perform bulk actions (teachers and managers only). The list of participants can be filtered by first letter of first name or surname, by role, by group, by length of inactivity, and can be searched by free text. The Enrol users function is accessed by a button from this report. Other pages related to enrolment are accessed from the Gear menu on this report. This report has taken on the features of the previous Enroled users report, which has been discontinued. Previous links to the Enroled users report now link to this report. . Intended audience: All users, but primarily learners and instructors. . Purpose: Allows a participant to see the list of all participants in a course they are in at a glance, and allows instructors to send messages to selected students or manage enrolments. . Suggestions: Unlike most reports, this one appears in the Navigation block, rather than the Administration block. It allows the user to switch between lists of participants in any of their courses, even though it appears within the Current Course menu. Move to User menu? Notes can be added from this screen, but only through the bulk action menu, which seems odd. Notes do not display on this screen, even if they are added to the Course context, even if User Details are displayed. What criteria are used for the inactive for more than filter? Course or site log entries? Will any log type suffice, even if the user took no other action than viewing? It would be helpful to be able to tweak this column. Provide mouseover descriptions for selection widgets and column headers Gear button only allows editing of enrolment dates. Perhaps this should be a general dropdown with more actions matching those available through bulk actions, e.g. edit role, edit enrolment dates, add note, send message, view logs, view Outline report, etc. The info button displays mouseover text implying that clicking on it will enrol the user as the role the user already has. Actually it displays enrolment details. Add a link from here to individual user logs and other reports related to users, rather than requiring instructor to go to user s Profile page (see Gear button notes). Allow instructor to switch last access to course mode to date, rather than days ago . Conversion to Configurable Reports: This is a classic Users report for the most part. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Multipurpose filter Alphabet filter Select row/Bulk action feature Edit row menu feature Edit cell option URL link to related report Receive URL parameters Additional data elements: Last Access to Context datetime (formatted as datetime or as time ago )
2.summary: Replace/enhance Activity Completion report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Activity Completion . Description: Provides a grid of all participants (students) and activities for which completion has been defined, with completion status indication for each activity. Can be filtered by group or by firstname or surname first initial. Aggregates to course completion, if defined. Each student name is a link to a single view showing activities listed vertically with status and requirement criteria. As of 3.4, teachers are able to mark activities complete from this report. A csv download is provided that contains different information. . Intended audience: Instructors, possibly academic advisors . Purpose: Intended to provide an overview of student progress through activities in the course. Instructors may use this, for example, if a student requests extra help, to see if the student has made use of existing resources in the course first. . Suggestions: Needs to be able to filter by section, and possibly by activity type Make section borders more clear Provide feature to aggregate by section (e.g. percentage complete) Provide filter to show only incomplete activities Provide filter to show only incomplete activities whose expected complete date has passed or is about to pass Vertical lines between activities are distracting from completion status content. Could this be displayed as a solid progress bar instead? Needs legend to explain solid vs. dotted lines, colors of checkmarks, red x Needs much smaller, compressed sparkline sized view for multiple learners, no activity names, click for full detail for that learner Needs to be visible in Reports menu even if Course Completion is not configured, if activity completions are configured Allow instructor to check activities as completed? E.g. in-class demonstrations? . Conversion to Configurable Reports: This is a basic crosstab report with the two data types being users and course activities . The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Alphabet filter Crosstab reports Cell calculations (name concatenation, module icon display) Conditional cell styling Edit cell option URL Link to related report Receive URL parameters
3.summary: Replace/enhance Completion Progress Details report using form-based editable report
description: . Location: Accessed via link from Course Completion report. Breadcrumbs seem to show that this report attaches directly to the Front Page, regardless of which course it is displaying. Students can also access the single-user version from the Course Completion block (if enabled). . Description: Displays a list of Course Completion criteria, including activities, and present status and date of criteria completion for a single user. Links are provided to each course activity (with completion criteria set). . Intended audience: Instructor, student . Purpose: Allows review of completion status of a single student. Does not allow any editing, and links go to activities, not to details of student progress in activities. . Suggestions: Needs to be able to filter by section, and possibly by activity type Make section borders more clear Aggregate by section? (in progress until all activities in section are complete) Provide filter by completion status Provide graph of completion over time (when started, proportion of requirements met, when completed) Needs to be visible in Reports menu and/or much more obvious in Course Completion report Breadcrumbs should stay within course hierarchy, not attach to Dashboard . Conversion to Configurable Reports: This report needs to make use of the existing header feature of Configurable Reports, in order to display the user, completion status, and completion aggregation. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: New report type: Completion (or Join Report by adding Completion data to Course report) Group rows URL Link to related report Receive URL parameters Return button Cell calculations (to turn 0/1 values into defined text strings) Text strings
4.summary: Replace/enhance Logs and Live Logs reports using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Logs or Live logs . Description: A list of all log entries matching selected filters within the course context. At the site level, log entries can be filtered to show site errors. . Intended audience: Usually instructor, but can also be used by academic administration, e.g. in event of a grade challenge or similar dispute. Site level logs are usually used by system admin. . Purpose: This is currently a very basic, generalized report with a broad purpose of providing detail about user activity within a context. The content displayed here is often summarized in other reports. . Suggestions: The granular nature of this report limits its usefulness to viewing details of activity for a specific learner or at a specific point of time. New filters could help these reports, especially activities and actions - look for ways to filter by learner engagement (however defined). At minimum, a filter for create actions submitted to a graded activity (vs. other CRUD categories) would be helpful. The teaching level vs. participating level distinctions are less clear than the older views / posts distinctions. Ability to filter by section (group of activities, often weekly) or by activity type could be helpful. Start and end dates for log filtering would be very helpful when attempting to review activity of students per prior week. Aggregation controls by user would also be helpful, showing first log entry date/time, last log entry date/time, number of log entries (perhaps by column per CRUD category). These aggregated versions could include links to drill down to detail per user. Aggregation by activity could also be very useful. Filter by learner engagement level (view, submit, receive feedback, view feedback, provide feedback, revise/resubmit) Filter by role - allow users to check roles in a list as they choose Aggregate: count actions of different levels and aggregate by learner, by role, by component, etc., or provide obvious links from this report to other reports that serve those functions . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: New report type: Logs (including all data columns and filters displaying appropriate values for each data column) Set filter(s) before running report URL Link to related report Receive URL parameters Cell calculations (concatenation)
5.summary: Replace/enhance Course Activity report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Activity report . Description: This is one of the reports computed from logs. It summarizes (counts) views and posts per activity/resource by all users within the course context. The focus is on the contents of the course, not the individual students. Links are provided to individual activities. . Intended audience: Most likely helpful to instructors and future course developers. . Purpose: This report shows which activities and resources are being used the most or least by participants (but includes the instructor). An instructor could use this to get a general sense of whether the students are making use of some resources more than others during a class, but this would be of more use when preparing to teach the next term. . Suggestions: Allow filtering by activity type, and by section. Display posts total and distinct users, not just views Display last post, not just last view Allow site admin to hide related blog entries if blogs are not being used Provide a view with horizontal box-whisker plots to summarize minimum posts, max, quartiles per activity. _Filter by user_ could integrate this with the User Outline Report and/or Complete Report. Respond to known bug teacher actions are included in Activity Report totals. There should be the ability to filter by role. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (defined above) would be needed to convert this report: Report type: Log (or ability to attach log table to new Course Module report) Group/Break report with calculations Cell calculation with concatenation Cell calculation with icon replacement (for module icons) URL link to related report Receive URL parameters
6.summary: Replace/enhance Course Participation report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Course participation . Description: Summarizes actions taken by all participants for a specific activity/resource. Requires selection of a specific activity. This report can be filtered by length of time (days past), by student vs. other roles, and by actions. This report more clearly makes the distinction between views and posts (submissions) per activity than the new logs. View and Post definitions are displayed in the header of the report when it is run for a specific activity. The report can send a message to all users who have not completed a certain action within the time span. Note: This report runs extremely slowly, especially in moderately large enrolment courses (hundreds of participants). It is quite possible for this report to time out or simply not return results. It is not apparent if results will be returned or not-- the basic page is constructed, but no results are displayed. . Intended audience: Most likely the instructor. . Purpose: Allows the instructor to see who has viewed and/or responded to (posted to) a given activity. . Suggestions: Add ability to filter by Activity Completion status, if defined. Start and end date filters would be more helpful than the more limited look back n days, especially in cases where a grade challenge requires looking back to a prior term, etc. Note that this report maxes out at 1 year in the past. If the notification to non-participants could be scheduled by the instructor or at the site level based on criteria here, it could be very helpful. Best example: automatically send message if Expected Complete date has passed and student has not met completion criteria. Sparklines for activity next to names could also be helpful. Indicate level of cognitive depth reached. It would also be extremely helpful to be able to amplify this report to aggregate participation levels across multiple activities, but this can be very slow to calculate at a course level. Perhaps it could be done only for activities one section at a time, with an option to restrict to only those that have a completion requirement set. Could this report take advantage of Statistics (if enabled) to improve performance? . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: Log (or ability to attach log table to new Course Module report) Group/Break report Include filter selections in report header Lookback filter Select row/Bulk action feature URL Link to related report Receive URL parameters Cell calculations (including concatenate distinct)
7.summary: Replace/enhance Statistics report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Statistics . Description: Provides a simple graph of activity for all participants within course to instructor, or only own activity for individual participants. Can be filtered by either role type or view vs. post (submit), and for time period extending back from the present. Links are provided to daily logs if user has permissions to view logs. Table aggregates results per month once enough data has been accumulated. Filter allows selection of any course, though this report is reached from within a particular course. Filters do not wrap, which is problematic on a site with long course names (see below). Graph does resize in response to window/container size. . Intended audience: Primarily instructors. Also visible to individual users. . Purpose: Can show general patterns of participation at a class-wide level. . Suggestions: Requires Statistics function to be enabled at site level. Some partners advise against this for performance reasons -- is this still the case? Filters need to wrap, and truncate if necessary (e.g. on sites with long course names). Could benefit from date range start/end. Separate Role and Activity type filters. Would be very helpful to be able to restrict this by course section, and possibly also by role(s) and group/cohort. . Conversion to Configurable Reports: This would be a Timeline report using the current version of Configurable Reports (though I have never gotten it to work correctly). The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: URL link to related report Crosstab (statistics and roles) Group/Break with calculations As the report exists now, it would require a two-column combined distinct values filter.
8.summary: Replace/enhance Outline report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Outline report . Description: This report lists the course activities, and provides limited information about the current learner s participation in each activity, e.g. views, posts, grade, and an activity last access date. . Screenshot: . Intended audience: Instructor . Purpose: Provide an overview of a single student s activity, arranged by the course table of contents. . Suggestions: Links go to the activity, but should probably go to a report summarizing the participation of this user instead, since the purpose of the report is to view activity by the learner. Could merge with the Activity Report as a filter Display column headers, and provide mouseover help Link to logs for this user and activity Link back to user Profile from thumbnail & name at top of report Link to a summary of submissions/posts by this user, if available (i.e. just what is shown under this component in the Complete Report ) Provide link from Participants report. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Log report style with link to Course Module information and/or Course Module report style with link to Log information Group/Break report Cell calculations URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
9.summary: Replace/enhance Complete report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Complete report . Description: Displays all activity (all attempts, posts, etc.) by a given participant, organized by course activity/component. Level of detail varies based on activity type. . Intended audience: Teachers . Purpose: Provides a one-page consolidation of all activity by a single participant, including all participant submissions, grades, feedback, views, etc. . Suggestions: This report often takes a long time to load, and many instructors are trying to use it to look at one section or one type of activity specifically. The most common use I know of is to pull all forum posts by a single student into one page for review and grading by instructors (a need that would probably be better met within the Forum plugin itself). Provide link from Participants. Filters prior to load that allow the instructor to specify section, activity type, or even specific activity would be helpful. Including rubrics in Assignment details seems to clutter the display Allow instructor to collapse sections and individual activity reports Link to logs for this user and activity . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Log report style with link to Course Module information and/or Course Module report style with link to Log information Group/Break report Cell calculations (especially concatenation and ability to substitute text strings for values) Text strings URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
10.summary: Replace/enhance Notes report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Notes . Description: The Notes report shows all site notes, current course notes, and all personal notes entered by the current user. . Intended audience: Not clear. Site notes have visibility to managers, possibly all teachers. Course notes are available to all teachers for a given course. Personal notes are, presumably, only available to the person who wrote them, but relate to specific students. . Purpose: This appears to be intended as an annotation system to make staff at an institution aware of issues related to students as observed by other staff members. . Suggestions: Make Notes for a given student appear on that student s Profile page for those with permission to see them. Add explicit warnings about who will be able to see a note when it is posted (before saving). Display participant Notes (or at least a link to notes) on Enrollment report . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: Notes Group/Break with Headers Cell calculations (to style headers) and concatenation Row actions
11.summary: Replace/enhance Dashboard report using form-based editable report
description: . Locations: moodlesite/my/ Dashboard link in breadcrumbs Dashboard link in side drawer (Boost themes) Dashboard option in User menu . Description: The two tabs of the Dashboard report provide views of activity deadlines and completion status. The Timeline tab lists all activities due in the next 7 days and the next 30 days. Inclusion in this report can be defined in two ways: There is an expect completed by date assigned in completion criteria (the only option for resources ) The activity module provides and supports a due date (or close date ) If both criteria are met, the activity appears in the list twice, though the two entries may not appear next to each other if the dates do not match. A link to each activity appears as the activity name, and another link appears as the action the user can take in the activity, though both URLs are the same. Entries can be sorted by date or by course (since many students are enrolled in multiple courses). Only incomplete activities are shown. Started activities that have not yet been completed still appear on the list. Timeline: Sort by courses breaks the activities by courses (though they are still sorted by date) and combines each list of upcoming activities per course with the completion donut graph from the Courses tab. The Courses tab offers three views, In progress , Future , and Past, filtered by the start date and end dates of the courses. Each view provides one donut graph per course, showing the percentage of activities completed by the current user (of those with completion tracking set). This percentage is not affected by whether the activities are visible to students or not. It is unrelated to the list of activities marked as being required for course completion. . Intended audience: Students, teachers (though the purpose for teachers is not clear) . Purpose: The Dashboard report serves a number of purposes. For current in progress courses (based on course start and end dates), the Dashboard serves to remind students of activities expected to be completed within the next 7 (or 30) days. The Dashboard also shows how close the student is to completing all the activities each course (of those with due dates and/or expect completed by dates). . Suggestions: Add a setting so that the teacher can choose how items are added to this report. Display which option has been selected by the teacher under the donut graph on the Dashboard. These options do not have to be exclusive of each other, but it can be confusing to have the same activity appear more than once in the list. Completion date Due date (if supported by module) Inclusion in Course Completion criteria Add a setting so the teacher can configure whether to divide the activities completed by all activities with completion criteria set, or only those visible to the current student. Note: this means the course completion could appear to decrease if new content becomes available to a student, e.g. through release of access restrictions. This should be noted on the Dashboard if this option is used. Include all activities for which dates are set Include only activities visible to the current student Include all activities, and calculate two percentages, one of all activities, one of activities visible to the current student. Indicate the currently invisible activities as grey on the donut. Distinguish between activities not started, activities started but not completed, and activities not completed, as in the Completion Progress block. Some changes to how due dates and expect completed by dates are handled in Moodle could make this report more powerful. For example: Provide an editing tab on the Course Completion settings page that allows completion dates to be set and changed in bulk. (Currently editing activities in bulk unsets completion criteria specific to the activity type.) Allow dates (completed by or due dates) to be set relative to the course start date or enrolment start date, so the Dashboard can be used in courses with rolling enrolment. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Group/Break Cell calculations Activity module/completion data Conditional cell styling Localized text strings Output as microchart
12.summary: Replace/enhance Competency Breakdown report using form-based editable report
description: . Location: Course Gear menu / Reports tab / Competency breakdown . Description: Provided as part of the new CBE features. Allows teachers to view and rate course-linked competencies of each student in course. The report is filtered by single students through a pull-down menu. Links allow a user with appropriate permissions to update the student status with respect to each competency. Actions in the header support messaging the student and adding to contacts. . Intended audience: Probably instructors. Academic program administrators would not usually be investigating competencies at the single-course level. . Purpose: View and administer individual learner competency levels within a single course. This is likely to be used most in a Social Efficiency style curriculum, though there are ways of expressing competencies that allow for other curriculum types. . Suggestions: Enhance this report to provide the following information: Reflect the hierarchy of competencies in the report output by showing outline index or indentation Summarize student achievement of competencies across multiple students (e.g. how many students met/didn t meet a given competency within the course? Within a cohort? Within a group?) Provide a time-based report to show when competency levels were met per student, e.g. overlay line graphs for each competency in the course, showing increases in students who have met each competency/level. Show how many and which activities are tied to each competency in a two-column view. Enable filtering by graded activities. Highlight mis-matches between competencies and graded activities. Show how many attempts or activities have been submitted by the learner so far before competency is reached. Both links (Competency and Rating) produce the same result, but the purpose of neither link is clear. It might be more consistent with other Moodle forms to display the data in a row and add an Edit icon. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: competency (or join to Course) Cell calculations (especially concatenation and ability to substitute text strings for values) Support Scales (allow substitution of Scale value for integer) Text strings Filter value in header URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
13.summary: Replace/enhance User Competency Summary report using form-based editable report
description: . Location: Appears as a popup when user clicks on Competency or Rating link in Competency breakdown report. . Description: This popup report displays the details of a specific Competency, including path within Competency framework, the Activities associated with the Competency in the current course, the current student, a Proficiency binary value, the current rating, a Rate button (link to another popup), and a list of datestamped ratings with evidence for the selected student in this Competency. . Intended audience: Teachers . Purpose: This report provides an interface for updating student Competency ratings, including a review of previous ratings and evidence. . Suggestions: Because this report is implemented as a popup, it has no scroll bar and can easily overflow a smaller screen (e.g. a laptop). It might be better to make this a standard page report with a Save and return button. (Also, the Rate button results in a popup over a popup.) Probably it would make sense to provide a link to this report from the grading interface of the Activity being used as evidence for the Competency. Links on this report/popup take the user away to the Competency, Activity, Student, and any previous submitters of Evidence, with no way to return directly to this screen ( Back returns to the Competency Breakdown report, since this is a popup.) In a course with many Competencies attached, this could be very frustrating. . Conversion to Configurable Reports: Details of the Competency and links to Activity and User appear in the header of this report. The rows of the report are the Evidence records. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Display report as popup Cell calculations (including ability to construct a URL and replace integers with icons -- also used here to construct and format content of Evidence records) URL Link to related report Receive URL parameters Include filter selections in report header
14.summary: Replace/enhance Course Competencies report using form-based editable report
description: . Location: Navigation drawer menu / Competencies (in Boost) _Navigation > My courses > Course name > Competencies_ in other themes . Description: This report lists the competencies attached to the course, and allows the instructor/course developer to add or remove competencies to the course. Students are able to view their proficiency status in competencies attached to the course. Links are provided to the (top 3?) competencies most often NOT proficient in the course. The course can be configured such that competencies are only rated within this course, or are updated to students learning plans. For each competency attached to the course, the path within the competency framework is given as a link, and a list of Activities attached to the Competency in the current course is displayed. For each competency attached to the course, four options are provided to execute on course completion: Do nothing, Attach evidence, Send for review, Complete the competency. Clicking on the competency name will take the teacher to a grading page for that competency (a variation of the Competency breakdown report.) . Intended audience: Instructor/course developer, student . Purpose: This report allows the instructor/course developer to add or remove competencies to the course. Students are able to view their proficiency status in competencies attached to the course. . Suggestions: Do not show instructors you are proficient indicator. (Possibly this could be controlled by the setting at _Site administration > Grades > Report settings > Grader report_ > _Graded roles_.) Make it possible to select activities from the course to attach to competencies from this page. (Add a Attach Activity button for each Competency displayed, and go to a new report that lists all Activities in the course and allows checkbox selection to add the current Competency to those Activities, and ability to update the Upon activity completion setting for each Activity from the same page. Provide an Attach and return to competencies button on this second report. Ideally it would also be possible to add new Activities to the course from this second report. Then the Competencies assigned to the course could be used for the course design process. Make it more clear what complete the competency does in Activity and Course completion. Does it assign the default level of proficiency? . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Cell calculations (including ability to construct a URL and replace integers with icons -- also used here to construct and format display of attached Activities) URL Link to related report Receive URL parameters Include filter selections in report header Edit cell option Manually reorder report results and save new order for next execution Localized text strings
15.summary: Replace/enhance Grader report using form-based editable report
description: . Location: Home| / Courses| / shortname / Grade administration / Grader report| . Description: Lists all participants on vertical axis, all gradable items on horizontal axis, current grades in individual cells. . Intended audience: Instructors and others with permission to view and/or alter grades . Purpose: Originally this provided the primary interface to review and update grades for all students and activities. (Additional interfaces per activity are usually also available.) . Suggestions: This report is large and unwieldy for all but the smallest of courses (small numbers of students AND small numbers of gradable activities). Provide JS-based scrolling enhancements (frozen headers and footers) for all core themes (now available in Boost and Clean, but not More) Provide option to filter this report to show only grades per section (categories can be collapsed, but sections are more likely to represent dates and related activities), Filter to show grades that are expected and not yet completed (using Completion Expected By) Filter to show grades that are above or below specific values Filter to show empty grades where work has been submitted by student (and still requires marking) . Conversion to Configurable Reports: This is a classic crosstab report. In order to be sure to show accurate grades, the Moodle API MUST be used in this report, not direct database access. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Use only Moodle API Report type: Grades (all Grades for current Course) Crosstab reports Horizontal Group/Break with collapsable sections (for category visibility) Conditional cell styling (including image display) Edit row/action menu Edit column/action menu Edit cell Image display Localized text strings (column headers) Frozen columns Frozen header rows Frozen footer rows URL link to related report Receive URL parameters
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Replace existing reports in Core based on Configurable Reports
description: This Epic is related to the proposal to construct a UI for creating and editing learning analytics models: This is a proposal to replace as many Core reports as possible using the forms-based Configurable Reports tool (if it is integrated into core per ). The reason for this proposal is to allow site administrators to create copies of these reports for modification using the form-based interface. Moodle core standard reports should be protected from modification, even by site administrators, allowing only copies to be edited. Note that Configurable Reports already supports definition of roles in contexts allowed to access the report. Customized Configurable Reports can also be shared through XML files and can be acquired from a built-in link to a report repository. In theory, this standardization could also make reports easier to maintain and share code. This is an Epic so that each linked issue can reference a single Core report. For each of these reports, a summary is provided, along with how to access the report (in a Boost-based theme), inferred audience(s) and purpose, then suggestions for features necessary to implement the existing report in the form-based feature of Configurable Reports, including filters and chart.js enhancements. Part of the rationale for conducting this analysis was to ensure that a built-in reporting tool (proposed as Configurable Reports) would be able to handle all common use cases, by ensuring that it can support existing reports.
### Response:
1.summary: Replace/enhance Participants report using form-based editable report
description: . Location: Navigation block Course Gear menu / Users tab / Enroled users . Description: This report provides a list of all participants in a course to each of the participants in the course, including: First name (sortable) Surname (sortable) Roles Groups Last access to course (sortable) Instructors/managers also see: email address status of enrolment Participant names or avatars can be clicked to view detail, or can be selected to perform bulk actions (teachers and managers only). The list of participants can be filtered by first letter of first name or surname, by role, by group, by length of inactivity, and can be searched by free text. The Enrol users function is accessed by a button from this report. Other pages related to enrolment are accessed from the Gear menu on this report. This report has taken on the features of the previous Enroled users report, which has been discontinued. Previous links to the Enroled users report now link to this report. . Intended audience: All users, but primarily learners and instructors. . Purpose: Allows a participant to see the list of all participants in a course they are in at a glance, and allows instructors to send messages to selected students or manage enrolments. . Suggestions: Unlike most reports, this one appears in the Navigation block, rather than the Administration block. It allows the user to switch between lists of participants in any of their courses, even though it appears within the Current Course menu. Move to User menu? Notes can be added from this screen, but only through the bulk action menu, which seems odd. Notes do not display on this screen, even if they are added to the Course context, even if User Details are displayed. What criteria are used for the inactive for more than filter? Course or site log entries? Will any log type suffice, even if the user took no other action than viewing? It would be helpful to be able to tweak this column. Provide mouseover descriptions for selection widgets and column headers Gear button only allows editing of enrolment dates. Perhaps this should be a general dropdown with more actions matching those available through bulk actions, e.g. edit role, edit enrolment dates, add note, send message, view logs, view Outline report, etc. The info button displays mouseover text implying that clicking on it will enrol the user as the role the user already has. Actually it displays enrolment details. Add a link from here to individual user logs and other reports related to users, rather than requiring instructor to go to user s Profile page (see Gear button notes). Allow instructor to switch last access to course mode to date, rather than days ago . Conversion to Configurable Reports: This is a classic Users report for the most part. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Multipurpose filter Alphabet filter Select row/Bulk action feature Edit row menu feature Edit cell option URL link to related report Receive URL parameters Additional data elements: Last Access to Context datetime (formatted as datetime or as time ago )
2.summary: Replace/enhance Activity Completion report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Activity Completion . Description: Provides a grid of all participants (students) and activities for which completion has been defined, with completion status indication for each activity. Can be filtered by group or by firstname or surname first initial. Aggregates to course completion, if defined. Each student name is a link to a single view showing activities listed vertically with status and requirement criteria. As of 3.4, teachers are able to mark activities complete from this report. A csv download is provided that contains different information. . Intended audience: Instructors, possibly academic advisors . Purpose: Intended to provide an overview of student progress through activities in the course. Instructors may use this, for example, if a student requests extra help, to see if the student has made use of existing resources in the course first. . Suggestions: Needs to be able to filter by section, and possibly by activity type Make section borders more clear Provide feature to aggregate by section (e.g. percentage complete) Provide filter to show only incomplete activities Provide filter to show only incomplete activities whose expected complete date has passed or is about to pass Vertical lines between activities are distracting from completion status content. Could this be displayed as a solid progress bar instead? Needs legend to explain solid vs. dotted lines, colors of checkmarks, red x Needs much smaller, compressed sparkline sized view for multiple learners, no activity names, click for full detail for that learner Needs to be visible in Reports menu even if Course Completion is not configured, if activity completions are configured Allow instructor to check activities as completed? E.g. in-class demonstrations? . Conversion to Configurable Reports: This is a basic crosstab report with the two data types being users and course activities . The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Alphabet filter Crosstab reports Cell calculations (name concatenation, module icon display) Conditional cell styling Edit cell option URL Link to related report Receive URL parameters
3.summary: Replace/enhance Completion Progress Details report using form-based editable report
description: . Location: Accessed via link from Course Completion report. Breadcrumbs seem to show that this report attaches directly to the Front Page, regardless of which course it is displaying. Students can also access the single-user version from the Course Completion block (if enabled). . Description: Displays a list of Course Completion criteria, including activities, and present status and date of criteria completion for a single user. Links are provided to each course activity (with completion criteria set). . Intended audience: Instructor, student . Purpose: Allows review of completion status of a single student. Does not allow any editing, and links go to activities, not to details of student progress in activities. . Suggestions: Needs to be able to filter by section, and possibly by activity type Make section borders more clear Aggregate by section? (in progress until all activities in section are complete) Provide filter by completion status Provide graph of completion over time (when started, proportion of requirements met, when completed) Needs to be visible in Reports menu and/or much more obvious in Course Completion report Breadcrumbs should stay within course hierarchy, not attach to Dashboard . Conversion to Configurable Reports: This report needs to make use of the existing header feature of Configurable Reports, in order to display the user, completion status, and completion aggregation. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: New report type: Completion (or Join Report by adding Completion data to Course report) Group rows URL Link to related report Receive URL parameters Return button Cell calculations (to turn 0/1 values into defined text strings) Text strings
4.summary: Replace/enhance Logs and Live Logs reports using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Logs or Live logs . Description: A list of all log entries matching selected filters within the course context. At the site level, log entries can be filtered to show site errors. . Intended audience: Usually instructor, but can also be used by academic administration, e.g. in event of a grade challenge or similar dispute. Site level logs are usually used by system admin. . Purpose: This is currently a very basic, generalized report with a broad purpose of providing detail about user activity within a context. The content displayed here is often summarized in other reports. . Suggestions: The granular nature of this report limits its usefulness to viewing details of activity for a specific learner or at a specific point of time. New filters could help these reports, especially activities and actions - look for ways to filter by learner engagement (however defined). At minimum, a filter for create actions submitted to a graded activity (vs. other CRUD categories) would be helpful. The teaching level vs. participating level distinctions are less clear than the older views / posts distinctions. Ability to filter by section (group of activities, often weekly) or by activity type could be helpful. Start and end dates for log filtering would be very helpful when attempting to review activity of students per prior week. Aggregation controls by user would also be helpful, showing first log entry date/time, last log entry date/time, number of log entries (perhaps by column per CRUD category). These aggregated versions could include links to drill down to detail per user. Aggregation by activity could also be very useful. Filter by learner engagement level (view, submit, receive feedback, view feedback, provide feedback, revise/resubmit) Filter by role - allow users to check roles in a list as they choose Aggregate: count actions of different levels and aggregate by learner, by role, by component, etc., or provide obvious links from this report to other reports that serve those functions . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: New report type: Logs (including all data columns and filters displaying appropriate values for each data column) Set filter(s) before running report URL Link to related report Receive URL parameters Cell calculations (concatenation)
5.summary: Replace/enhance Course Activity report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Activity report . Description: This is one of the reports computed from logs. It summarizes (counts) views and posts per activity/resource by all users within the course context. The focus is on the contents of the course, not the individual students. Links are provided to individual activities. . Intended audience: Most likely helpful to instructors and future course developers. . Purpose: This report shows which activities and resources are being used the most or least by participants (but includes the instructor). An instructor could use this to get a general sense of whether the students are making use of some resources more than others during a class, but this would be of more use when preparing to teach the next term. . Suggestions: Allow filtering by activity type, and by section. Display posts total and distinct users, not just views Display last post, not just last view Allow site admin to hide related blog entries if blogs are not being used Provide a view with horizontal box-whisker plots to summarize minimum posts, max, quartiles per activity. _Filter by user_ could integrate this with the User Outline Report and/or Complete Report. Respond to known bug teacher actions are included in Activity Report totals. There should be the ability to filter by role. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (defined above) would be needed to convert this report: Report type: Log (or ability to attach log table to new Course Module report) Group/Break report with calculations Cell calculation with concatenation Cell calculation with icon replacement (for module icons) URL link to related report Receive URL parameters
6.summary: Replace/enhance Course Participation report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Course participation . Description: Summarizes actions taken by all participants for a specific activity/resource. Requires selection of a specific activity. This report can be filtered by length of time (days past), by student vs. other roles, and by actions. This report more clearly makes the distinction between views and posts (submissions) per activity than the new logs. View and Post definitions are displayed in the header of the report when it is run for a specific activity. The report can send a message to all users who have not completed a certain action within the time span. Note: This report runs extremely slowly, especially in moderately large enrolment courses (hundreds of participants). It is quite possible for this report to time out or simply not return results. It is not apparent if results will be returned or not-- the basic page is constructed, but no results are displayed. . Intended audience: Most likely the instructor. . Purpose: Allows the instructor to see who has viewed and/or responded to (posted to) a given activity. . Suggestions: Add ability to filter by Activity Completion status, if defined. Start and end date filters would be more helpful than the more limited look back n days, especially in cases where a grade challenge requires looking back to a prior term, etc. Note that this report maxes out at 1 year in the past. If the notification to non-participants could be scheduled by the instructor or at the site level based on criteria here, it could be very helpful. Best example: automatically send message if Expected Complete date has passed and student has not met completion criteria. Sparklines for activity next to names could also be helpful. Indicate level of cognitive depth reached. It would also be extremely helpful to be able to amplify this report to aggregate participation levels across multiple activities, but this can be very slow to calculate at a course level. Perhaps it could be done only for activities one section at a time, with an option to restrict to only those that have a completion requirement set. Could this report take advantage of Statistics (if enabled) to improve performance? . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: Log (or ability to attach log table to new Course Module report) Group/Break report Include filter selections in report header Lookback filter Select row/Bulk action feature URL Link to related report Receive URL parameters Cell calculations (including concatenate distinct)
7.summary: Replace/enhance Statistics report using form-based editable report
description: . Location: Course Gear menu / More / Reports tab / Statistics . Description: Provides a simple graph of activity for all participants within course to instructor, or only own activity for individual participants. Can be filtered by either role type or view vs. post (submit), and for time period extending back from the present. Links are provided to daily logs if user has permissions to view logs. Table aggregates results per month once enough data has been accumulated. Filter allows selection of any course, though this report is reached from within a particular course. Filters do not wrap, which is problematic on a site with long course names (see below). Graph does resize in response to window/container size. . Intended audience: Primarily instructors. Also visible to individual users. . Purpose: Can show general patterns of participation at a class-wide level. . Suggestions: Requires Statistics function to be enabled at site level. Some partners advise against this for performance reasons -- is this still the case? Filters need to wrap, and truncate if necessary (e.g. on sites with long course names). Could benefit from date range start/end. Separate Role and Activity type filters. Would be very helpful to be able to restrict this by course section, and possibly also by role(s) and group/cohort. . Conversion to Configurable Reports: This would be a Timeline report using the current version of Configurable Reports (though I have never gotten it to work correctly). The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: URL link to related report Crosstab (statistics and roles) Group/Break with calculations As the report exists now, it would require a two-column combined distinct values filter.
8.summary: Replace/enhance Outline report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Outline report . Description: This report lists the course activities, and provides limited information about the current learner s participation in each activity, e.g. views, posts, grade, and an activity last access date. . Screenshot: . Intended audience: Instructor . Purpose: Provide an overview of a single student s activity, arranged by the course table of contents. . Suggestions: Links go to the activity, but should probably go to a report summarizing the participation of this user instead, since the purpose of the report is to view activity by the learner. Could merge with the Activity Report as a filter Display column headers, and provide mouseover help Link to logs for this user and activity Link back to user Profile from thumbnail & name at top of report Link to a summary of submissions/posts by this user, if available (i.e. just what is shown under this component in the Complete Report ) Provide link from Participants report. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Log report style with link to Course Module information and/or Course Module report style with link to Log information Group/Break report Cell calculations URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
9.summary: Replace/enhance Complete report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Complete report . Description: Displays all activity (all attempts, posts, etc.) by a given participant, organized by course activity/component. Level of detail varies based on activity type. . Intended audience: Teachers . Purpose: Provides a one-page consolidation of all activity by a single participant, including all participant submissions, grades, feedback, views, etc. . Suggestions: This report often takes a long time to load, and many instructors are trying to use it to look at one section or one type of activity specifically. The most common use I know of is to pull all forum posts by a single student into one page for review and grading by instructors (a need that would probably be better met within the Forum plugin itself). Provide link from Participants. Filters prior to load that allow the instructor to specify section, activity type, or even specific activity would be helpful. Including rubrics in Assignment details seems to clutter the display Allow instructor to collapse sections and individual activity reports Link to logs for this user and activity . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Log report style with link to Course Module information and/or Course Module report style with link to Log information Group/Break report Cell calculations (especially concatenation and ability to substitute text strings for values) Text strings URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
10.summary: Replace/enhance Notes report using form-based editable report
description: . Location: Sidebar / Participants / Click participant / Notes . Description: The Notes report shows all site notes, current course notes, and all personal notes entered by the current user. . Intended audience: Not clear. Site notes have visibility to managers, possibly all teachers. Course notes are available to all teachers for a given course. Personal notes are, presumably, only available to the person who wrote them, but relate to specific students. . Purpose: This appears to be intended as an annotation system to make staff at an institution aware of issues related to students as observed by other staff members. . Suggestions: Make Notes for a given student appear on that student s Profile page for those with permission to see them. Add explicit warnings about who will be able to see a note when it is posted (before saving). Display participant Notes (or at least a link to notes) on Enrollment report . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: Notes Group/Break with Headers Cell calculations (to style headers) and concatenation Row actions
11.summary: Replace/enhance Dashboard report using form-based editable report
description: . Locations: moodlesite/my/ Dashboard link in breadcrumbs Dashboard link in side drawer (Boost themes) Dashboard option in User menu . Description: The two tabs of the Dashboard report provide views of activity deadlines and completion status. The Timeline tab lists all activities due in the next 7 days and the next 30 days. Inclusion in this report can be defined in two ways: There is an expect completed by date assigned in completion criteria (the only option for resources ) The activity module provides and supports a due date (or close date ) If both criteria are met, the activity appears in the list twice, though the two entries may not appear next to each other if the dates do not match. A link to each activity appears as the activity name, and another link appears as the action the user can take in the activity, though both URLs are the same. Entries can be sorted by date or by course (since many students are enrolled in multiple courses). Only incomplete activities are shown. Started activities that have not yet been completed still appear on the list. Timeline: Sort by courses breaks the activities by courses (though they are still sorted by date) and combines each list of upcoming activities per course with the completion donut graph from the Courses tab. The Courses tab offers three views, In progress , Future , and Past, filtered by the start date and end dates of the courses. Each view provides one donut graph per course, showing the percentage of activities completed by the current user (of those with completion tracking set). This percentage is not affected by whether the activities are visible to students or not. It is unrelated to the list of activities marked as being required for course completion. . Intended audience: Students, teachers (though the purpose for teachers is not clear) . Purpose: The Dashboard report serves a number of purposes. For current in progress courses (based on course start and end dates), the Dashboard serves to remind students of activities expected to be completed within the next 7 (or 30) days. The Dashboard also shows how close the student is to completing all the activities each course (of those with due dates and/or expect completed by dates). . Suggestions: Add a setting so that the teacher can choose how items are added to this report. Display which option has been selected by the teacher under the donut graph on the Dashboard. These options do not have to be exclusive of each other, but it can be confusing to have the same activity appear more than once in the list. Completion date Due date (if supported by module) Inclusion in Course Completion criteria Add a setting so the teacher can configure whether to divide the activities completed by all activities with completion criteria set, or only those visible to the current student. Note: this means the course completion could appear to decrease if new content becomes available to a student, e.g. through release of access restrictions. This should be noted on the Dashboard if this option is used. Include all activities for which dates are set Include only activities visible to the current student Include all activities, and calculate two percentages, one of all activities, one of activities visible to the current student. Indicate the currently invisible activities as grey on the donut. Distinguish between activities not started, activities started but not completed, and activities not completed, as in the Completion Progress block. Some changes to how due dates and expect completed by dates are handled in Moodle could make this report more powerful. For example: Provide an editing tab on the Course Completion settings page that allows completion dates to be set and changed in bulk. (Currently editing activities in bulk unsets completion criteria specific to the activity type.) Allow dates (completed by or due dates) to be set relative to the course start date or enrolment start date, so the Dashboard can be used in courses with rolling enrolment. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Group/Break Cell calculations Activity module/completion data Conditional cell styling Localized text strings Output as microchart
12.summary: Replace/enhance Competency Breakdown report using form-based editable report
description: . Location: Course Gear menu / Reports tab / Competency breakdown . Description: Provided as part of the new CBE features. Allows teachers to view and rate course-linked competencies of each student in course. The report is filtered by single students through a pull-down menu. Links allow a user with appropriate permissions to update the student status with respect to each competency. Actions in the header support messaging the student and adding to contacts. . Intended audience: Probably instructors. Academic program administrators would not usually be investigating competencies at the single-course level. . Purpose: View and administer individual learner competency levels within a single course. This is likely to be used most in a Social Efficiency style curriculum, though there are ways of expressing competencies that allow for other curriculum types. . Suggestions: Enhance this report to provide the following information: Reflect the hierarchy of competencies in the report output by showing outline index or indentation Summarize student achievement of competencies across multiple students (e.g. how many students met/didn t meet a given competency within the course? Within a cohort? Within a group?) Provide a time-based report to show when competency levels were met per student, e.g. overlay line graphs for each competency in the course, showing increases in students who have met each competency/level. Show how many and which activities are tied to each competency in a two-column view. Enable filtering by graded activities. Highlight mis-matches between competencies and graded activities. Show how many attempts or activities have been submitted by the learner so far before competency is reached. Both links (Competency and Rating) produce the same result, but the purpose of neither link is clear. It might be more consistent with other Moodle forms to display the data in a row and add an Edit icon. . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Report type: competency (or join to Course) Cell calculations (especially concatenation and ability to substitute text strings for values) Support Scales (allow substitution of Scale value for integer) Text strings Filter value in header URL Link to related report Receive URL parameters Bulk action (special case, as only one user is shown in this report, but there need to be actions to message user or add user to contacts)
13.summary: Replace/enhance User Competency Summary report using form-based editable report
description: . Location: Appears as a popup when user clicks on Competency or Rating link in Competency breakdown report. . Description: This popup report displays the details of a specific Competency, including path within Competency framework, the Activities associated with the Competency in the current course, the current student, a Proficiency binary value, the current rating, a Rate button (link to another popup), and a list of datestamped ratings with evidence for the selected student in this Competency. . Intended audience: Teachers . Purpose: This report provides an interface for updating student Competency ratings, including a review of previous ratings and evidence. . Suggestions: Because this report is implemented as a popup, it has no scroll bar and can easily overflow a smaller screen (e.g. a laptop). It might be better to make this a standard page report with a Save and return button. (Also, the Rate button results in a popup over a popup.) Probably it would make sense to provide a link to this report from the grading interface of the Activity being used as evidence for the Competency. Links on this report/popup take the user away to the Competency, Activity, Student, and any previous submitters of Evidence, with no way to return directly to this screen ( Back returns to the Competency Breakdown report, since this is a popup.) In a course with many Competencies attached, this could be very frustrating. . Conversion to Configurable Reports: Details of the Competency and links to Activity and User appear in the header of this report. The rows of the report are the Evidence records. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Display report as popup Cell calculations (including ability to construct a URL and replace integers with icons -- also used here to construct and format content of Evidence records) URL Link to related report Receive URL parameters Include filter selections in report header
14.summary: Replace/enhance Course Competencies report using form-based editable report
description: . Location: Navigation drawer menu / Competencies (in Boost) _Navigation > My courses > Course name > Competencies_ in other themes . Description: This report lists the competencies attached to the course, and allows the instructor/course developer to add or remove competencies to the course. Students are able to view their proficiency status in competencies attached to the course. Links are provided to the (top 3?) competencies most often NOT proficient in the course. The course can be configured such that competencies are only rated within this course, or are updated to students learning plans. For each competency attached to the course, the path within the competency framework is given as a link, and a list of Activities attached to the Competency in the current course is displayed. For each competency attached to the course, four options are provided to execute on course completion: Do nothing, Attach evidence, Send for review, Complete the competency. Clicking on the competency name will take the teacher to a grading page for that competency (a variation of the Competency breakdown report.) . Intended audience: Instructor/course developer, student . Purpose: This report allows the instructor/course developer to add or remove competencies to the course. Students are able to view their proficiency status in competencies attached to the course. . Suggestions: Do not show instructors you are proficient indicator. (Possibly this could be controlled by the setting at _Site administration > Grades > Report settings > Grader report_ > _Graded roles_.) Make it possible to select activities from the course to attach to competencies from this page. (Add a Attach Activity button for each Competency displayed, and go to a new report that lists all Activities in the course and allows checkbox selection to add the current Competency to those Activities, and ability to update the Upon activity completion setting for each Activity from the same page. Provide an Attach and return to competencies button on this second report. Ideally it would also be possible to add new Activities to the course from this second report. Then the Competencies assigned to the course could be used for the course design process. Make it more clear what complete the competency does in Activity and Course completion. Does it assign the default level of proficiency? . Conversion to Configurable Reports: The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Cell calculations (including ability to construct a URL and replace integers with icons -- also used here to construct and format display of attached Activities) URL Link to related report Receive URL parameters Include filter selections in report header Edit cell option Manually reorder report results and save new order for next execution Localized text strings
15.summary: Replace/enhance Grader report using form-based editable report
description: . Location: Home| / Courses| / shortname / Grade administration / Grader report| . Description: Lists all participants on vertical axis, all gradable items on horizontal axis, current grades in individual cells. . Intended audience: Instructors and others with permission to view and/or alter grades . Purpose: Originally this provided the primary interface to review and update grades for all students and activities. (Additional interfaces per activity are usually also available.) . Suggestions: This report is large and unwieldy for all but the smallest of courses (small numbers of students AND small numbers of gradable activities). Provide JS-based scrolling enhancements (frozen headers and footers) for all core themes (now available in Boost and Clean, but not More) Provide option to filter this report to show only grades per section (categories can be collapsed, but sections are more likely to represent dates and related activities), Filter to show grades that are expected and not yet completed (using Completion Expected By) Filter to show grades that are above or below specific values Filter to show empty grades where work has been submitted by student (and still requires marking) . Conversion to Configurable Reports: This is a classic crosstab report. In order to be sure to show accurate grades, the Moodle API MUST be used in this report, not direct database access. The following enhancements to Configurable Reports (detailed above) would be needed to convert this report: Use only Moodle API Report type: Grades (all Grades for current Course) Crosstab reports Horizontal Group/Break with collapsable sections (for category visibility) Conditional cell styling (including image display) Edit row/action menu Edit column/action menu Edit cell Image display Localized text strings (column headers) Frozen columns Frozen header rows Frozen footer rows URL link to related report Receive URL parameters
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Add a behat feature to add all of Moodles blocks in all contexts
description: This is a good idea as can catch many issues. We already have .feature files covering the blocks general management, but not features about specific blocks being added to the different contexts where they can be added. Based on MDLTEST-236 (created by Dan Poltawski) Current blocks with any behat tests in master (not considering any coverage analysis): activity_modules: (/) activity_results: admin_bookmarks: badges blog_menu blog_recent blog_tags: calendar_month calendar_upcoming comments community completionstatus course_list course_overview course_summary feedback glossary_random: html: login: mentees messages mnet_hosts myprofile navigation: (/) news_items: , online_users participants: private_files quiz_results recent_activity: (/) rss_client: search_forums section_links selfcompletion settings (/) (I think adequately covered by other tests) site_main_menu (/) social_activities tag_flickr tag_youtube tags:
| Unsolvable | 1.summary: Improved Behat tests for the activity_results block
description: The behat tests for the activity_results block can be improved by: Moving the group creation to the background Expanding behat tests to include scales
2.summary: Add Behat tests for the blog_menu block
description: The blog_menu block currently doesnt have any behat tests.
3.summary: Add Behat tests for the blog_recent block
description: The recent blogs block does not have any behat tests.
4.summary: Add Behat tests for the badges block
description: The badges block does not have any behat tests.
5.summary: Add Behat tests for the calendar blocks
description: The calendar block does not have any behat tests.
6.summary: Improve Behat tests for the comments block
description: While the comments block has tests for adding and deleting comments, it would be good to add tests for adding the block to a variety of pages including frontpage, course, activity and dashboard.
7.summary: Add Behat tests for the completion status block
description: The completion status block does not have any behat tests.
8.summary: Add Behat tests for the courses block
description: The courses block does not have any behat tests.
9.summary: Add Behat tests for the course overview block
description: The course overview block does not have any behat tests.
10.summary: Add Behat tests for the messages block
description: The messages block does not have any behat tests.
11.summary: Add Behat tests for the logged in user block
description: The logged in user block does not have any behat tests.
12.summary: Add Behat tests for the private files block
description: The private files block does not have any behat tests.
13.summary: Behat tests for the online users block
description: The online users block does not have any behat tests.
14.summary: Behat tests for the search forums block
description: The search forums block does not have any behat tests
15.summary: Behat tests for the section links block
description: The section links block does not have any behat tests
16.summary: Behat tests for the self completion block
description: The self completion block does not have any behat tests
17.summary: Behat tests for the social activities block
description: The social activities block does not have any behat tests
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Add a behat feature to add all of Moodles blocks in all contexts
description: This is a good idea as can catch many issues. We already have .feature files covering the blocks general management, but not features about specific blocks being added to the different contexts where they can be added. Based on MDLTEST-236 (created by Dan Poltawski) Current blocks with any behat tests in master (not considering any coverage analysis): activity_modules: (/) activity_results: admin_bookmarks: badges blog_menu blog_recent blog_tags: calendar_month calendar_upcoming comments community completionstatus course_list course_overview course_summary feedback glossary_random: html: login: mentees messages mnet_hosts myprofile navigation: (/) news_items: , online_users participants: private_files quiz_results recent_activity: (/) rss_client: search_forums section_links selfcompletion settings (/) (I think adequately covered by other tests) site_main_menu (/) social_activities tag_flickr tag_youtube tags:
### Response:
1.summary: Improved Behat tests for the activity_results block
description: The behat tests for the activity_results block can be improved by: Moving the group creation to the background Expanding behat tests to include scales
2.summary: Add Behat tests for the blog_menu block
description: The blog_menu block currently doesnt have any behat tests.
3.summary: Add Behat tests for the blog_recent block
description: The recent blogs block does not have any behat tests.
4.summary: Add Behat tests for the badges block
description: The badges block does not have any behat tests.
5.summary: Add Behat tests for the calendar blocks
description: The calendar block does not have any behat tests.
6.summary: Improve Behat tests for the comments block
description: While the comments block has tests for adding and deleting comments, it would be good to add tests for adding the block to a variety of pages including frontpage, course, activity and dashboard.
7.summary: Add Behat tests for the completion status block
description: The completion status block does not have any behat tests.
8.summary: Add Behat tests for the courses block
description: The courses block does not have any behat tests.
9.summary: Add Behat tests for the course overview block
description: The course overview block does not have any behat tests.
10.summary: Add Behat tests for the messages block
description: The messages block does not have any behat tests.
11.summary: Add Behat tests for the logged in user block
description: The logged in user block does not have any behat tests.
12.summary: Add Behat tests for the private files block
description: The private files block does not have any behat tests.
13.summary: Behat tests for the online users block
description: The online users block does not have any behat tests.
14.summary: Behat tests for the search forums block
description: The search forums block does not have any behat tests
15.summary: Behat tests for the section links block
description: The section links block does not have any behat tests
16.summary: Behat tests for the self completion block
description: The self completion block does not have any behat tests
17.summary: Behat tests for the social activities block
description: The social activities block does not have any behat tests
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Gradebook performance improvements for Moodle 3.1
description: In large courses (500+ students) with a decent amount of gradebook entries, a gradebook regrade caused by adding/moving/modifying a grade item can take a really long time, often several minutes. To test this, extend the testing instructions from by adding grades to more assignments and monitoring the regrade time after triggering a gradebook regrade. Even in a 20+ second query time to regrade an almost empty gradebook with 300 grades is unacceptable. From what I can tell, regrading is very liberal in choosing which grade items to include, and for each included grade item, a grade_grades entrys alteredaggregationweight and alteredaggregationstatus will be written out to the DB at least twice for each user. Once to reset it, and another time to update it. So a gradebook regrade is linear in the amount of grade_grades items present in the gradebook.
| Unsolvable | 1.summary: Add a cache definition for grade categories
description: Login into the gradebook with different users, looking at different reports... there are always many repeated queries to grade_categories tables, they are simple database queries to grade_categories without any join with other tables, writes in grade_categories table are not specially high in comparison with the number of reads so it seems a good candidate to cache at application level as we will not invalidate the data often (similar to groupdata case). Same happens with grade_items, but I will create a separate issue for it.
2.summary: Grade Needsupdate with large recordset
description: We noticed that Grade needsupdate code in Latest 2.8 fails with large recordset. We have a client which has a single course having 2m records. All other courses went fine with needsupdate code but that one course stuck. Problem is that for various reasons (timeouts, memory etc) it is not practical to execute this amount of processing on browser. Workaround: We created a cli script and executed it via shell. Solution: It would be better to push similar code in cron.
3.summary: No need to call grade_regrade_final_grades from update_raw_grade and update_final_grade in some cases
description: grade_item::update_raw_grade updates a user grade, it is called from grade_update, the one used by activities to send grades to the gradebook. It is good that we recalculate the whole set of grade_grades of that user in the course if the grade or the scale changes, but in some cases there is no need to call grade_regrade_final_grades, like a feedback change or just the timemodified. Based on
4.summary: Skip regrading of categories and calculated items that do not depend on $updated_item
description: grade_regrade_final_grades is used to regrade the whole course gradebook and to regrade the gradebook for a single user, if userid is specified we require $updated_item argument too. Even if $updated_item is specified, we are marking all categories and calculated items as needsupdate, I cant think of any reason to update categories and calculated items that do not depend on the updated item. We have a grade_item::depends_on function, but it is only looking for items that directly depend on them (means that grade items located in a category are not included in the course item grade_item::depends_on()) and we should consider all dependant items. Items are not updated until all their dependencies are final grades, we could check that too.
5.summary: auto_update_weights calls update() even if there is no aggregationcoef2 change
description: As most of the gradebook performance reports are related with full gradebook regrades, Ive created a test course (tool_generator - M size) with around 1000 users and 100 activities to see the basic configuration issues. Ive been changing the gradebook structure and checking which interactions with the database we have to see if there is anything we could improve. New grade category and manual grade items results in around 1000-1500 db reads and 400-700 db writes, I see many stuff and I dont want to mess up with the whole gradebook design nor implement major changes here, but auto_update_weights seems to be calling update() unnecessarily. Ive reduced the number of db writes to half of it with the provided patch. I havent seen any gradeitem modifications to justify an update() call if the aggregatecoef2 value is not changed. As a beneficial side effect this reduces the number of records added to grade history which is also the reason why we have that many insert record calls.
6.summary: Remove unnecessary database writes (updates basically) on full gradebook recalculations
description: While debugging I found out that when we add a new grade_item we are calling update() through set_hidden in all its hierarchy categories even if there are no changes in their visibility, only because if the new grade_item is visible and the category hidden, we should make it visible, and this continues through all the tree up until the course. Many unnecessary update() calls (= cache invalidations) if all the hierarchy is already visible. Changing this may highlight other issues, but if any grade_object has the need to be updated it shouldnt be through set_hidden, I mean that if I change $gi->attr = 12312 and later call set_hidden(false) I should not rely in set_hidden update() call, I should call it separately. Id like opinions on this even I dont fully believe in this change and I think it is very dangerous. But would help as each change in grade_categories, even if we are calling update() to change, notify_cached is being called and grade_categories cache purged. Updating the issues title as set_hidden is only affecting new grade categories and expanding its scope to other write actions.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Gradebook performance improvements for Moodle 3.1
description: In large courses (500+ students) with a decent amount of gradebook entries, a gradebook regrade caused by adding/moving/modifying a grade item can take a really long time, often several minutes. To test this, extend the testing instructions from by adding grades to more assignments and monitoring the regrade time after triggering a gradebook regrade. Even in a 20+ second query time to regrade an almost empty gradebook with 300 grades is unacceptable. From what I can tell, regrading is very liberal in choosing which grade items to include, and for each included grade item, a grade_grades entrys alteredaggregationweight and alteredaggregationstatus will be written out to the DB at least twice for each user. Once to reset it, and another time to update it. So a gradebook regrade is linear in the amount of grade_grades items present in the gradebook.
### Response:
1.summary: Add a cache definition for grade categories
description: Login into the gradebook with different users, looking at different reports... there are always many repeated queries to grade_categories tables, they are simple database queries to grade_categories without any join with other tables, writes in grade_categories table are not specially high in comparison with the number of reads so it seems a good candidate to cache at application level as we will not invalidate the data often (similar to groupdata case). Same happens with grade_items, but I will create a separate issue for it.
2.summary: Grade Needsupdate with large recordset
description: We noticed that Grade needsupdate code in Latest 2.8 fails with large recordset. We have a client which has a single course having 2m records. All other courses went fine with needsupdate code but that one course stuck. Problem is that for various reasons (timeouts, memory etc) it is not practical to execute this amount of processing on browser. Workaround: We created a cli script and executed it via shell. Solution: It would be better to push similar code in cron.
3.summary: No need to call grade_regrade_final_grades from update_raw_grade and update_final_grade in some cases
description: grade_item::update_raw_grade updates a user grade, it is called from grade_update, the one used by activities to send grades to the gradebook. It is good that we recalculate the whole set of grade_grades of that user in the course if the grade or the scale changes, but in some cases there is no need to call grade_regrade_final_grades, like a feedback change or just the timemodified. Based on
4.summary: Skip regrading of categories and calculated items that do not depend on $updated_item
description: grade_regrade_final_grades is used to regrade the whole course gradebook and to regrade the gradebook for a single user, if userid is specified we require $updated_item argument too. Even if $updated_item is specified, we are marking all categories and calculated items as needsupdate, I cant think of any reason to update categories and calculated items that do not depend on the updated item. We have a grade_item::depends_on function, but it is only looking for items that directly depend on them (means that grade items located in a category are not included in the course item grade_item::depends_on()) and we should consider all dependant items. Items are not updated until all their dependencies are final grades, we could check that too.
5.summary: auto_update_weights calls update() even if there is no aggregationcoef2 change
description: As most of the gradebook performance reports are related with full gradebook regrades, Ive created a test course (tool_generator - M size) with around 1000 users and 100 activities to see the basic configuration issues. Ive been changing the gradebook structure and checking which interactions with the database we have to see if there is anything we could improve. New grade category and manual grade items results in around 1000-1500 db reads and 400-700 db writes, I see many stuff and I dont want to mess up with the whole gradebook design nor implement major changes here, but auto_update_weights seems to be calling update() unnecessarily. Ive reduced the number of db writes to half of it with the provided patch. I havent seen any gradeitem modifications to justify an update() call if the aggregatecoef2 value is not changed. As a beneficial side effect this reduces the number of records added to grade history which is also the reason why we have that many insert record calls.
6.summary: Remove unnecessary database writes (updates basically) on full gradebook recalculations
description: While debugging I found out that when we add a new grade_item we are calling update() through set_hidden in all its hierarchy categories even if there are no changes in their visibility, only because if the new grade_item is visible and the category hidden, we should make it visible, and this continues through all the tree up until the course. Many unnecessary update() calls (= cache invalidations) if all the hierarchy is already visible. Changing this may highlight other issues, but if any grade_object has the need to be updated it shouldnt be through set_hidden, I mean that if I change $gi->attr = 12312 and later call set_hidden(false) I should not rely in set_hidden update() call, I should call it separately. Id like opinions on this even I dont fully believe in this change and I think it is very dangerous. But would help as each change in grade_categories, even if we are calling update() to change, notify_cached is being called and grade_categories cache purged. Updating the issues title as set_hidden is only affecting new grade categories and expanding its scope to other write actions.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Users should be able to tag communities, collections, and profiles
description: See
| Solvable | 1.summary: Auto-complete tags
description: If a user starts to type into the tag field on a collection, community, or profile, a drop-down list of similar tags should appear. See attached image for how WordPress does this.
2.summary: Decide on approach to tagging
description: Mapping out resource types: Review Phil Barkers work on resource types: ---- +IMPORTANT: See previous comments thread on GitLab:
3.summary: Interests input in edit profile
description: User should be able to: Add interests from searching those that exist in MoodleNet via an autocomplete input (using react-select?) Add a custom interest by typing its name into a text input
4.summary: Implement tag search (backend)
description: (more info required)
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Users should be able to tag communities, collections, and profiles
description: See
### Response:
1.summary: Auto-complete tags
description: If a user starts to type into the tag field on a collection, community, or profile, a drop-down list of similar tags should appear. See attached image for how WordPress does this.
2.summary: Decide on approach to tagging
description: Mapping out resource types: Review Phil Barkers work on resource types: ---- +IMPORTANT: See previous comments thread on GitLab:
3.summary: Interests input in edit profile
description: User should be able to: Add interests from searching those that exist in MoodleNet via an autocomplete input (using react-select?) Add a custom interest by typing its name into a text input
4.summary: Implement tag search (backend)
description: (more info required)
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Change core code so it follows Moodle coding style
description: We should improve our core code, so it complies with the standard we have set in
| Unsolvable | 1.summary: Many comments that dont confirm to Moodle coding style in /backup/moodle2/restore_stepslib.php
description: If you look in /backup/moodle2/restore_stepslib.php you will see many comments that dont confirm to our coding style. See For example around line 150 there is... // manual grade items store category id in categoryid
2.summary: Coding style problem: $OUTPUT->BOX
description: mod/lesson/locallib.php line 2007 calls BOX() instead of box(): code $result->feedback = $OUTPUT->BOX(get_string("secondpluswrong", "lesson"), feedback); code
3.summary: Coding style in methods in lib/xmldb/
description: Fix coding style for methods in classes under lib/xmldb/: code xmldb_field.php: public function getType() xmldb_field.php: public function getLength() xmldb_field.php: public function getDecimals() xmldb_field.php: public function getNotNull() xmldb_field.php: public function getUnsigned() xmldb_field.php: public function getSequence() xmldb_field.php: public function getDefault() xmldb_field.php: public function setType($type) xmldb_field.php: public function setLength($length) xmldb_field.php: public function setDecimals($decimals) xmldb_field.php: public function setUnsigned($unsigned=true) xmldb_field.php: public function setNotNull($notnull=true) xmldb_field.php: public function setSequence($sequence=true) xmldb_field.php: public function setDefault($default) xmldb_field.php: public function getXMLDBFieldType($type) xmldb_field.php: public function getXMLDBTypeName($type) xmldb_field.php: public function calculateHash($recursive = false) xmldb_field.php: public function xmlOutput() xmldb_field.php: public function setFromADOField($adofield) xmldb_field.php: public function getPHP($includeprevious=true) xmldb_field.php: public function readableInfo() xmldb_field.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_file.php: public function fileExists() xmldb_file.php: public function fileWriteable() xmldb_file.php: public function getStructure() xmldb_file.php: public function validateXMLStructure() xmldb_file.php: public function loadXMLStructure() xmldb_file.php: public function setDTD($path) xmldb_file.php: public function setSchema($path) xmldb_file.php: public function saveXMLFile() xmldb_index.php: public function getUnique() xmldb_index.php: public function setUnique($unique = true) xmldb_index.php: public function setFields($fields) xmldb_index.php: public function getFields() xmldb_index.php: public function setHints($hints) xmldb_index.php: public function getHints() xmldb_index.php: public function calculateHash($recursive = false) xmldb_index.php: public function xmlOutput() xmldb_index.php: public function setFromADOIndex($adoindex) xmldb_index.php: public function getPHP() xmldb_index.php: public function readableInfo() xmldb_index.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_key.php: public function getType() xmldb_key.php: public function setType($type) xmldb_key.php: public function setFields($fields) xmldb_key.php: public function setRefTable($reftable) xmldb_key.php: public function setRefFields($reffields) xmldb_key.php: public function getFields() xmldb_key.php: public function getRefTable() xmldb_key.php: public function getRefFields() xmldb_key.php: public function getXMLDBKeyType($type) xmldb_key.php: public function getXMLDBKeyName($type) xmldb_key.php: public function calculateHash($recursive = false) xmldb_key.php: public function xmlOutput() xmldb_key.php: public function setFromADOKey($adokey) xmldb_key.php: public function getPHP() xmldb_key.php: public function readableInfo() xmldb_object.php: public function isLoaded() xmldb_object.php: public function hasChanged() xmldb_object.php: public function getComment() xmldb_object.php: public function getHash() xmldb_object.php: public function getPrevious() xmldb_object.php: public function getNext() xmldb_object.php: public function getName() xmldb_object.php: public function getError() xmldb_object.php: public function setComment($comment) xmldb_object.php: public function setPrevious($previous) xmldb_object.php: public function setNext($next) xmldb_object.php: public function setHash($hash) xmldb_object.php: public function setLoaded($loaded = true) xmldb_object.php: public function setChanged($changed = true) xmldb_object.php: public function setName($name) xmldb_object.php: public function checkName () xmldb_object.php: public function checkNameValues($arr) xmldb_object.php: public function fixPrevNext(&$arr) xmldb_object.php: public function orderElements($arr) xmldb_object.php: public function findObjectInArray($objectname, $arr) xmldb_object.php: public function readableInfo() xmldb_object.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_structure.php: public function getPath() xmldb_structure.php: public function getVersion() xmldb_structure.php: public function getTable($tablename) xmldb_structure.php: public function findTableInArray($tablename) xmldb_structure.php: public function orderTables() xmldb_structure.php: public function getTables() xmldb_structure.php: public function setVersion($version) xmldb_structure.php: public function addTable($table, $after=null) xmldb_structure.php: public function deleteTable($tablename) xmldb_structure.php: public function setTables($tables) xmldb_structure.php: public function calculateHash($recursive = false) xmldb_structure.php: public function xmlOutput() xmldb_structure.php: public function getTableUses($tablename) xmldb_structure.php: public function getFieldUses($tablename, $fieldname) xmldb_structure.php: public function getKeyUses($tablename, $keyname) xmldb_structure.php: public function getIndexUses($tablename, $indexname) xmldb_structure.php: public function getAllErrors() xmldb_table.php: public function addField($field, $after=null) xmldb_table.php: public function addKey($key, $after=null) xmldb_table.php: public function addIndex($index, $after=null) xmldb_table.php: public function getFields() xmldb_table.php: public function getKeys() xmldb_table.php: public function getIndexes() xmldb_table.php: public function getField($fieldname) xmldb_table.php: public function findFieldInArray($fieldname) xmldb_table.php: public function orderFields() xmldb_table.php: public function getKey($keyname) xmldb_table.php: public function findKeyInArray($keyname) xmldb_table.php: public function orderKeys() xmldb_table.php: public function getIndex($indexname) xmldb_table.php: public function findIndexInArray($indexname) xmldb_table.php: public function orderIndexes() xmldb_table.php: public function setFields($fields) xmldb_table.php: public function setKeys($keys) xmldb_table.php: public function setIndexes($indexes) xmldb_table.php: public function deleteField($fieldname) xmldb_table.php: public function deleteKey($keyname) xmldb_table.php: public function deleteIndex($indexname) xmldb_table.php: public function calculateHash($recursive = false) xmldb_table.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_table.php: public function xmlOutput() xmldb_table.php: public function getAllErrors() code
4.summary: Coding style: $grade_item, $grade_items, $grade_category, $grade_grade, $grade_grades
description: There are 1050 instances of $grade_item in the code. Rename it to $gradeitem as per our coding style. Other are less common: code 1050 $grade_item -> $gradeitem 341 $grade_category -> $gradecategory 210 $grade_grade -> $gradegrade 110 $grade_items -> $gradeitems 65 $grade_grades -> $gradegrades code
5.summary: Coding style: $xmldb_table and $xmldb_field
description: Rename $xmldb_table and $xmldb_field into $xmldbtable and $xmldbfield across the whole core code.
6.summary: Code checker reports at least one empty if block in blog
description: Run code checker with the path "blog" (without the quotes). It will report 3 empty ifs and 1 empty else. Check if they are required. If not, alter the logic to avoid the need for empty code blocks.
7.summary: Blog code has performance todos
description: Grep the blog code for "performance!!!" and you will find a handful of comments like... quote// TODO: performance!!!!quote Either something needs to be fixed or the todos just need to be removed.
8.summary: lots of hardcoded html in /notes
description: If you run the following on the command line... grep -R "echo" ./notes/. You will see lots of hard coded html.
9.summary: Coding style problems in /rating
description: There are currently 159 error(s) and 199 warning(s).
10.summary: /mod/chat/empty.php does not contain any PHP. It is just html.
description: I would suggest renaming it to empty.html. Make sure to grep for redirects to the file.
11.summary: mod/chat is missing vast amounts of phpdocs
description: File level phpdoc blocks, class definition docs and function docs are pretty much entirely absent.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Change core code so it follows Moodle coding style
description: We should improve our core code, so it complies with the standard we have set in
### Response:
1.summary: Many comments that dont confirm to Moodle coding style in /backup/moodle2/restore_stepslib.php
description: If you look in /backup/moodle2/restore_stepslib.php you will see many comments that dont confirm to our coding style. See For example around line 150 there is... // manual grade items store category id in categoryid
2.summary: Coding style problem: $OUTPUT->BOX
description: mod/lesson/locallib.php line 2007 calls BOX() instead of box(): code $result->feedback = $OUTPUT->BOX(get_string("secondpluswrong", "lesson"), feedback); code
3.summary: Coding style in methods in lib/xmldb/
description: Fix coding style for methods in classes under lib/xmldb/: code xmldb_field.php: public function getType() xmldb_field.php: public function getLength() xmldb_field.php: public function getDecimals() xmldb_field.php: public function getNotNull() xmldb_field.php: public function getUnsigned() xmldb_field.php: public function getSequence() xmldb_field.php: public function getDefault() xmldb_field.php: public function setType($type) xmldb_field.php: public function setLength($length) xmldb_field.php: public function setDecimals($decimals) xmldb_field.php: public function setUnsigned($unsigned=true) xmldb_field.php: public function setNotNull($notnull=true) xmldb_field.php: public function setSequence($sequence=true) xmldb_field.php: public function setDefault($default) xmldb_field.php: public function getXMLDBFieldType($type) xmldb_field.php: public function getXMLDBTypeName($type) xmldb_field.php: public function calculateHash($recursive = false) xmldb_field.php: public function xmlOutput() xmldb_field.php: public function setFromADOField($adofield) xmldb_field.php: public function getPHP($includeprevious=true) xmldb_field.php: public function readableInfo() xmldb_field.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_file.php: public function fileExists() xmldb_file.php: public function fileWriteable() xmldb_file.php: public function getStructure() xmldb_file.php: public function validateXMLStructure() xmldb_file.php: public function loadXMLStructure() xmldb_file.php: public function setDTD($path) xmldb_file.php: public function setSchema($path) xmldb_file.php: public function saveXMLFile() xmldb_index.php: public function getUnique() xmldb_index.php: public function setUnique($unique = true) xmldb_index.php: public function setFields($fields) xmldb_index.php: public function getFields() xmldb_index.php: public function setHints($hints) xmldb_index.php: public function getHints() xmldb_index.php: public function calculateHash($recursive = false) xmldb_index.php: public function xmlOutput() xmldb_index.php: public function setFromADOIndex($adoindex) xmldb_index.php: public function getPHP() xmldb_index.php: public function readableInfo() xmldb_index.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_key.php: public function getType() xmldb_key.php: public function setType($type) xmldb_key.php: public function setFields($fields) xmldb_key.php: public function setRefTable($reftable) xmldb_key.php: public function setRefFields($reffields) xmldb_key.php: public function getFields() xmldb_key.php: public function getRefTable() xmldb_key.php: public function getRefFields() xmldb_key.php: public function getXMLDBKeyType($type) xmldb_key.php: public function getXMLDBKeyName($type) xmldb_key.php: public function calculateHash($recursive = false) xmldb_key.php: public function xmlOutput() xmldb_key.php: public function setFromADOKey($adokey) xmldb_key.php: public function getPHP() xmldb_key.php: public function readableInfo() xmldb_object.php: public function isLoaded() xmldb_object.php: public function hasChanged() xmldb_object.php: public function getComment() xmldb_object.php: public function getHash() xmldb_object.php: public function getPrevious() xmldb_object.php: public function getNext() xmldb_object.php: public function getName() xmldb_object.php: public function getError() xmldb_object.php: public function setComment($comment) xmldb_object.php: public function setPrevious($previous) xmldb_object.php: public function setNext($next) xmldb_object.php: public function setHash($hash) xmldb_object.php: public function setLoaded($loaded = true) xmldb_object.php: public function setChanged($changed = true) xmldb_object.php: public function setName($name) xmldb_object.php: public function checkName () xmldb_object.php: public function checkNameValues($arr) xmldb_object.php: public function fixPrevNext(&$arr) xmldb_object.php: public function orderElements($arr) xmldb_object.php: public function findObjectInArray($objectname, $arr) xmldb_object.php: public function readableInfo() xmldb_object.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_structure.php: public function getPath() xmldb_structure.php: public function getVersion() xmldb_structure.php: public function getTable($tablename) xmldb_structure.php: public function findTableInArray($tablename) xmldb_structure.php: public function orderTables() xmldb_structure.php: public function getTables() xmldb_structure.php: public function setVersion($version) xmldb_structure.php: public function addTable($table, $after=null) xmldb_structure.php: public function deleteTable($tablename) xmldb_structure.php: public function setTables($tables) xmldb_structure.php: public function calculateHash($recursive = false) xmldb_structure.php: public function xmlOutput() xmldb_structure.php: public function getTableUses($tablename) xmldb_structure.php: public function getFieldUses($tablename, $fieldname) xmldb_structure.php: public function getKeyUses($tablename, $keyname) xmldb_structure.php: public function getIndexUses($tablename, $indexname) xmldb_structure.php: public function getAllErrors() xmldb_table.php: public function addField($field, $after=null) xmldb_table.php: public function addKey($key, $after=null) xmldb_table.php: public function addIndex($index, $after=null) xmldb_table.php: public function getFields() xmldb_table.php: public function getKeys() xmldb_table.php: public function getIndexes() xmldb_table.php: public function getField($fieldname) xmldb_table.php: public function findFieldInArray($fieldname) xmldb_table.php: public function orderFields() xmldb_table.php: public function getKey($keyname) xmldb_table.php: public function findKeyInArray($keyname) xmldb_table.php: public function orderKeys() xmldb_table.php: public function getIndex($indexname) xmldb_table.php: public function findIndexInArray($indexname) xmldb_table.php: public function orderIndexes() xmldb_table.php: public function setFields($fields) xmldb_table.php: public function setKeys($keys) xmldb_table.php: public function setIndexes($indexes) xmldb_table.php: public function deleteField($fieldname) xmldb_table.php: public function deleteKey($keyname) xmldb_table.php: public function deleteIndex($indexname) xmldb_table.php: public function calculateHash($recursive = false) xmldb_table.php: public function validateDefinition(xmldb_table $xmldb_table=null) xmldb_table.php: public function xmlOutput() xmldb_table.php: public function getAllErrors() code
4.summary: Coding style: $grade_item, $grade_items, $grade_category, $grade_grade, $grade_grades
description: There are 1050 instances of $grade_item in the code. Rename it to $gradeitem as per our coding style. Other are less common: code 1050 $grade_item -> $gradeitem 341 $grade_category -> $gradecategory 210 $grade_grade -> $gradegrade 110 $grade_items -> $gradeitems 65 $grade_grades -> $gradegrades code
5.summary: Coding style: $xmldb_table and $xmldb_field
description: Rename $xmldb_table and $xmldb_field into $xmldbtable and $xmldbfield across the whole core code.
6.summary: Code checker reports at least one empty if block in blog
description: Run code checker with the path "blog" (without the quotes). It will report 3 empty ifs and 1 empty else. Check if they are required. If not, alter the logic to avoid the need for empty code blocks.
7.summary: Blog code has performance todos
description: Grep the blog code for "performance!!!" and you will find a handful of comments like... quote// TODO: performance!!!!quote Either something needs to be fixed or the todos just need to be removed.
8.summary: lots of hardcoded html in /notes
description: If you run the following on the command line... grep -R "echo" ./notes/. You will see lots of hard coded html.
9.summary: Coding style problems in /rating
description: There are currently 159 error(s) and 199 warning(s).
10.summary: /mod/chat/empty.php does not contain any PHP. It is just html.
description: I would suggest renaming it to empty.html. Make sure to grep for redirects to the file.
11.summary: mod/chat is missing vast amounts of phpdocs
description: File level phpdoc blocks, class definition docs and function docs are pretty much entirely absent.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.5 upgrade
description: Moodle 3.5 is scheduled for release on Monday 14 May 2018.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.5
description:
2.summary: Upgrade learn.moodle.net to 3.5
description:
3.summary: Upgrade lang.moodle.org to 3.5
description:
4.summary: Upgrade school.demo.moodle.net to 3.5
description:
5.summary: Upgrade demo.moodle.net to 3.5
description:
6.summary: Upgrade moodle.net to 3.5
description:
7.summary: Upgrade download.moodle.org to 3.5
description:
8.summary: Upgrade dev.moodle.org to 3.5
description:
9.summary: Upgrade gdprdemo.moodle.net to 3.5
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.5 upgrade
description: Moodle 3.5 is scheduled for release on Monday 14 May 2018.
### Response:
1.summary: Upgrade moodle.org to 3.5
description:
2.summary: Upgrade learn.moodle.net to 3.5
description:
3.summary: Upgrade lang.moodle.org to 3.5
description:
4.summary: Upgrade school.demo.moodle.net to 3.5
description:
5.summary: Upgrade demo.moodle.net to 3.5
description:
6.summary: Upgrade moodle.net to 3.5
description:
7.summary: Upgrade download.moodle.org to 3.5
description:
8.summary: Upgrade dev.moodle.org to 3.5
description:
9.summary: Upgrade gdprdemo.moodle.net to 3.5
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Font Awesome follow ups
description: There are still some visual inconsistencies with font awesome that we should collect here and fix
| Unsolvable | 1.summary: Activity modules icons should use font awesome
description: Currenlty activity modules icons look inconsistent to the other icons on the page. Also we use the file type icon when displaying page resource or folder icon when displaying the folder resource inline and they look out of place
2.summary: Changing paragraph styles icon could be better
description: fa-font fa-text-height or fa-header could be better than fa-info for changing paragraph styles in atto.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Font Awesome follow ups
description: There are still some visual inconsistencies with font awesome that we should collect here and fix
### Response:
1.summary: Activity modules icons should use font awesome
description: Currenlty activity modules icons look inconsistent to the other icons on the page. Also we use the file type icon when displaying page resource or folder icon when displaying the folder resource inline and they look out of place
2.summary: Changing paragraph styles icon could be better
description: fa-font fa-text-height or fa-header could be better than fa-info for changing paragraph styles in atto.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Implement the stage 2 tasks from spec
description: This is best described on the spec doc - please read it! Specification: Render library specification Forum discussion: Advisory posts in General developers forum and Theme developers forum Please do not discuss the specification here. We would like all feedback to come through the forums, with everything in one place it will be easier to collate the discussions that go on and to produce the final spec. Note - this is the second epic - designed to capture tasks that should be done at a later date than the initial set of tasks (undetermined).
| Unsolvable | 1.summary: Meta: Update existing documentation
description: A lot is going to change in respect to output in 2.8 via the Render library specification| All of the theme and output docs and tutorials are going to need to be updated. As pages are found that will need to be updated they will be added as subtasks here so that we can accurately track their updating as they go along. Please note: this task should be left until output within Moodle has stabilised again.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Implement the stage 2 tasks from spec
description: This is best described on the spec doc - please read it! Specification: Render library specification Forum discussion: Advisory posts in General developers forum and Theme developers forum Please do not discuss the specification here. We would like all feedback to come through the forums, with everything in one place it will be easier to collate the discussions that go on and to produce the final spec. Note - this is the second epic - designed to capture tasks that should be done at a later date than the initial set of tasks (undetermined).
### Response:
1.summary: Meta: Update existing documentation
description: A lot is going to change in respect to output in 2.8 via the Render library specification| All of the theme and output docs and tutorials are going to need to be updated. As pages are found that will need to be updated they will be added as subtasks here so that we can accurately track their updating as they go along. Please note: this task should be left until output within Moodle has stabilised again.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Onboarding for new iTeam member: Paul Holden
description: This issue will track the progress of Pauls onboarding with the Integration Team. The onboarding follows the iTeam onboarding course| Each section in the course represents an issue in this epic and each assignee will organise the onboarding session with the new iTeam member. The ideal session length would be about 1 hour. If a session will need more time, try to break it down into a series of shorter sessions. See the onboarding script document for Paul| and feel free to write notes in it.
| Unsolvable | 1.summary: Welcome, access and generalities
description: Welcome session with Paul, help him get set up for integration.
2.summary: Integration: purposes, principles, standard messages
description:
3.summary: Integration: process and schedules
description:
4.summary: Integration: Backporting issues and other bits. Rewrite history of integration.git
description:
5.summary: Testing: manual, automatic, handling testing failures, QA testing
description:
6.summary: Releasing: Process, tool. Packaging and releasing
description:
7.summary: Infrastructure: legacy and new, actors (repos ), type of jobs
description:
8.summary: Sub-products: Overview about repositories, tools, responsibilities, resources
description:
9.summary: Security: General process, integration related, actions, timing
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Onboarding for new iTeam member: Paul Holden
description: This issue will track the progress of Pauls onboarding with the Integration Team. The onboarding follows the iTeam onboarding course| Each section in the course represents an issue in this epic and each assignee will organise the onboarding session with the new iTeam member. The ideal session length would be about 1 hour. If a session will need more time, try to break it down into a series of shorter sessions. See the onboarding script document for Paul| and feel free to write notes in it.
### Response:
1.summary: Welcome, access and generalities
description: Welcome session with Paul, help him get set up for integration.
2.summary: Integration: purposes, principles, standard messages
description:
3.summary: Integration: process and schedules
description:
4.summary: Integration: Backporting issues and other bits. Rewrite history of integration.git
description:
5.summary: Testing: manual, automatic, handling testing failures, QA testing
description:
6.summary: Releasing: Process, tool. Packaging and releasing
description:
7.summary: Infrastructure: legacy and new, actors (repos ), type of jobs
description:
8.summary: Sub-products: Overview about repositories, tools, responsibilities, resources
description:
9.summary: Security: General process, integration related, actions, timing
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Add behat tests for message drawer for 3.7
description: has removed the existing behat tests for messaging so they need to be re-written and added back for the new message drawer
| Unsolvable | 1.summary: Add behat test for new message drawer to test admin settings
description: Feature In order to manage the messaging system As an admin I need to be able to enabled/disabled site-wide messaging system Scenarios Enable messaging system
2.summary: Add behat test for new message drawer to manage contacts
description: Feature In order to communicate with fellow users As a user I need to be able to add, decline and remove users Scenarios Add/Request contact send a contact request to someone to add a contact to accept a contact request from someone decline a contact request from someone Remove existing contact View contacts in the "contacts" section (users added after contact request accepted) to remove Decline a contact in the "contact requests" section
3.summary: Add behat test for new UI to manage messaging preferences
description: Privacy Preferences Feature In order to control whether Im contactable As a user I need to be able to update my messaging preferences Scenarios Update settings: My contacts only Update settings: My contacts and anyone in my courses Update settings: Anyone on the site (Admin enable site-level messaging) General Preferences Feature In order to make message editor more usable As a user I need to be able to update my Use enter to send preferences Scenario Update Use enter to send preference Note: Notification preferences will be added in other issue .
4.summary: Add behat test for new message drawer to delete conversation
description: Feature In order to communicate with fellow users As a user I need to be able to delete conversations Scenarios Delete conversations private/stared
5.summary: Add behat test for new message drawer to view contact info
description: Feature In order to view how actions can I do in my contacts As a user I need to view user contact info Scenarios View contact info using the dropdown menu View short contact info by click on his/her name Add/Remove contacts Block/unblock user
6.summary: Add behat test for new message drawer to navigation
description: Feature In order to manage my conversations As a user I need to be able to navigate for messaging drawer Scenarios Navigate to my contacts, favourite conversations, courses and others through collapsable accordion. See all group that I am a part of listed in the messaging interface
7.summary: Add behat test for new message drawer to send messages
description: Feature In order to communicate with fellow users As a user I need to be able to send a message Scenarios To send a message to an existing contact To send a message to a group To send a message to a private conversation To send a message to a starred conversation To view the proper dates on private/group conversations
8.summary: Add behat test for new message drawer to manage Group conversation
description: Feature In order to manage a course group in a course As a user I need to be able to ensure group conversations reflect the memberships of course groups Scenarios View the number of the members of the group View the list of participants (add/remove)
9.summary: Add behat test for new message drawer to search
description: Feature In order to communicate with fellow users As a user I need to be able to search for messages Scenarios Search for a user or a message in either group or private conversation Search for no results
10.summary: Add behat test for new message drawer to unread messages
description: Feature In order to know how many unread messages I have As a user I need to be able to view an unread message Scenarios Show unread messages on the popover Show unread messaged for starred/group/private Clicking/reading a message marks it as read
11.summary: Add behat test for new message drawer to starring private and group conversations
description: Feature In order to manage my most important conversations As a user I need to be able to star and unstar conversations Scenarios Star my most important conversations (private/group) Unstar my most important conversations (private/group)
12.summary: Fix old behat tests affected by messagingallusers setting
description: Based on messagingallusers setting, the way to see users profile behavior is different. We need to change behat tests to test both setting value behavior. user/tests/behat/view_full_profile.feature test had been changed in commit. user/tests/behat/delete_users.feature test had been changed in and commits.
13.summary: Move message Boost theme behat tests to core_message behat tests
description: After some conversations, we decided to create some of the behat tests only for Boost theme and move them again to main core_message behat tests once Clean theme has been removed. The reason to do that is that right now behavior for Clean and Boost themes are not exactly the same. This issue should we finished once Classic theme is added to core to be sure that group messaging behat tests are passing for Classic theme as well, and drawer behavior is the same for both Boost and Classic.
14.summary: Add behat test for new message drawer to self conversations
description: Feature In order to have self-conversations As a user I need to be able to send messages to myself and read them Scenarios Create self-conversation from the profile Create self-conversation from a bulk message
15.summary: Add behat test for new message drawer to delete messages
description: Feature In order to communicate with fellow users As a user I need to be able to delete messages from conversations Scenarios Delete one/multiple messages from private/group/starred conversations
16.summary: Add behat test for new UI to manage messaging notification preferences
description: Feature In order to be notified of messages As a user I need to be able to update my messaging notification preferences Scenario Update notification preferences: Email
17.summary: Add behat test for new message drawer to delete message for all members
description: Feature In order to communicate delete inappropriate messages As a user I need to be able to delete messages for all members in a conversation Scenarios As a teacher delete one/multiple messages for all members from group conversations As an admin delete one/multiple messages from all members private/starred conversations
18.summary: Add behat test for new message drawer to unmute/mute a conversation
description: This functionality was added by .
19.summary: Add behat test for new message drawer to allow teachers to delete messages for all users within their conversations
description: This functionality was added in .
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Add behat tests for message drawer for 3.7
description: has removed the existing behat tests for messaging so they need to be re-written and added back for the new message drawer
### Response:
1.summary: Add behat test for new message drawer to test admin settings
description: Feature In order to manage the messaging system As an admin I need to be able to enabled/disabled site-wide messaging system Scenarios Enable messaging system
2.summary: Add behat test for new message drawer to manage contacts
description: Feature In order to communicate with fellow users As a user I need to be able to add, decline and remove users Scenarios Add/Request contact send a contact request to someone to add a contact to accept a contact request from someone decline a contact request from someone Remove existing contact View contacts in the "contacts" section (users added after contact request accepted) to remove Decline a contact in the "contact requests" section
3.summary: Add behat test for new UI to manage messaging preferences
description: Privacy Preferences Feature In order to control whether Im contactable As a user I need to be able to update my messaging preferences Scenarios Update settings: My contacts only Update settings: My contacts and anyone in my courses Update settings: Anyone on the site (Admin enable site-level messaging) General Preferences Feature In order to make message editor more usable As a user I need to be able to update my Use enter to send preferences Scenario Update Use enter to send preference Note: Notification preferences will be added in other issue .
4.summary: Add behat test for new message drawer to delete conversation
description: Feature In order to communicate with fellow users As a user I need to be able to delete conversations Scenarios Delete conversations private/stared
5.summary: Add behat test for new message drawer to view contact info
description: Feature In order to view how actions can I do in my contacts As a user I need to view user contact info Scenarios View contact info using the dropdown menu View short contact info by click on his/her name Add/Remove contacts Block/unblock user
6.summary: Add behat test for new message drawer to navigation
description: Feature In order to manage my conversations As a user I need to be able to navigate for messaging drawer Scenarios Navigate to my contacts, favourite conversations, courses and others through collapsable accordion. See all group that I am a part of listed in the messaging interface
7.summary: Add behat test for new message drawer to send messages
description: Feature In order to communicate with fellow users As a user I need to be able to send a message Scenarios To send a message to an existing contact To send a message to a group To send a message to a private conversation To send a message to a starred conversation To view the proper dates on private/group conversations
8.summary: Add behat test for new message drawer to manage Group conversation
description: Feature In order to manage a course group in a course As a user I need to be able to ensure group conversations reflect the memberships of course groups Scenarios View the number of the members of the group View the list of participants (add/remove)
9.summary: Add behat test for new message drawer to search
description: Feature In order to communicate with fellow users As a user I need to be able to search for messages Scenarios Search for a user or a message in either group or private conversation Search for no results
10.summary: Add behat test for new message drawer to unread messages
description: Feature In order to know how many unread messages I have As a user I need to be able to view an unread message Scenarios Show unread messages on the popover Show unread messaged for starred/group/private Clicking/reading a message marks it as read
11.summary: Add behat test for new message drawer to starring private and group conversations
description: Feature In order to manage my most important conversations As a user I need to be able to star and unstar conversations Scenarios Star my most important conversations (private/group) Unstar my most important conversations (private/group)
12.summary: Fix old behat tests affected by messagingallusers setting
description: Based on messagingallusers setting, the way to see users profile behavior is different. We need to change behat tests to test both setting value behavior. user/tests/behat/view_full_profile.feature test had been changed in commit. user/tests/behat/delete_users.feature test had been changed in and commits.
13.summary: Move message Boost theme behat tests to core_message behat tests
description: After some conversations, we decided to create some of the behat tests only for Boost theme and move them again to main core_message behat tests once Clean theme has been removed. The reason to do that is that right now behavior for Clean and Boost themes are not exactly the same. This issue should we finished once Classic theme is added to core to be sure that group messaging behat tests are passing for Classic theme as well, and drawer behavior is the same for both Boost and Classic.
14.summary: Add behat test for new message drawer to self conversations
description: Feature In order to have self-conversations As a user I need to be able to send messages to myself and read them Scenarios Create self-conversation from the profile Create self-conversation from a bulk message
15.summary: Add behat test for new message drawer to delete messages
description: Feature In order to communicate with fellow users As a user I need to be able to delete messages from conversations Scenarios Delete one/multiple messages from private/group/starred conversations
16.summary: Add behat test for new UI to manage messaging notification preferences
description: Feature In order to be notified of messages As a user I need to be able to update my messaging notification preferences Scenario Update notification preferences: Email
17.summary: Add behat test for new message drawer to delete message for all members
description: Feature In order to communicate delete inappropriate messages As a user I need to be able to delete messages for all members in a conversation Scenarios As a teacher delete one/multiple messages for all members from group conversations As an admin delete one/multiple messages from all members private/starred conversations
18.summary: Add behat test for new message drawer to unmute/mute a conversation
description: This functionality was added by .
19.summary: Add behat test for new message drawer to allow teachers to delete messages for all users within their conversations
description: This functionality was added in .
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Analytics engine follow-up issues for Moodle 3.4
description: This epic is a continuation of which only included issues that we considered required before sending the analytics API to integration.
| Unsolvable | 1.summary: Create an analytics indicator for "completion enabled".
description: Completion enabled / disabled will have a strong effect on any of the "completion" indicators. The value of this indicator would be 0 when completion is disabled for the course and 1 when it is enabled.
2.summary: Admin page to list all analysables a model can use and all analysables a model cant use
description: To put the reader in context: Would be useful that admins have a view of all possible analysable elements xxxx model could use and how many of those will actually end up using. May be easier to explain this using students at risk prediction case. If enrolments and / or course start and end dates are not properly set the course can not be used for training. The target is the one that will discard elements for training and for prediction. This is about calling each of the site analysables (courses in students at risk prediction as the analysable in use is student enrolments) is_valid_analysable method both for training and for prediction. During todays analytics meeting we expanded this a bit. The idea is to add an option (new method returning true/false) to targets that, if enabled, would generate an insight for the users with moodle/analytics:listinsights capability on the analysable context about what should they do if they want to get xxx model predictions.
3.summary: Proper indicator, targets and time splitting methods names and descriptions
description: We need understandable names and descriptions for each of the system indicators along with a note about how are they calculated. Pinging emdalton1 in case you are interested on looking at this.
4.summary: Ability to hide predictions (flag them as not useful or acknowledged / fixed)
description: The insights page lists predictions.Targets define suggested actions teachers can perform over these predictions. A new action to flag the prediction as not useful would help us refine the model predictions. This would require a new default action for targets using insights and a new field in tool_inspire_predictions to store the teacher action. We can start by skipping these predictions from being used for training but not useful predictions will keep coming up as the model is trained with these samples. We can go further than this and force future predictions (that come from the machine learning backends) pass through another model (trained with the prediction calculations + teachers input) and filter out predictions that match the pattern of previous predictions that teachers marked as not useful. This would require some changes in the predictions processor API. We agreed to work on refining predictions with teachers input during latest analytics meeting (May 2017)
5.summary: Add course information indicators
description: If we want models to adapt to different courses we need some course indicators so the machine learning algorithm is smart enough to differentiate the type of course they deal with. Some ideas + notes taken from discussions with others: - Course typology (new course setting/s) - Number of teachers in a course - Courses teachers activity - Course potential cognitive depth - Course potential social breath - Course using resources or dynamic activities / activities that encourage interpersonal relations instead - Messages between students in the same course - Indicators to measure the course difficulty (based on the overall course completion rate maybe?) - Is completion enabled
6.summary: Add a report showing which analysable elements are not valid for each of the system prediction model
description: This new report for admins / managers / researchers would show, for each prediction model in the system, which analysable elements (what is an analysable element depends on the model, it can be a course, a user...) can be used by the prediction model and which of them can not. May be easier to explain this using students at risk prediction case. If enrolments and / or course start and end dates are not properly set the course can not be used for training. The target is the one that will discard elements for training and for prediction. This is about calling each of the site analysables (courses in students at risk prediction as the analysable in use is student enrolments) is_valid_analysable method both for training and for prediction. During todays analytics meeting we expanded this a bit. The idea is to add an option (new method returning true/false) to targets that, if enabled, would generate an insight for the users with moodle/analytics:listinsights capability on the analysable context about what should they do if they want to get xxx model predictions. This could use targets is_valid_analysable and is_valid_sample methods
7.summary: Improve course_dropout targets course start and course end date validations
description: If we think that the course start and end dates are not correct we should not use that course for training. We should update course_dropout::is_valid_analysable according to it. Related to and .
8.summary: Expand documentation with examples and screenshots
description: The current documentation is available in It is just a brief description of the components involved in the API. We need to rename the page to remove project inspire references, we also need to update inspire references to analytics API
9.summary: Calculate indicators way before the target is available
description: We now calculate all training data once the target is available. This can be a problem for time-based models because things change over time (activities that were visible to students may not be visible now). It would be more accurate to calculate indicators just after each of the models time ranges finishes. This would be an important improvement for models like prediction of students at risk of dropping out of courses because most of the community of inquiry indicators are based on the available activities for the student, we now guess the activities that were available to the student. We could store those calculations in the database and attach them to the dataset once the target can be calculated. If the dates that define the range change we should throw this calculations to the garbage although we should also warn users about the consequences of changing dates.
10.summary: Show the prediction date
description: Each prediction should contain information about when the prediction was done and also the time range that was considered to perform that prediction. Showing the prediction time should be easy, (we have a analytics_predictions timecreated column) the not that straight forward part is to show the time ranges that were considered to make this prediction. There is a rangeindex field that (in theory) could be used to extract the period of time of the logs we looked at to make that prediction but we should avoid it because analysables (lets say course, it is easy to imagine it in our mind) start and end times (course start date and course end date) can change along time (courses can be reused...) so we need to add 2 new fields to analytics_predictions table, start time and end time, so they are set when we get the prediction. At the moment we are using rangeindex to select the most recent prediction for each element (e.g. if we get predictions for a student after 3 months and another one after 6 months the 6 months one is displayed) we could also do it with analytics_predictions timecreated field though. I see positive and negative aspects for both removing rangeindex (there is just 1 prediction for each sampleid and rangeindex and is cleaner to sort by a incremental number than by a timestamp) and keeping it (it seems kind of redundant). I vote for keeping rangeindex as we dont need to keep these records synced and it is just a few digits int on the other hand joining with timestamps is not a good idea in general (see core_analytics\model::get_predictions) Feel free to contact UX team about where to fit this information, for what Ive talked with Barbara what seems to make more sense is a new column in the insights list table.
11.summary: Allow multiple predictions of the same time range
description: During prediction we filter out time ranges that have already been used for prediction (filter_out_prediction_ranges method) This is a problem for courses that are reset once the course is finished and used again with sets of new students because new sets of students will not get predictions. Analysers process_time_splitting method needs to be updated so we keep analysing samples that were not previously analysed. This means that the list of samples will not be the same for all ranges.
12.summary: Review tool_analytics and report_insights UI / UX
description: tool_models and report_insights UI has not passed UX team validation. I am pretty sure you will have some ideas about how to improve the current UI (acorado, barbararamiro)
13.summary: Allow targets, indicators and time splitting methods to set a description
description: Even during development I already feel the need to explain some internal details of a target, this is even more important after as the developer hardcodes indicators and the time splitting method. A new get_description method should be added as well as a popover or something to display the targets description.
14.summary: Guarantee 3rd parties can add machine learning backends for regression
description: The current interface names are ok and they match what they do according to what we currently support. if we forecast future new features we will add to analytics API we should be able to update the current method names to something more specific. Previous issue name: Modify interfaces names so we dont break BC when we add new features in future releases
15.summary: Review how dataset versioning works and add more metadata if required
description: People may be interested in doing custom stuff using their own machine learning backends, using multiple sites datasets together... We must ensure that we provide enough metadata for them to do it properly.
16.summary: Analytics language strings review
description: Unfortunately Im still not horribly good at EN :) We will need screenshots here showing when the new language strings are displayed
17.summary: Add a new site setting to disable web interface "Evaluation" and "Get predictions" actions
description: We already have a note in the web interface warning that these 2 processes can take a long time to complete. These 2 actions are available for manager users. A step further would be to add a site setting (for admins) so they can disable these 2 processes in the web interface, their execution would be limited to cron and CLI scripts.
18.summary: Add a button to export models training data
description: As discussed with Damyon, Tom and Elizabeth, we are not yet ready to work on ensemble models and we will not have time to release moodle with trained built-in models. Data gathering is not going awesomely well either so it would be nice to find a mid-point to allow people to easily share training data with us. The proposal is to add a new action to non-static models to export all their training data into a file. This file would merge all training files that were generated during the different cron runs into one and stream it to the admin / manager web browser for download. We will later need to establish a manual protocol to allow people to upload these files to Moodle HQ. These files should be very big as they will only contains numeric values.
19.summary: Limit the amount of analysables that are processed during one train() and predict() execution
description: At the moment train() and predict() process all site contents without any limit, would be good to limit the amount of analysable elements that can be processed in 1 train() or predict() execution. We can limit by the number of analysable elements or by time spent on each model. Limiting it by analysable may not always help because it is completely up to the model, the site itself is an analysable element. I would opt for a "Time limit per model" and I would allow admins to configure the time using a new site setting, something similar although more complex has recently been integrated for search. During training and prediction what we do is to process analysables one by one and build a dataset file for each of them; at the end we merge them all together and train / get predictions using the machine learning backend. Using the get_analysables method proposed in we could iterate through the available analysables in a private base class method and setup the timer there checking the time spent since the start of get_analysable_data after each process_analysable call. Some extra comments: It is an approximate limit not exact because we would wait until the analysable is fully processed and we would later train / get predictions, which also takes some time. This should be explained in the setting description There is still 1 case where this time limit will not be that effective, prediction models using the site as a single analysable element. I already commented in the official docs page (around that models iterating through tons of samples at site level should be careful and pay attention to memory usage I think that is enough This time limits should not be applied for evaluation processes ($this->optionsevaluation in the analyser), as we need the whole site dataset This issue and are related because they share the new get_analysables public method need. This new API method would also need an abstract get_analysables in the base class, it would be implemented by sitewide and by by_course analysers; for sitewide analyser would be a 1 array item with the site and for by_course just rename get_courses to get_analysables so people extending those analysers would not need to implement it.
20.summary: Reduce the amout of db queries during execution of community of inquiry indicators
description: While trying to improve analytics engine performance Ive noticed that we could improve some stuff. Using the most simple training scheme (just 1 course with 1 student and 1 activity) Ive seen that there are around 100 db queries: Around the 30 of them are queries to mdl_grade_items that come from grade_get_grades call, this seems a lot to me and we need to inspect what this function is doing to see if it makes sense that 1 course with 1 activity generates 30 calls to the same table (which if I am not missing something should contain 2 items in that course) code line 220 of /lib/grade/grade_object.php: call to moodle_database->get_recordset_select() line 160 of /lib/grade/grade_object.php: call to grade_object::fetch_all_helper() line 354 of /lib/grade/grade_item.php: call to grade_object::fetch_helper() line 1125 of /lib/grade/grade_item.php: call to grade_item::fetch() line 437 of /lib/gradelib.php: call to grade_item::fetch_course_item() line 496 of /analytics/classes/course.php: call to grade_get_grades() line 400 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\course->get_student_grades() line 496 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\local\indicator\community_of_inquiry_activity->get_student_activities() line 641 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\local\indicator\community_of_inquiry_activity->cognitive_calculate_sample() line 149 of /analytics/classes/local/indicator/base.php: call to core_analytics\local\indicator\community_of_inquiry_activity->calculate_sample() line 249 of /analytics/classes/local/time_splitting/base.php: call to core_analytics\local\indicator\base->calculate() code Around a 15 from core_analytics\course instantiations (they fetch role archetypes and role ids) This should be easily cached. code ++ SELECT FROM m_role WHERE archetype = $1 ORDER BY sortorder ASC ++ line 432 of /lib/dml/moodle_database.php: call to debugging() line 228 of /lib/dml/pgsql_native_moodle_database.php: call to moodle_database->query_start() line 774 of /lib/dml/pgsql_native_moodle_database.php: call to pgsql_native_moodle_database->query_start() line 1400 of /lib/dml/moodle_database.php: call to pgsql_native_moodle_database->get_records_sql() line 1351 of /lib/dml/moodle_database.php: call to moodle_database->get_records_select() line 2664 of /lib/accesslib.php: call to moodle_database->get_records() line 146 of /analytics/classes/course.php: call to get_archetype_roles() line 167 of /analytics/classes/course.php: call to core_analytics\course->__construct() line 57 of /analytics/classes/local/analyser/by_course.php: call to core_analytics\course::instance() line 79 of /analytics/classes/local/analyser/by_course.php: call to core_analytics\local\analyser\by_course->get_courses() line 187 of /analytics/classes/local/analyser/base.php: call to core_analytics\local\analyser\by_course->get_analysable_data() line 589 of /analytics/classes/model.php: call to core_analytics\local\analyser\base->get_labelled_data() line 73 of /admin/tool/analytics/classes/task/train_models.php: call to core_analytics\model->train() line 146 of /admin/tool/task/cli/schedule_task.php: call to tool_analytics\task\train_models->execute() code Around the 22 of the calls deal with mdl_files, they creates directories, files... This should be ok and the percent shouldnt be that high when under normal circumstances because there is 1 set of db operations (maybe 2 or 3 db interactions) per analysable so it is acceptable IMO and Im not sure if we could do much anyway Around a 15 of the calls read from the standard logstore, which is also ok We should be able to reduce a lot the amount of db reads to grade_items and roles stuff (also important that will reduce the amount of courses we keep in memory and the amount of roles tables db reads at the same time)
21.summary: Strengthen "Students at risk of dropping out" requirements to accept courses and student enrolments
description: course_dropout target should change is_valid_sample definition to exclude user_enrolments with $ue->timeend get_start() tip: retrieve() can be used to retrieve the sample user_enrolment data. Ive updated the issues name, the original one was "Students at risk of dropping out should ignore enrolments which timeend is less than the course start" Some sites are reusing courses without removing previous users, these users would be used for training and would get predictions if we dont exclude them. It is not a massive problem because people dont usually access previous years material, and even if they do their calculations would be close to the lower score which should lead to drop out predictions.
22.summary: Fill in the content for help strings
description: We added help strings in which were intentionally left blank. They require translating.
23.summary: Find a better place for Analytics settings and Analytic models
description: It currently lives under "Appearance".
24.summary: Add missing foreign keys to analytics tables
description: From Eloy - Important note: While looking to the database model, trying to understand samples and friends... I found a good number of columns within the analytics code that are missing foreign key declarations. Basically EVERY column pointing to another table (modelid, sampleid, contextid, fileid...) MUST HAVE a foreign key pointing to the the master table (models, samples, contexts, files...). Internally that means that USEFUL INDEXES will be created and well have a BETTER DEFINED MODEL, no matter we dont create the FKs yet.
25.summary: Complete built-in models with extra indicators
description: This is another good indicator that would add some context to community of inquiry indicators.
26.summary: Add a var for path to python
description: mlbackend_python uses python from command line, we should allow people to configure the path to the executable.
27.summary: Ignore samples with all indicator calculations = null
description: A samples with all indicator calculations with value null is not worth using for training nor prediction because it will train nothing and will get random predictions.
28.summary: Add model actions to clear models predictions
description: delete and clear options already exist in core_analytics\model, would be nice to expose these options in the UI (admin/tool/analytics/index.php), it would require a new action in admin/tool/analytics/model.php.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Analytics engine follow-up issues for Moodle 3.4
description: This epic is a continuation of which only included issues that we considered required before sending the analytics API to integration.
### Response:
1.summary: Create an analytics indicator for "completion enabled".
description: Completion enabled / disabled will have a strong effect on any of the "completion" indicators. The value of this indicator would be 0 when completion is disabled for the course and 1 when it is enabled.
2.summary: Admin page to list all analysables a model can use and all analysables a model cant use
description: To put the reader in context: Would be useful that admins have a view of all possible analysable elements xxxx model could use and how many of those will actually end up using. May be easier to explain this using students at risk prediction case. If enrolments and / or course start and end dates are not properly set the course can not be used for training. The target is the one that will discard elements for training and for prediction. This is about calling each of the site analysables (courses in students at risk prediction as the analysable in use is student enrolments) is_valid_analysable method both for training and for prediction. During todays analytics meeting we expanded this a bit. The idea is to add an option (new method returning true/false) to targets that, if enabled, would generate an insight for the users with moodle/analytics:listinsights capability on the analysable context about what should they do if they want to get xxx model predictions.
3.summary: Proper indicator, targets and time splitting methods names and descriptions
description: We need understandable names and descriptions for each of the system indicators along with a note about how are they calculated. Pinging emdalton1 in case you are interested on looking at this.
4.summary: Ability to hide predictions (flag them as not useful or acknowledged / fixed)
description: The insights page lists predictions.Targets define suggested actions teachers can perform over these predictions. A new action to flag the prediction as not useful would help us refine the model predictions. This would require a new default action for targets using insights and a new field in tool_inspire_predictions to store the teacher action. We can start by skipping these predictions from being used for training but not useful predictions will keep coming up as the model is trained with these samples. We can go further than this and force future predictions (that come from the machine learning backends) pass through another model (trained with the prediction calculations + teachers input) and filter out predictions that match the pattern of previous predictions that teachers marked as not useful. This would require some changes in the predictions processor API. We agreed to work on refining predictions with teachers input during latest analytics meeting (May 2017)
5.summary: Add course information indicators
description: If we want models to adapt to different courses we need some course indicators so the machine learning algorithm is smart enough to differentiate the type of course they deal with. Some ideas + notes taken from discussions with others: - Course typology (new course setting/s) - Number of teachers in a course - Courses teachers activity - Course potential cognitive depth - Course potential social breath - Course using resources or dynamic activities / activities that encourage interpersonal relations instead - Messages between students in the same course - Indicators to measure the course difficulty (based on the overall course completion rate maybe?) - Is completion enabled
6.summary: Add a report showing which analysable elements are not valid for each of the system prediction model
description: This new report for admins / managers / researchers would show, for each prediction model in the system, which analysable elements (what is an analysable element depends on the model, it can be a course, a user...) can be used by the prediction model and which of them can not. May be easier to explain this using students at risk prediction case. If enrolments and / or course start and end dates are not properly set the course can not be used for training. The target is the one that will discard elements for training and for prediction. This is about calling each of the site analysables (courses in students at risk prediction as the analysable in use is student enrolments) is_valid_analysable method both for training and for prediction. During todays analytics meeting we expanded this a bit. The idea is to add an option (new method returning true/false) to targets that, if enabled, would generate an insight for the users with moodle/analytics:listinsights capability on the analysable context about what should they do if they want to get xxx model predictions. This could use targets is_valid_analysable and is_valid_sample methods
7.summary: Improve course_dropout targets course start and course end date validations
description: If we think that the course start and end dates are not correct we should not use that course for training. We should update course_dropout::is_valid_analysable according to it. Related to and .
8.summary: Expand documentation with examples and screenshots
description: The current documentation is available in It is just a brief description of the components involved in the API. We need to rename the page to remove project inspire references, we also need to update inspire references to analytics API
9.summary: Calculate indicators way before the target is available
description: We now calculate all training data once the target is available. This can be a problem for time-based models because things change over time (activities that were visible to students may not be visible now). It would be more accurate to calculate indicators just after each of the models time ranges finishes. This would be an important improvement for models like prediction of students at risk of dropping out of courses because most of the community of inquiry indicators are based on the available activities for the student, we now guess the activities that were available to the student. We could store those calculations in the database and attach them to the dataset once the target can be calculated. If the dates that define the range change we should throw this calculations to the garbage although we should also warn users about the consequences of changing dates.
10.summary: Show the prediction date
description: Each prediction should contain information about when the prediction was done and also the time range that was considered to perform that prediction. Showing the prediction time should be easy, (we have a analytics_predictions timecreated column) the not that straight forward part is to show the time ranges that were considered to make this prediction. There is a rangeindex field that (in theory) could be used to extract the period of time of the logs we looked at to make that prediction but we should avoid it because analysables (lets say course, it is easy to imagine it in our mind) start and end times (course start date and course end date) can change along time (courses can be reused...) so we need to add 2 new fields to analytics_predictions table, start time and end time, so they are set when we get the prediction. At the moment we are using rangeindex to select the most recent prediction for each element (e.g. if we get predictions for a student after 3 months and another one after 6 months the 6 months one is displayed) we could also do it with analytics_predictions timecreated field though. I see positive and negative aspects for both removing rangeindex (there is just 1 prediction for each sampleid and rangeindex and is cleaner to sort by a incremental number than by a timestamp) and keeping it (it seems kind of redundant). I vote for keeping rangeindex as we dont need to keep these records synced and it is just a few digits int on the other hand joining with timestamps is not a good idea in general (see core_analytics\model::get_predictions) Feel free to contact UX team about where to fit this information, for what Ive talked with Barbara what seems to make more sense is a new column in the insights list table.
11.summary: Allow multiple predictions of the same time range
description: During prediction we filter out time ranges that have already been used for prediction (filter_out_prediction_ranges method) This is a problem for courses that are reset once the course is finished and used again with sets of new students because new sets of students will not get predictions. Analysers process_time_splitting method needs to be updated so we keep analysing samples that were not previously analysed. This means that the list of samples will not be the same for all ranges.
12.summary: Review tool_analytics and report_insights UI / UX
description: tool_models and report_insights UI has not passed UX team validation. I am pretty sure you will have some ideas about how to improve the current UI (acorado, barbararamiro)
13.summary: Allow targets, indicators and time splitting methods to set a description
description: Even during development I already feel the need to explain some internal details of a target, this is even more important after as the developer hardcodes indicators and the time splitting method. A new get_description method should be added as well as a popover or something to display the targets description.
14.summary: Guarantee 3rd parties can add machine learning backends for regression
description: The current interface names are ok and they match what they do according to what we currently support. if we forecast future new features we will add to analytics API we should be able to update the current method names to something more specific. Previous issue name: Modify interfaces names so we dont break BC when we add new features in future releases
15.summary: Review how dataset versioning works and add more metadata if required
description: People may be interested in doing custom stuff using their own machine learning backends, using multiple sites datasets together... We must ensure that we provide enough metadata for them to do it properly.
16.summary: Analytics language strings review
description: Unfortunately Im still not horribly good at EN :) We will need screenshots here showing when the new language strings are displayed
17.summary: Add a new site setting to disable web interface "Evaluation" and "Get predictions" actions
description: We already have a note in the web interface warning that these 2 processes can take a long time to complete. These 2 actions are available for manager users. A step further would be to add a site setting (for admins) so they can disable these 2 processes in the web interface, their execution would be limited to cron and CLI scripts.
18.summary: Add a button to export models training data
description: As discussed with Damyon, Tom and Elizabeth, we are not yet ready to work on ensemble models and we will not have time to release moodle with trained built-in models. Data gathering is not going awesomely well either so it would be nice to find a mid-point to allow people to easily share training data with us. The proposal is to add a new action to non-static models to export all their training data into a file. This file would merge all training files that were generated during the different cron runs into one and stream it to the admin / manager web browser for download. We will later need to establish a manual protocol to allow people to upload these files to Moodle HQ. These files should be very big as they will only contains numeric values.
19.summary: Limit the amount of analysables that are processed during one train() and predict() execution
description: At the moment train() and predict() process all site contents without any limit, would be good to limit the amount of analysable elements that can be processed in 1 train() or predict() execution. We can limit by the number of analysable elements or by time spent on each model. Limiting it by analysable may not always help because it is completely up to the model, the site itself is an analysable element. I would opt for a "Time limit per model" and I would allow admins to configure the time using a new site setting, something similar although more complex has recently been integrated for search. During training and prediction what we do is to process analysables one by one and build a dataset file for each of them; at the end we merge them all together and train / get predictions using the machine learning backend. Using the get_analysables method proposed in we could iterate through the available analysables in a private base class method and setup the timer there checking the time spent since the start of get_analysable_data after each process_analysable call. Some extra comments: It is an approximate limit not exact because we would wait until the analysable is fully processed and we would later train / get predictions, which also takes some time. This should be explained in the setting description There is still 1 case where this time limit will not be that effective, prediction models using the site as a single analysable element. I already commented in the official docs page (around that models iterating through tons of samples at site level should be careful and pay attention to memory usage I think that is enough This time limits should not be applied for evaluation processes ($this->optionsevaluation in the analyser), as we need the whole site dataset This issue and are related because they share the new get_analysables public method need. This new API method would also need an abstract get_analysables in the base class, it would be implemented by sitewide and by by_course analysers; for sitewide analyser would be a 1 array item with the site and for by_course just rename get_courses to get_analysables so people extending those analysers would not need to implement it.
20.summary: Reduce the amout of db queries during execution of community of inquiry indicators
description: While trying to improve analytics engine performance Ive noticed that we could improve some stuff. Using the most simple training scheme (just 1 course with 1 student and 1 activity) Ive seen that there are around 100 db queries: Around the 30 of them are queries to mdl_grade_items that come from grade_get_grades call, this seems a lot to me and we need to inspect what this function is doing to see if it makes sense that 1 course with 1 activity generates 30 calls to the same table (which if I am not missing something should contain 2 items in that course) code line 220 of /lib/grade/grade_object.php: call to moodle_database->get_recordset_select() line 160 of /lib/grade/grade_object.php: call to grade_object::fetch_all_helper() line 354 of /lib/grade/grade_item.php: call to grade_object::fetch_helper() line 1125 of /lib/grade/grade_item.php: call to grade_item::fetch() line 437 of /lib/gradelib.php: call to grade_item::fetch_course_item() line 496 of /analytics/classes/course.php: call to grade_get_grades() line 400 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\course->get_student_grades() line 496 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\local\indicator\community_of_inquiry_activity->get_student_activities() line 641 of /analytics/classes/local/indicator/community_of_inquiry_activity.php: call to core_analytics\local\indicator\community_of_inquiry_activity->cognitive_calculate_sample() line 149 of /analytics/classes/local/indicator/base.php: call to core_analytics\local\indicator\community_of_inquiry_activity->calculate_sample() line 249 of /analytics/classes/local/time_splitting/base.php: call to core_analytics\local\indicator\base->calculate() code Around a 15 from core_analytics\course instantiations (they fetch role archetypes and role ids) This should be easily cached. code ++ SELECT FROM m_role WHERE archetype = $1 ORDER BY sortorder ASC ++ line 432 of /lib/dml/moodle_database.php: call to debugging() line 228 of /lib/dml/pgsql_native_moodle_database.php: call to moodle_database->query_start() line 774 of /lib/dml/pgsql_native_moodle_database.php: call to pgsql_native_moodle_database->query_start() line 1400 of /lib/dml/moodle_database.php: call to pgsql_native_moodle_database->get_records_sql() line 1351 of /lib/dml/moodle_database.php: call to moodle_database->get_records_select() line 2664 of /lib/accesslib.php: call to moodle_database->get_records() line 146 of /analytics/classes/course.php: call to get_archetype_roles() line 167 of /analytics/classes/course.php: call to core_analytics\course->__construct() line 57 of /analytics/classes/local/analyser/by_course.php: call to core_analytics\course::instance() line 79 of /analytics/classes/local/analyser/by_course.php: call to core_analytics\local\analyser\by_course->get_courses() line 187 of /analytics/classes/local/analyser/base.php: call to core_analytics\local\analyser\by_course->get_analysable_data() line 589 of /analytics/classes/model.php: call to core_analytics\local\analyser\base->get_labelled_data() line 73 of /admin/tool/analytics/classes/task/train_models.php: call to core_analytics\model->train() line 146 of /admin/tool/task/cli/schedule_task.php: call to tool_analytics\task\train_models->execute() code Around the 22 of the calls deal with mdl_files, they creates directories, files... This should be ok and the percent shouldnt be that high when under normal circumstances because there is 1 set of db operations (maybe 2 or 3 db interactions) per analysable so it is acceptable IMO and Im not sure if we could do much anyway Around a 15 of the calls read from the standard logstore, which is also ok We should be able to reduce a lot the amount of db reads to grade_items and roles stuff (also important that will reduce the amount of courses we keep in memory and the amount of roles tables db reads at the same time)
21.summary: Strengthen "Students at risk of dropping out" requirements to accept courses and student enrolments
description: course_dropout target should change is_valid_sample definition to exclude user_enrolments with $ue->timeend get_start() tip: retrieve() can be used to retrieve the sample user_enrolment data. Ive updated the issues name, the original one was "Students at risk of dropping out should ignore enrolments which timeend is less than the course start" Some sites are reusing courses without removing previous users, these users would be used for training and would get predictions if we dont exclude them. It is not a massive problem because people dont usually access previous years material, and even if they do their calculations would be close to the lower score which should lead to drop out predictions.
22.summary: Fill in the content for help strings
description: We added help strings in which were intentionally left blank. They require translating.
23.summary: Find a better place for Analytics settings and Analytic models
description: It currently lives under "Appearance".
24.summary: Add missing foreign keys to analytics tables
description: From Eloy - Important note: While looking to the database model, trying to understand samples and friends... I found a good number of columns within the analytics code that are missing foreign key declarations. Basically EVERY column pointing to another table (modelid, sampleid, contextid, fileid...) MUST HAVE a foreign key pointing to the the master table (models, samples, contexts, files...). Internally that means that USEFUL INDEXES will be created and well have a BETTER DEFINED MODEL, no matter we dont create the FKs yet.
25.summary: Complete built-in models with extra indicators
description: This is another good indicator that would add some context to community of inquiry indicators.
26.summary: Add a var for path to python
description: mlbackend_python uses python from command line, we should allow people to configure the path to the executable.
27.summary: Ignore samples with all indicator calculations = null
description: A samples with all indicator calculations with value null is not worth using for training nor prediction because it will train nothing and will get random predictions.
28.summary: Add model actions to clear models predictions
description: delete and clear options already exist in core_analytics\model, would be nice to expose these options in the UI (admin/tool/analytics/index.php), it would require a new action in admin/tool/analytics/model.php.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Create forum grading interface
description: This is an epic to capture all of the relevant changes to support use of a Unified Grading Interface in the Forum. This issue duplicates a number of other issues but serves as a clean place for the purposes of project development.
| Solvable | 1.summary: Add rubric grading modal
description: Add a modal to show the full rubric
2.summary: Add configuration to show grading options in the Forum settings
description: Given I add a new forum And I press "Edit settings" Then I should be able to apply a rubric I believe we need to: define the FEATURE define a grading function "forum_grading_areas_list" There may be other things to do also. I think that we may want to consider having _multiple_ grading items. The gradebook supports having multiple grades for a single activity. We may want to consider having items for: forum (grade for all posts in a forum) discussion (aggregate of all graded discussions) post (aggregate of all graded posts) ratings I suspect well need to look at forum, and ratings initially and we may no need to do anything initially, but have to consider it now for a later point.
3.summary: Display grading form in the grading panel
description: Display the grading form in within the grading panel for the current student/content . How it works in Assignment Assignment grading currently does: code - lib.php::mod_assign_output_fragment_gradingpanel() -- locallib::view() --- locallib::view_single_grading_panel ---- gradeform.php::mod_assign_grade_form::definition() ----- locallib::add_grade_form_elements() ------ mod/form/grading.php::toHtml() return $this->get_gradinginstance()->render_grading_element($PAGE, $this); code That comes from grade/grading/form/type/lib.php::render_grading_element() And that calls a renderer function to do loads of things. .Recommendations I dont think that we shuld use the fragments API to do this, at least initially. It doesnt fit in well with what were doing here more generally. Therefore I think we need to update the existing grading options to support a new UI. We _may_ be able to replace the existing rendering with that, but we shouldnt do it in this issue. Create new mustache templates in grade/grading/form/type/templates Replace the existing JS with a new ES6/AMD module called from the template and using uniqid (should be trivial) Create a new renderable for each of the advanced grading forms in /path/classes/output/grading_panel_renderable.php Implement an export_for_template(renderer_base $output) in there Constructor to take finalised values Create an instance of the renderable in a new function in lib.php, or better still in a new class in grade/grading/form/type/classes/gradingpanel.php or similar. That function should return the instance of the renderable. Create a new WS to call the new function/class method. That will then call export_for_template, then return the result. When it comes to saving grades in the grading panel we call the named webservice for each grading form type: gradingform_rubric_save_grades_for_user_in_cmid($user, $cmid, $gradeoptions); or similar That should return the same values (along with a success/fail) Create a generic grade one for simple direct grading We also need to either: limit the list of advanced grading types in the modgrade form field where we choose them from; or ??? When setting up the JS we can do it similar to user selector, except that we have curried fns to: fetch the name of the template to use during render fetch the current data (curried which already provides cmid) and takes just user save the data in the form right now (curried which already provides cmid) and takes user and data in form Theoretically it should be the Forum which provides the curried functions, but theyre also kinda the property of the Grading API so we need to work out how best to do that longer term. . Scope Do not do eveything that the current stuff does. Dont handle all of the modes (especially edit). We should break out marking an editing anyway. Keep everything as basic as possible. . Configuration containing list of grading mechanisms: Advanced type: Simple direct (not an advanced) Type (for Simple direct only) Scale Point Marking guide Rubric The Scale/Point are shown when using the other advanced types, but are not editable.
4.summary: Add fullscreen layout
description: Switch to using a full-screen layout
5.summary: Add parent post snippet
description: When grading a post which is a reply, show the first n characters of the previous post in order to give context to the discussion being graded.
6.summary: Add a button to display the entire discussion for a post being graded
description: Contextual information is important. We should provide a mechanism to view the entire discussion for the content being graded.
7.summary: Add "breadcrumb" to top corner of grading window
description: Add the breadcrumb region to the grading window to help identify which activity is being graded.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Create forum grading interface
description: This is an epic to capture all of the relevant changes to support use of a Unified Grading Interface in the Forum. This issue duplicates a number of other issues but serves as a clean place for the purposes of project development.
### Response:
1.summary: Add rubric grading modal
description: Add a modal to show the full rubric
2.summary: Add configuration to show grading options in the Forum settings
description: Given I add a new forum And I press "Edit settings" Then I should be able to apply a rubric I believe we need to: define the FEATURE define a grading function "forum_grading_areas_list" There may be other things to do also. I think that we may want to consider having _multiple_ grading items. The gradebook supports having multiple grades for a single activity. We may want to consider having items for: forum (grade for all posts in a forum) discussion (aggregate of all graded discussions) post (aggregate of all graded posts) ratings I suspect well need to look at forum, and ratings initially and we may no need to do anything initially, but have to consider it now for a later point.
3.summary: Display grading form in the grading panel
description: Display the grading form in within the grading panel for the current student/content . How it works in Assignment Assignment grading currently does: code - lib.php::mod_assign_output_fragment_gradingpanel() -- locallib::view() --- locallib::view_single_grading_panel ---- gradeform.php::mod_assign_grade_form::definition() ----- locallib::add_grade_form_elements() ------ mod/form/grading.php::toHtml() return $this->get_gradinginstance()->render_grading_element($PAGE, $this); code That comes from grade/grading/form/type/lib.php::render_grading_element() And that calls a renderer function to do loads of things. .Recommendations I dont think that we shuld use the fragments API to do this, at least initially. It doesnt fit in well with what were doing here more generally. Therefore I think we need to update the existing grading options to support a new UI. We _may_ be able to replace the existing rendering with that, but we shouldnt do it in this issue. Create new mustache templates in grade/grading/form/type/templates Replace the existing JS with a new ES6/AMD module called from the template and using uniqid (should be trivial) Create a new renderable for each of the advanced grading forms in /path/classes/output/grading_panel_renderable.php Implement an export_for_template(renderer_base $output) in there Constructor to take finalised values Create an instance of the renderable in a new function in lib.php, or better still in a new class in grade/grading/form/type/classes/gradingpanel.php or similar. That function should return the instance of the renderable. Create a new WS to call the new function/class method. That will then call export_for_template, then return the result. When it comes to saving grades in the grading panel we call the named webservice for each grading form type: gradingform_rubric_save_grades_for_user_in_cmid($user, $cmid, $gradeoptions); or similar That should return the same values (along with a success/fail) Create a generic grade one for simple direct grading We also need to either: limit the list of advanced grading types in the modgrade form field where we choose them from; or ??? When setting up the JS we can do it similar to user selector, except that we have curried fns to: fetch the name of the template to use during render fetch the current data (curried which already provides cmid) and takes just user save the data in the form right now (curried which already provides cmid) and takes user and data in form Theoretically it should be the Forum which provides the curried functions, but theyre also kinda the property of the Grading API so we need to work out how best to do that longer term. . Scope Do not do eveything that the current stuff does. Dont handle all of the modes (especially edit). We should break out marking an editing anyway. Keep everything as basic as possible. . Configuration containing list of grading mechanisms: Advanced type: Simple direct (not an advanced) Type (for Simple direct only) Scale Point Marking guide Rubric The Scale/Point are shown when using the other advanced types, but are not editable.
4.summary: Add fullscreen layout
description: Switch to using a full-screen layout
5.summary: Add parent post snippet
description: When grading a post which is a reply, show the first n characters of the previous post in order to give context to the discussion being graded.
6.summary: Add a button to display the entire discussion for a post being graded
description: Contextual information is important. We should provide a mechanism to view the entire discussion for the content being graded.
7.summary: Add "breadcrumb" to top corner of grading window
description: Add the breadcrumb region to the grading window to help identify which activity is being graded.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Unittest and behat failures in particular DB / OS
description: Since there are quite a few reportly lately (2.8 pre-release) about unit or behat test failures in specific environments Im collecting them under one Epic so we dont create duplicates
| Unsolvable | 1.summary: Various behat failures cause by profile items in user menu
description: I guess the user menu is causing this: code (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Add files recently uploaded. /Users/danp/moodles/im/moodle/repository/recent/tests/behat/add_recent.feature:8 Of feature `Recent files repository lists the recently used files. /Users/danp/moodles/im/moodle/repository/recent/tests/behat/add_recent.feature 1 scenario (1 failed) code Yep, more failures: code danp (master)$ behat `pwd`/repository/tests/behat/overwrite_file.feature Set $CFG->behat_faildump_path to /Users/danp/www/behat_runs/20141029_153426/ on im Moodle 2.8beta+ (Build: 20141028), pgsql, 4f8267025025fc510336652ae19f13ad7dbccc8f Server OS "Darwin", Browser: "firefox" Started at 29-10-2014, 15:34 ........F------------------------- (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Upload a file in filemanager and overwrite it. /Users/danp/moodles/im/moodle/repository/tests/behat/overwrite_file.feature:8 Of feature `Overwrite file feature. /Users/danp/moodles/im/moodle/repository/tests/behat/overwrite_file.feature 1 scenario (1 failed) 34 steps (8 passed, 25 skipped, 1 failed) 0m19.975s danp (master)$ behat `pwd`/repository/tests/behat/delete_files.feature Set $CFG->behat_faildump_path to /Users/danp/www/behat_runs/20141029_153454/ on im Moodle 2.8beta+ (Build: 20141028), pgsql, 4f8267025025fc510336652ae19f13ad7dbccc8f Server OS "Darwin", Browser: "firefox" Started at 29-10-2014, 15:34 .....F---------- (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Delete a file and a folder. /Users/danp/moodles/im/moodle/repository/tests/behat/delete_files.feature:8 Of feature `Delete files and folders from the file manager. /Users/danp/moodles/im/moodle/repository/tests/behat/delete_files.feature 1 scenario (1 failed) 16 steps (5 passed, 10 skipped, 1 failed) 0m18.804s code
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Unittest and behat failures in particular DB / OS
description: Since there are quite a few reportly lately (2.8 pre-release) about unit or behat test failures in specific environments Im collecting them under one Epic so we dont create duplicates
### Response:
1.summary: Various behat failures cause by profile items in user menu
description: I guess the user menu is causing this: code (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Add files recently uploaded. /Users/danp/moodles/im/moodle/repository/recent/tests/behat/add_recent.feature:8 Of feature `Recent files repository lists the recently used files. /Users/danp/moodles/im/moodle/repository/recent/tests/behat/add_recent.feature 1 scenario (1 failed) code Yep, more failures: code danp (master)$ behat `pwd`/repository/tests/behat/overwrite_file.feature Set $CFG->behat_faildump_path to /Users/danp/www/behat_runs/20141029_153426/ on im Moodle 2.8beta+ (Build: 20141028), pgsql, 4f8267025025fc510336652ae19f13ad7dbccc8f Server OS "Darwin", Browser: "firefox" Started at 29-10-2014, 15:34 ........F------------------------- (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Upload a file in filemanager and overwrite it. /Users/danp/moodles/im/moodle/repository/tests/behat/overwrite_file.feature:8 Of feature `Overwrite file feature. /Users/danp/moodles/im/moodle/repository/tests/behat/overwrite_file.feature 1 scenario (1 failed) 34 steps (8 passed, 25 skipped, 1 failed) 0m19.975s danp (master)$ behat `pwd`/repository/tests/behat/delete_files.feature Set $CFG->behat_faildump_path to /Users/danp/www/behat_runs/20141029_153454/ on im Moodle 2.8beta+ (Build: 20141028), pgsql, 4f8267025025fc510336652ae19f13ad7dbccc8f Server OS "Darwin", Browser: "firefox" Started at 29-10-2014, 15:34 .....F---------- (::) failed steps (::) 01. The "(//html/.//a./ = My private files or contains(normalize-space(string(.)), My private files)) or contains(./ My private files) or contains(./ My private files)) or .//imgcontains(./ My private files)) | .//./ = link((./ = My private files or contains(./ My private files)) or contains(./ My private files) or contains(normalize-space(string(.)), My private files)))1" xpath node is not visible and it should be visible In step `And I follow "My private files". behat_general::click_link() From scenario `Delete a file and a folder. /Users/danp/moodles/im/moodle/repository/tests/behat/delete_files.feature:8 Of feature `Delete files and folders from the file manager. /Users/danp/moodles/im/moodle/repository/tests/behat/delete_files.feature 1 scenario (1 failed) 16 steps (5 passed, 10 skipped, 1 failed) 0m18.804s code
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Further quiz editing improvements
description: Following on from , these are the changes we hope to get into Moodle 2.9.
| Unsolvable | 1.summary: Add section headings to quiz
description: Allow the teacher to add headings to the quiz to break up the navigation At the moment, in the quiz navigation, all the questions are shown in one big block. That gets pretty unmanagable for big quizzes. We want to provide a way for teacher to add section headings to the quiz. These would be used to break up the navigation (and for nothing else). Section headings will be independent of Descriptions and page breaks.
2.summary: Teachers can require students to complete Question 1 before they can see Question 2
description: In a quiz, allow teachers to require question N has been answered before question N + 1 can be seen Sometimes you have a sequence of of questions that build on each other, and the text of question 2 inevitably gives away the answer to question 1. A not very good example might be: Q1: Which tool in Moodle can you use to automatically grade your students? Q2: How do you add a quiz to Moodle? So, if the quiz is set to a behaviour where the students can finish one question during an attempt (e.g. immediate feedback, interactive, ...), then there should be a way for teachers to indicat that Q2 depends on Q1. In this case, until Q1 is finished, Q2 will not be accessible: It will not be a link in the navigation, and will be shown greyed out in some way. If Q2 is on a page on its own, then it will not be possible to navigate to page 2. If Q2 is on a page with other questions that can be accessed, then instead of rendering Q2, we will show a grey box saying "This question will not be avialable until Question 1 has been answered." We will need a special string to describe this state on the summary page. I am not sure how we will implement this in the back end. We will probably do something general like QX depends on QY. However, in the UI, we will only provide a way to make QN depend on QN - 1.
3.summary: Option for teachers to allow students to redo a finished question within a quiz attempt
description: Suppose you have provided a formative quiz to your students, using a behaviour like immediate feedback or interactive with multiple tries that lets the student submit one question at a time and descover if they were right. And, suppose a student has just got question 3 wrong, and in the General feedback you explain what the question is about, and how the student should go about answering it. And, suppose the student reads that, and thinks "I would like to try to apply that now." At the moment, the student needs to wait until they have finished the entire quiz, and submitted it, and only then can they start another attempt. We would like an alternative option (which teachers can enable or not as they wish). After the quesion has been finished, there will be a Restart question button, probably in the grey box to the left of the question. If the student clicks that, thier finished attempt at the question will be moved aside, and we will give them a new question to attempt in that slot in the quiz. (If the question is selected randomly, they will probably get a different random question. If there is no randomisation, they will just have to get exactly the same question again.)
4.summary: Collapsible sections in quiz edit page
description: Allow sections to be collapsible in quiz edit renderer
5.summary: Tidy up quiz repaginate code
description: The old function quiz_repaginate_questions, and the separate \mod_quiz\repaginate class, should both be removed (deprecated) and the code moved into \mod_quiz\structure.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Further quiz editing improvements
description: Following on from , these are the changes we hope to get into Moodle 2.9.
### Response:
1.summary: Add section headings to quiz
description: Allow the teacher to add headings to the quiz to break up the navigation At the moment, in the quiz navigation, all the questions are shown in one big block. That gets pretty unmanagable for big quizzes. We want to provide a way for teacher to add section headings to the quiz. These would be used to break up the navigation (and for nothing else). Section headings will be independent of Descriptions and page breaks.
2.summary: Teachers can require students to complete Question 1 before they can see Question 2
description: In a quiz, allow teachers to require question N has been answered before question N + 1 can be seen Sometimes you have a sequence of of questions that build on each other, and the text of question 2 inevitably gives away the answer to question 1. A not very good example might be: Q1: Which tool in Moodle can you use to automatically grade your students? Q2: How do you add a quiz to Moodle? So, if the quiz is set to a behaviour where the students can finish one question during an attempt (e.g. immediate feedback, interactive, ...), then there should be a way for teachers to indicat that Q2 depends on Q1. In this case, until Q1 is finished, Q2 will not be accessible: It will not be a link in the navigation, and will be shown greyed out in some way. If Q2 is on a page on its own, then it will not be possible to navigate to page 2. If Q2 is on a page with other questions that can be accessed, then instead of rendering Q2, we will show a grey box saying "This question will not be avialable until Question 1 has been answered." We will need a special string to describe this state on the summary page. I am not sure how we will implement this in the back end. We will probably do something general like QX depends on QY. However, in the UI, we will only provide a way to make QN depend on QN - 1.
3.summary: Option for teachers to allow students to redo a finished question within a quiz attempt
description: Suppose you have provided a formative quiz to your students, using a behaviour like immediate feedback or interactive with multiple tries that lets the student submit one question at a time and descover if they were right. And, suppose a student has just got question 3 wrong, and in the General feedback you explain what the question is about, and how the student should go about answering it. And, suppose the student reads that, and thinks "I would like to try to apply that now." At the moment, the student needs to wait until they have finished the entire quiz, and submitted it, and only then can they start another attempt. We would like an alternative option (which teachers can enable or not as they wish). After the quesion has been finished, there will be a Restart question button, probably in the grey box to the left of the question. If the student clicks that, thier finished attempt at the question will be moved aside, and we will give them a new question to attempt in that slot in the quiz. (If the question is selected randomly, they will probably get a different random question. If there is no randomisation, they will just have to get exactly the same question again.)
4.summary: Collapsible sections in quiz edit page
description: Allow sections to be collapsible in quiz edit renderer
5.summary: Tidy up quiz repaginate code
description: The old function quiz_repaginate_questions, and the separate \mod_quiz\repaginate class, should both be removed (deprecated) and the code moved into \mod_quiz\structure.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: MoodleNet
summary: Define database models
description: See issues included in this epic.
| Solvable | 1.summary: Specify model and choose engine for search index (incl. OER)
description: WIP
2.summary: Specify model for app
description: WIP
3.summary: Specify model for repository
description: WIP
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: MoodleNet
summary: Define database models
description: See issues included in this epic.
### Response:
1.summary: Specify model and choose engine for search index (incl. OER)
description: WIP
2.summary: Specify model for app
description: WIP
3.summary: Specify model for repository
description: WIP
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Update mod_forum to add additional functionality, and improve accessibility and performance
description: Moodlerooms have produced "Advanced Forum" (it originally started at Humboldt State Uni) It extends current Moodle forum code to prove some of the most-requested forum features such a: - Anonymous forums: This feature allows students to make an anonymous post to a discussion forum while still receiving credit for their post. Instructors can also read all the posts made, and view how many times a student posted to the forum without knowing which student posted which forum. This feature is useful for sensitive discussions and can be used for anonymous student evaluations. - View Posters: This feature gives instructors the ability to view the number of posts, replies, and substantive posts a student has made as well as the content of those posts (even in an anonymous forum). - Discussion Sorting: Sorting enables users to view all the posts by one individual within a particular forum. This is especially useful for instructors when grading participation for one or more forums. - Discussion Subscription: This feature enables students and faculty to receive e-mail postings related to just one topic, rather than forcing them to subscribe to the entire forum. - Simplified Navigation and User Interface: Forums have been improved by reducing the number of clicks of the mouse you have to use to navigate through all posts in a discussion. Additionally, several Forum UI enhancements provide instructors and students with multiple views into a course s forum discussions. These UI designs are intended to provide the user with a way to view posts and replies quickly compared to the Moodle default view of a forum discussion. Users are also given a variety of new preferences to set a preferred view of an Advanced Forum in all courses. - Instructor Post Highlighting: This feature differentiates an instructor s post from a students, which makes it easier for students to notice the posts that may be more relevant for them to read. - Forum Marking: Forum marking enables instructors to identify posts that need review and have had a substantial impact on the reader or the forum in general. - Private Reply: With this feature, instructors can send a private reply to a forum post. This reply is only viewable by the student that made the original post or reply and invisible to the rest of the students. It should be noted that the only way a student knows that a reply is indeed private is that they cannot reply to it. This bug is to track the feasibility of porting (some or all) these into standard forum.
| Unsolvable | 1.summary: Forum: Per-discussion subscription
description: I am finding that my inbox is absolutely flooded with unwanted moodle mails off the forum script. This is very annoying and I know it will similarly annoy my users. In fact it will put them off the system. The problem arises because unlike other discussion boards moodle messages are emailed to me from the entire forum, not just the thread I have started or responded to. The overwhelming of peoples inboxes is a serious business: it could be said that moodle is generating spam because the email feature is so unfocused. Is there any chance this is going to be improved please?
2.summary: Forum: Inline editing
description: I would like to suggest an improvement for the forum based on student feedback. When replying to a forum post, the forum loads a new screen that displays only the single post you replied to. You loose access to the thread which in many cases is not desirable. The best of both worlds could be achieved by opening the editor inline with the whole discussion to allow scrolling up down to grab bits of discussion from the whole thing if thats what you want to do. What do others think?
3.summary: Forum: Highlight certain roles in forum postings
description: Our students have requested if the posts from teachers can be highlighted in the daily digest, perhaps at the top of the digest or in a different colour. Some students receive very large digest emails and want a distinction between posts from teachers and those from other students. They want to prioritise which posts they read with those from their tutors being the most important. Separate lists of posts by course would also be useful in the digest.
4.summary: Forum: Sticky/Pinned discussions
description: I would like to be able to pin a topic in a discussion. This feature should only be available to admin and the teachers.
5.summary: Forum: Implement discussion sorting
description: This patches allow you to select sorting order method of the discussion topics. In current version of Moodle1.8 the list of discussion topics is displayed in order of Last Post only. We can not follow the relationship a topic and next topic. After applying these three paches we can select three sorting methods of discussion topics. One is origginal sorting method (Last Post), and the others are sorting by First Post (From older) and First Post (From newer) according to date of discussion topic.
6.summary: Forum: forum and discussion locking
description: It would be very nice for instructors to have the ability to lock or expire a forum. There are many situations where it would be desirable to leave a forum as "read only". This could be done by setting an expiration date (automatic state change) or a tick box (manual state change). This is related to (expiration date request) Discussion:
7.summary: Forum post Mail now checkbox confusing
description: We have a good number of professors that are confused as to why "Mail now" doesnt send out any mail. They dont realise that mail is only sent to forum subscribers. I think the language string for this should be changed to something like "Mail now (only works for forum subscribers)". Also, it would be nice if the button could be removed if there were no forum subscribers. edit: The checkbox is no longer called _"Mail now"_, the language string was corrected to say _"Send forum post notifications with no editing-time delay"_ . Based on the comments the issue was changed to an improvement to allow teachers to send mail immediately ignoring digest preferences.
8.summary: Additional features for forum activity
description: New features for forum: Set forum to read only. This is available by role changes, but this option is only available for admins in standard configuration. It should be an option for teachers to change forum settings to read only for a forum that is inactive now. Mark a forum topic as answered. The author of initial post or trainer should be able to mark a forum topic as finalised/closed or answered. If a forum is used for question it should be possible to say this is finally answered". The status should be marked in the overview of topics for a forum
9.summary: Convert forum post display to templates
description: This will make modifying the forum layout easier and clearer. We will need to create a number of renderables, and it may be necessary to break this task down further to smaller areas of focus: posts; discussions; thread list; and other areas.
10.summary: Forum: Add ability to hide discussions
description: When dealing with cases where a forum post needs to be removed, but evidence kept (e.g. bullying), we should have an option to remove a post and/or discussion from view without actually deleting it. The ability to view these hidden posts can then be controlled by a capability and a post could be re-instated. This could also be used for crowd-sourced Mark as SPAM and for a Mark as offensive type flag.
11.summary: Forum: code an accessible layout
description: Forums in Moodle 2.6 are very similar in layout to the forum in Moodle 1.0. Small fixes for accessibility have been made but its becoming clear that a complete redesign of the layout is necessary for accessibility and also usability in the general sense. This issues is for discussing the proposed new accessible forum layout at
12.summary: Forum: proceed to next thread link
description: Please put a link to jump to the next thread in the forum interface... Forums are very cool but the evaluation process is time consuming and, for a teacher, time is everything when evaluating 100s of students...
13.summary: Create an inbound e-mail handling system
description: For things like: replying to forum posts; adding new files to your private files area; submitting assignments; replying to private messages; ...
14.summary: Finish VERP work in current sprint
description: Rather than pulling in work which was largely created in other sprints, this issue is a placeholder for the VERP-related work remaining in this sprint.
15.summary: Add new feature to post to all potential recipients
description: As discussed in , we should add a checkbox to allow some users to post to al potential recipients and not just those subscribed to the forum. This is intended for occasional important announcements and enhances the functionality of the mailnow feature. Consider adding a warning that this message will be sent to all 2,400,000,000 recipients, etc.
16.summary: Refactor forum code to support new forum types
description: A lot of the work here would be aided by restructuring the forum code to create a new forum abstract class, and sub-classing it for each type of forum. This will also give us the ability to support new forum types as a subplugin which would help to solve , , , , , and others. Making this kind of change will also help to restructure some of the older code to use more efficient methods, and I hope will make it easier to rewrite the current echo/html_writer based rendering to use templates.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Update mod_forum to add additional functionality, and improve accessibility and performance
description: Moodlerooms have produced "Advanced Forum" (it originally started at Humboldt State Uni) It extends current Moodle forum code to prove some of the most-requested forum features such a: - Anonymous forums: This feature allows students to make an anonymous post to a discussion forum while still receiving credit for their post. Instructors can also read all the posts made, and view how many times a student posted to the forum without knowing which student posted which forum. This feature is useful for sensitive discussions and can be used for anonymous student evaluations. - View Posters: This feature gives instructors the ability to view the number of posts, replies, and substantive posts a student has made as well as the content of those posts (even in an anonymous forum). - Discussion Sorting: Sorting enables users to view all the posts by one individual within a particular forum. This is especially useful for instructors when grading participation for one or more forums. - Discussion Subscription: This feature enables students and faculty to receive e-mail postings related to just one topic, rather than forcing them to subscribe to the entire forum. - Simplified Navigation and User Interface: Forums have been improved by reducing the number of clicks of the mouse you have to use to navigate through all posts in a discussion. Additionally, several Forum UI enhancements provide instructors and students with multiple views into a course s forum discussions. These UI designs are intended to provide the user with a way to view posts and replies quickly compared to the Moodle default view of a forum discussion. Users are also given a variety of new preferences to set a preferred view of an Advanced Forum in all courses. - Instructor Post Highlighting: This feature differentiates an instructor s post from a students, which makes it easier for students to notice the posts that may be more relevant for them to read. - Forum Marking: Forum marking enables instructors to identify posts that need review and have had a substantial impact on the reader or the forum in general. - Private Reply: With this feature, instructors can send a private reply to a forum post. This reply is only viewable by the student that made the original post or reply and invisible to the rest of the students. It should be noted that the only way a student knows that a reply is indeed private is that they cannot reply to it. This bug is to track the feasibility of porting (some or all) these into standard forum.
### Response:
1.summary: Forum: Per-discussion subscription
description: I am finding that my inbox is absolutely flooded with unwanted moodle mails off the forum script. This is very annoying and I know it will similarly annoy my users. In fact it will put them off the system. The problem arises because unlike other discussion boards moodle messages are emailed to me from the entire forum, not just the thread I have started or responded to. The overwhelming of peoples inboxes is a serious business: it could be said that moodle is generating spam because the email feature is so unfocused. Is there any chance this is going to be improved please?
2.summary: Forum: Inline editing
description: I would like to suggest an improvement for the forum based on student feedback. When replying to a forum post, the forum loads a new screen that displays only the single post you replied to. You loose access to the thread which in many cases is not desirable. The best of both worlds could be achieved by opening the editor inline with the whole discussion to allow scrolling up down to grab bits of discussion from the whole thing if thats what you want to do. What do others think?
3.summary: Forum: Highlight certain roles in forum postings
description: Our students have requested if the posts from teachers can be highlighted in the daily digest, perhaps at the top of the digest or in a different colour. Some students receive very large digest emails and want a distinction between posts from teachers and those from other students. They want to prioritise which posts they read with those from their tutors being the most important. Separate lists of posts by course would also be useful in the digest.
4.summary: Forum: Sticky/Pinned discussions
description: I would like to be able to pin a topic in a discussion. This feature should only be available to admin and the teachers.
5.summary: Forum: Implement discussion sorting
description: This patches allow you to select sorting order method of the discussion topics. In current version of Moodle1.8 the list of discussion topics is displayed in order of Last Post only. We can not follow the relationship a topic and next topic. After applying these three paches we can select three sorting methods of discussion topics. One is origginal sorting method (Last Post), and the others are sorting by First Post (From older) and First Post (From newer) according to date of discussion topic.
6.summary: Forum: forum and discussion locking
description: It would be very nice for instructors to have the ability to lock or expire a forum. There are many situations where it would be desirable to leave a forum as "read only". This could be done by setting an expiration date (automatic state change) or a tick box (manual state change). This is related to (expiration date request) Discussion:
7.summary: Forum post Mail now checkbox confusing
description: We have a good number of professors that are confused as to why "Mail now" doesnt send out any mail. They dont realise that mail is only sent to forum subscribers. I think the language string for this should be changed to something like "Mail now (only works for forum subscribers)". Also, it would be nice if the button could be removed if there were no forum subscribers. edit: The checkbox is no longer called _"Mail now"_, the language string was corrected to say _"Send forum post notifications with no editing-time delay"_ . Based on the comments the issue was changed to an improvement to allow teachers to send mail immediately ignoring digest preferences.
8.summary: Additional features for forum activity
description: New features for forum: Set forum to read only. This is available by role changes, but this option is only available for admins in standard configuration. It should be an option for teachers to change forum settings to read only for a forum that is inactive now. Mark a forum topic as answered. The author of initial post or trainer should be able to mark a forum topic as finalised/closed or answered. If a forum is used for question it should be possible to say this is finally answered". The status should be marked in the overview of topics for a forum
9.summary: Convert forum post display to templates
description: This will make modifying the forum layout easier and clearer. We will need to create a number of renderables, and it may be necessary to break this task down further to smaller areas of focus: posts; discussions; thread list; and other areas.
10.summary: Forum: Add ability to hide discussions
description: When dealing with cases where a forum post needs to be removed, but evidence kept (e.g. bullying), we should have an option to remove a post and/or discussion from view without actually deleting it. The ability to view these hidden posts can then be controlled by a capability and a post could be re-instated. This could also be used for crowd-sourced Mark as SPAM and for a Mark as offensive type flag.
11.summary: Forum: code an accessible layout
description: Forums in Moodle 2.6 are very similar in layout to the forum in Moodle 1.0. Small fixes for accessibility have been made but its becoming clear that a complete redesign of the layout is necessary for accessibility and also usability in the general sense. This issues is for discussing the proposed new accessible forum layout at
12.summary: Forum: proceed to next thread link
description: Please put a link to jump to the next thread in the forum interface... Forums are very cool but the evaluation process is time consuming and, for a teacher, time is everything when evaluating 100s of students...
13.summary: Create an inbound e-mail handling system
description: For things like: replying to forum posts; adding new files to your private files area; submitting assignments; replying to private messages; ...
14.summary: Finish VERP work in current sprint
description: Rather than pulling in work which was largely created in other sprints, this issue is a placeholder for the VERP-related work remaining in this sprint.
15.summary: Add new feature to post to all potential recipients
description: As discussed in , we should add a checkbox to allow some users to post to al potential recipients and not just those subscribed to the forum. This is intended for occasional important announcements and enhances the functionality of the mailnow feature. Consider adding a warning that this message will be sent to all 2,400,000,000 recipients, etc.
16.summary: Refactor forum code to support new forum types
description: A lot of the work here would be aided by restructuring the forum code to create a new forum abstract class, and sub-classing it for each type of forum. This will also give us the ability to support new forum types as a subplugin which would help to solve , , , , , and others. Making this kind of change will also help to restructure some of the older code to use more efficient methods, and I hope will make it easier to rewrite the current echo/html_writer based rendering to use templates.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Behat 3.2.x upgrade issues to be fixed
description: Some of the issues have been fixed in Behat and not yet released. This epic is to keep track of all related issues which need attention after behat is upgraded.
| Unsolvable | 1.summary: Behat, support relative dates.
description: Now and then I find relative dates necessary in my behat tests. To start with I worked around this issue by creating custom steps. However, a much better way is to use the translation feature in behat. This way you can simply do things like: code I should see "the date of next week" code And code Given the following "activities" exist: | activity | course | idnumber | name | duedate | | assign | C1 | assign1 | Test assignment1 | the timestamp of tomorrow | code
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Behat 3.2.x upgrade issues to be fixed
description: Some of the issues have been fixed in Behat and not yet released. This epic is to keep track of all related issues which need attention after behat is upgraded.
### Response:
1.summary: Behat, support relative dates.
description: Now and then I find relative dates necessary in my behat tests. To start with I worked around this issue by creating custom steps. However, a much better way is to use the translation feature in behat. This way you can simply do things like: code I should see "the date of next week" code And code Given the following "activities" exist: | activity | course | idnumber | name | duedate | | assign | C1 | assign1 | Test assignment1 | the timestamp of tomorrow | code
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.3
description: In 3.3 we can remove functionality that was deprecated in 2.9 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.3. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Final deprecations in core_cache
description: We need to remove the following in core_cache that were deprecated in 2.9: cache/classes/definition.php cache_definition::datasourceaggregate| cache/tests/fixtures/lib.php: cache_config_phpunittest| See
2.summary: Deprecate behat step: I go to "PATH" in the course gradebook
description: it was added before 3.2 release and right after release replaced with I navigate to "PATH" in the course gradebook we just need to deprecate it
3.summary: Remove behat steps deprecated in 2.9 or earlier
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 2.9 or earlier please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Epic: Collect together deprecated and planned code changes for Moodle 3.3
description: In 3.3 we can remove functionality that was deprecated in 2.9 or earlier (see ) There are a number of parts of the Moodle codebase that have been marked as deprecated as a warning to developers not to use these functions as they will be removed in future. Many have a deadline of 3.3. Each of these deprecated functions, especially those in Moodle core code, should have an MDL issue associated with it. In order to time the removal of these deprecated functions issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Final deprecations in core_cache
description: We need to remove the following in core_cache that were deprecated in 2.9: cache/classes/definition.php cache_definition::datasourceaggregate| cache/tests/fixtures/lib.php: cache_config_phpunittest| See
2.summary: Deprecate behat step: I go to "PATH" in the course gradebook
description: it was added before 3.2 release and right after release replaced with I navigate to "PATH" in the course gradebook we just need to deprecate it
3.summary: Remove behat steps deprecated in 2.9 or earlier
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 2.9 or earlier please add to the description if you know of any other deprecated behat functionality outside of this file that needs to be removed
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Use hideIf in core forms
description: There are a number of core forms that could benefit from the use of the new hideIf functionality (). In this ticket I will propose a number of places this could be implemented + attach proposed patches to do this.
| Unsolvable | 1.summary: LTI modedit.php should not display disabled form elements
description: The LTI form can, depending on how its been set up, show a whole bunch of disabled elements. I cant see any reason for displaying these. If they are not editable then dont display them. Particular confusion is caused by the Select content button. Even in a disabled state, in most themes users dont realise that this is disabled and leads them to believe that the LTI is broken ("I cant click the content button").
2.summary: Use hideif on the mod_assign settings form
description: is a large ticket, proposing making changes to a wide range of forms across the whole of the site. In order to make it more manageable, here is a patch here just for mod_assign, with the relevant screenshots: ^mod_assign - hideif.pdf
3.summary: Use hideif for Moodle forms inside admin/ top level directory
description: Review the forms in the admin/ directory for those which are candidates for switching disabledIf() to hideIf() See: ^admin - hideif.pdf for details of changes proposed
4.summary: Use hideif for Moodle forms in the course/ directory
description: Review the forms in the course/ directory for those which are candidates for switching disabledIf() to hideIf() Proposed changes: ^course - hideif.pdf
5.summary: Hide Add group/grouping access restriction when in No groups mode
description: In there is a proposal to hide the Grouping setting when No groups mode is selected on an activity settings form. It would be good to also hide the Add group/grouping access restriction button at the same time, but that is out of scope for the above ticket, as it is not possible by simply switching disabledIf => hideIf (as the button is not disabled via disabledIf). !screenshot-1.png|thumbnail!
6.summary: Reword restrict ratings to items with dates in range and use hideIf on dates
description: On the forum settings page, there is an option to Restrict ratings to items with dates in this range:. As discussed on it may be desirable to change the wording of this to something like Restrict ratings to items with dates within a range and then use hideif to hide, rather than disable, the date selectors when this option is not ticked. !screenshot-1.png|thumbnail!
7.summary: Use hideif for Moodle forms in the mod/ directory
description: Review all uses of disabledIf in the mod/ directory and switch the appropriate ones to use hideIf instead. Screenshots (before and after) of all affected forms can be found in: ^mod - hideif.pdf
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Use hideIf in core forms
description: There are a number of core forms that could benefit from the use of the new hideIf functionality (). In this ticket I will propose a number of places this could be implemented + attach proposed patches to do this.
### Response:
1.summary: LTI modedit.php should not display disabled form elements
description: The LTI form can, depending on how its been set up, show a whole bunch of disabled elements. I cant see any reason for displaying these. If they are not editable then dont display them. Particular confusion is caused by the Select content button. Even in a disabled state, in most themes users dont realise that this is disabled and leads them to believe that the LTI is broken ("I cant click the content button").
2.summary: Use hideif on the mod_assign settings form
description: is a large ticket, proposing making changes to a wide range of forms across the whole of the site. In order to make it more manageable, here is a patch here just for mod_assign, with the relevant screenshots: ^mod_assign - hideif.pdf
3.summary: Use hideif for Moodle forms inside admin/ top level directory
description: Review the forms in the admin/ directory for those which are candidates for switching disabledIf() to hideIf() See: ^admin - hideif.pdf for details of changes proposed
4.summary: Use hideif for Moodle forms in the course/ directory
description: Review the forms in the course/ directory for those which are candidates for switching disabledIf() to hideIf() Proposed changes: ^course - hideif.pdf
5.summary: Hide Add group/grouping access restriction when in No groups mode
description: In there is a proposal to hide the Grouping setting when No groups mode is selected on an activity settings form. It would be good to also hide the Add group/grouping access restriction button at the same time, but that is out of scope for the above ticket, as it is not possible by simply switching disabledIf => hideIf (as the button is not disabled via disabledIf). !screenshot-1.png|thumbnail!
6.summary: Reword restrict ratings to items with dates in range and use hideIf on dates
description: On the forum settings page, there is an option to Restrict ratings to items with dates in this range:. As discussed on it may be desirable to change the wording of this to something like Restrict ratings to items with dates within a range and then use hideif to hide, rather than disable, the date selectors when this option is not ticked. !screenshot-1.png|thumbnail!
7.summary: Use hideif for Moodle forms in the mod/ directory
description: Review all uses of disabledIf in the mod/ directory and switch the appropriate ones to use hideIf instead. Screenshots (before and after) of all affected forms can be found in: ^mod - hideif.pdf
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Moodle accessibility issues
description: This issue serves as the collection of accessibility issues affecting Moodle in general.
| Unsolvable | 1.summary: Adding title attribute to links for accessibility goes against recommendations in WCAG and is rarely useful.
description: Needs confirming in Jaws. Found in testing . A link like this Dan the man appears to screen readers as: link Dan the man The extra information provided by the title is not read out. We should have a clear policy on this that meets the WCAG recommendations. We should then have a meta task to change uses in core to meet our agreed policy. Quote: The objective of this technique is to demonstrate how to use a title attribute on an anchor element to provide additional text describing a link. The title attribute is used to provide additional information to help clarify or further describe the purpose of a link. If the supplementary information provided through the title attribute is something the user should know before following the link, such as a warning, then it should be provided in the link text rather than in the title attribute. Because of the extensive user agent limitations in supporting access to the title attribute, authors should use caution in applying this technique. For this reason, it is preferred that the author use technique C7: Using CSS to hide a portion of the link text (CSS) or H30: Providing link text that describes the purpose of a link for anchor elements. This needs to be done in a way that supports translators - not by joining strings.
2.summary: Paste from Microsoft Word in Atto does a poor job of cleaning up html
description: . Summary When I paste information copied from Microsoft Word, through the Windows clipboard, into an Atto editor, there is so much unwanted styling and unwanted code. This can create accessibility issues as the content, when viewed in context can be so different than what is seen in the Atto editor. . Full Steps 1) Open the attached document in Microsoft Word. Its not very long document, only a few lines including a heading and a few unordered bullets. 2) Press ctrl-a to select all 3) Press ctrl-c to copy onto the Windows clipboard. 4) In a course, add a new Page resource to one of the sections and set the page title to Paste Test. 5) Press ctrl-v to paste the content of your Windows clipboard into the Atto editor for the Content section of the page. 6) View the HTML. . What I expected As there is no special formatting applied to the content in Word but just some styles including Heading 1 for the first line and unordered bullets for the rest, that is all the markup I expected to see in the HTML code - some , ul, li and maybe a paragraph set of tags at the end. . What actually happens The fact is that you will not find any H1 tags, or any UL or LI tags. What you do find is way too much formatting junk that ends up in there. If I were to save the content as is, the content would not take on the look and feel of the site. . Workaround When copying and pasting content from Word, I have to make sure to switch the default editor in my profile settings to TinyMCE and use the tools that I to work. However, with the increasing popularity of Atto as the editor of choice for Moodle, I would much prefer that this work in a useful manor. . Test Environment Browser: Chrome version "46.0.2490.86 m" on Windows 7. Still happening in Chrome 79 on Windows 10.
3.summary: Allow HTML in Custom Menu
description: Moodle custom menus are unnecessary stripped of all HTML. This is not desirable as there are situations where one might want to include some HTML. Normally this is done for security reasons however Moodle Custom Menus are only editable by elevated roles. . How to reproduce the issue Here are a couple of example describing situations where it would be desirable to be able to include HTML in a text of a menu item: In the first example, the tag is required for accessibility in order to provide an expansion of acronyms. How to edit HTML|... While this example demonstrates using the well known acronym HTML, there are many other situations where the acronym might not be as well known. Example: GBA+|... A second example demonstrates how one might want to include FontAwesome icons in a menu item using the tag: Help|/mod/page/... or Help|/mod/page/... While not an accessibility issue, it is a nice to have for the UI and UX. Example: !image-2019-11-09-08-09-08-825.png! . What currently happens If you tried adding the above mentioned sample code, you will find that the HTML tags have been stripped out before being displayed. Example: !image-2019-11-09-08-00-20-992.png! While the icons are purely aesthetic, the acronym/abbreviation issue is a real situation issue and the fix for one addresses both issues. On a side note, it is actually desirable for Moodle Custom Menus to be passed through limited Moodle filters as described in , just not filter out HTML.
4.summary: Provide alternate-text field for uploaded images
description: While the image insertion tool in the rich text editor includes a field for alternate text, the system file picker does not. When organizations add image files, such as for badges and theme logos, they cannot meet accessibility requirements for the images. Acceptance requirements As a user adding a file image in the system, I will know this is done when: Upon adding a file, either through drag and drop or file selection from my computer, the system displays an optional field for adding alternate text Upon subsequently accessing the uploaded image file, I can view and edit the alternate text field Visually impaired users can be informed of the image text via screen reader Since the file picker modal does not display when adding files via drag/drop, maybe the easiest approach is to just include the field in that modal? (see screenshot) Users would have to take the extra step of opening this modal after drag/drop, but thats much less complex to support than launching the modal upon the drag/drop action.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Moodle accessibility issues
description: This issue serves as the collection of accessibility issues affecting Moodle in general.
### Response:
1.summary: Adding title attribute to links for accessibility goes against recommendations in WCAG and is rarely useful.
description: Needs confirming in Jaws. Found in testing . A link like this Dan the man appears to screen readers as: link Dan the man The extra information provided by the title is not read out. We should have a clear policy on this that meets the WCAG recommendations. We should then have a meta task to change uses in core to meet our agreed policy. Quote: The objective of this technique is to demonstrate how to use a title attribute on an anchor element to provide additional text describing a link. The title attribute is used to provide additional information to help clarify or further describe the purpose of a link. If the supplementary information provided through the title attribute is something the user should know before following the link, such as a warning, then it should be provided in the link text rather than in the title attribute. Because of the extensive user agent limitations in supporting access to the title attribute, authors should use caution in applying this technique. For this reason, it is preferred that the author use technique C7: Using CSS to hide a portion of the link text (CSS) or H30: Providing link text that describes the purpose of a link for anchor elements. This needs to be done in a way that supports translators - not by joining strings.
2.summary: Paste from Microsoft Word in Atto does a poor job of cleaning up html
description: . Summary When I paste information copied from Microsoft Word, through the Windows clipboard, into an Atto editor, there is so much unwanted styling and unwanted code. This can create accessibility issues as the content, when viewed in context can be so different than what is seen in the Atto editor. . Full Steps 1) Open the attached document in Microsoft Word. Its not very long document, only a few lines including a heading and a few unordered bullets. 2) Press ctrl-a to select all 3) Press ctrl-c to copy onto the Windows clipboard. 4) In a course, add a new Page resource to one of the sections and set the page title to Paste Test. 5) Press ctrl-v to paste the content of your Windows clipboard into the Atto editor for the Content section of the page. 6) View the HTML. . What I expected As there is no special formatting applied to the content in Word but just some styles including Heading 1 for the first line and unordered bullets for the rest, that is all the markup I expected to see in the HTML code - some , ul, li and maybe a paragraph set of tags at the end. . What actually happens The fact is that you will not find any H1 tags, or any UL or LI tags. What you do find is way too much formatting junk that ends up in there. If I were to save the content as is, the content would not take on the look and feel of the site. . Workaround When copying and pasting content from Word, I have to make sure to switch the default editor in my profile settings to TinyMCE and use the tools that I to work. However, with the increasing popularity of Atto as the editor of choice for Moodle, I would much prefer that this work in a useful manor. . Test Environment Browser: Chrome version "46.0.2490.86 m" on Windows 7. Still happening in Chrome 79 on Windows 10.
3.summary: Allow HTML in Custom Menu
description: Moodle custom menus are unnecessary stripped of all HTML. This is not desirable as there are situations where one might want to include some HTML. Normally this is done for security reasons however Moodle Custom Menus are only editable by elevated roles. . How to reproduce the issue Here are a couple of example describing situations where it would be desirable to be able to include HTML in a text of a menu item: In the first example, the tag is required for accessibility in order to provide an expansion of acronyms. How to edit HTML|... While this example demonstrates using the well known acronym HTML, there are many other situations where the acronym might not be as well known. Example: GBA+|... A second example demonstrates how one might want to include FontAwesome icons in a menu item using the tag: Help|/mod/page/... or Help|/mod/page/... While not an accessibility issue, it is a nice to have for the UI and UX. Example: !image-2019-11-09-08-09-08-825.png! . What currently happens If you tried adding the above mentioned sample code, you will find that the HTML tags have been stripped out before being displayed. Example: !image-2019-11-09-08-00-20-992.png! While the icons are purely aesthetic, the acronym/abbreviation issue is a real situation issue and the fix for one addresses both issues. On a side note, it is actually desirable for Moodle Custom Menus to be passed through limited Moodle filters as described in , just not filter out HTML.
4.summary: Provide alternate-text field for uploaded images
description: While the image insertion tool in the rich text editor includes a field for alternate text, the system file picker does not. When organizations add image files, such as for badges and theme logos, they cannot meet accessibility requirements for the images. Acceptance requirements As a user adding a file image in the system, I will know this is done when: Upon adding a file, either through drag and drop or file selection from my computer, the system displays an optional field for adding alternate text Upon subsequently accessing the uploaded image file, I can view and edit the alternate text field Visually impaired users can be informed of the image text via screen reader Since the file picker modal does not display when adding files via drag/drop, maybe the easiest approach is to just include the field in that modal? (see screenshot) Users would have to take the extra step of opening this modal after drag/drop, but thats much less complex to support than launching the modal upon the drag/drop action.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: H5P for Moodle 3.9
description: Further development of the H5P integration| Integration of H5P content types with Moodle gradebook and activity completion. Improved integration of H5P content type selection in Moodles activity chooser.
| Unsolvable | 1.summary: Improve admin UI to manage H5P libraries and give information about H5P tools status
description: Improve admin UI for H5P management: Add icons to installed content types list in Site administration > H5P > Manage H5P content types Add a new page to show the admins information about the status of different H5P tools installed: tool name, status and description. Would be good to have links to management page for each tool from this new overview page, and an option to run the scheduled task without having to access to the Scheduled tasks page if everything is configured properly.
2.summary: Add Admin UI to delete existing H5P libraries
description: Whilst reviewing the H5P integration () an issue has been raised to control who can install/update the content-type libraries. The list of all the content-type libraries will be displayed in a page. Admins should be able to remove libraries from here too.
3.summary: Implement search API for the content bank
description: As an instructional designer I want to be able to search in the content bank by contents name So that I can find the content I need . List of tasks: Implement needed methods or functions to search in the content bank.
4.summary: Add a mechanism to support multi H5P core_api versions
description: H5P integration is composed of: A core library: A set of PHP + JS code, currently at version 1.24. The content types. The content types available through their API. The content types make use of features in the core library. User-content: Content using those content-type. The issue is that H5P frequently updates its core library. When they do so: They reserve the right to make their content types require the latest version of the core library. If that version is not available, they tell you to upgrade the core library. Where the content type is upgraded in tandem with the core library, then we are now saying that you must update your content to require the latest version of that content type... which now requires the latest version. Other known issues: The libraries are non-trivial to upgrade because they may introduce breaking API changes which we need to implement something on our side to solve; Some customizations have been done in order to improve the integration with the Moodle API. We will need to decide which is the best way to proceed for upgrading the library core. Some approaches (there may be more): Move the current integration to a new plugin in a new plugintype with the option of installing additional plugintypes. Create a third-party plugin for upgrading it ( such as the app does with the additional features 3rd party plugin). Update the H5P core library in Moodle with each minor release (treat it as a security issue).
5.summary: New activity icon for H5P
description: Right now we are using the same icon as the current plugin. Since it will be displayed as a native activity among other activities, its icon should follow the same aesthetics.
6.summary: H5P: get site UUID using H5P API
description: adds a task to install the latest version of the H5P content types. It requires connecting to the H5P API, whose endpoints expects a POST with "application/x-www-form-urlencoded" data, which must at least include the sites UUID. Although the sites UUID could be generated locally, with the only limitation of not being longer than 36 characters, the correct way to do this is to send a request to the "api.p.org/v1/sites" endpoint without any UUID and obtain a unique UUID that will be registered for the site. The goal of this issue is getting the UUID from the H5P API and use it in any H5P API request. Submission of additional information, although not sensitive, should be acknowledged by a site administrator, and is beyond the scope of this issue. Source:
7.summary: Apply Display H5P filter inside tags
description: As explained in Display H5P filter is ignoring H5P URLs inside tags like But when somebody copy an H5P content URL from a Chrome browser address bar and paste it in Moodle rich text editor, is pasted as a link, inside tags. So Display H5P filter is not applied in those cases. Convert URLs into links and images filter is ignoring content inside tags as well, but Multimedia plugins filter is not ignoring them. So maybe the best behavior for filters should be decided and implement it consistently all along Moodle filters.
8.summary: H5P player should accept webservice/pluginfile.php and tokenpluginfile.php URLs
description: Right now the player only accepts /pluginfile.php URLs to find the p files. It would be nice if it also accepted webservice/pluginfile.php and tokenpluginfile.php URLs, since theyre also valid URLs to retrieve the file. E.g. this URL works fine: But this one gives an error: H5P file not found (invalid contextid)
9.summary: H5P editor integration
description: . Summary Integrate the H5P editor with all its functionality in core. Based on the H5P Editor PHP library and the mod_hvp plugin. . User stories _As an instructional designer_ _I want to modify an existing H5P content_ _So I edit the content in the H5P editor_ _As an instructional designer_ _I want to create a new H5P content_ _So I create the content in the H5P editor_ . Tasks - Add H5P editor library in core (lib/p/editor) - Moodle-ish the implementation of the interfaces (following Moodle coding standards) - Display inside a standalone form (lib/p/editor.php) - Integrate translations with Moodle (if possible)
10.summary: Add a delete content option to the content bank
description: As an instructional designer I want to be able to remove existing content from the content bank So that I can delete wrong or old content . Acceptance criteria: Be able to delete existing content. The user would see a warning message because we cant know if that content is in use, or where is used. The user could confirm or cancel deletion. . List of tasks: Implement needed methods or functions to delete content. Implement needed capabilities to delete own/other users content. Implement the warning informing the user. Adapt H5P player to be sure theres no error if the file to render doesnt exist.
11.summary: Add xAPI statement support to mod_p
description: Implement the required classes to use xAPI statement post inside mod_p. This implementation requires: Implement the extension of xapi_statement_base as \mod_p\xapi_handler class which override: statement_to_event: convert a xAPI statement to a mod_p event (plus programming that event) Add xAPI LRS URL to mod_p player and implement the JS method to send xAPI statements from the H5P content Code behat tests
12.summary: Create a new contentbank plugin type and a new H5P plugin in the content bank
description: As an instructional designer I want to have a shared content bank So that I can share content with other users in the site As an instructional designer I want to be able to upload H5P fils to the content bank So that I can share content with other users in the site . Acceptance criteria: Be able to upload some H5P content that everybody with proper permission can see. Be able to implement plugins that would manage some other content type and share with other users. . List of tasks: Create new contentbank plugin type Create DB tables as needed for the content bank Create generic capabilities for the Content Bank Implement a null privacy provider for now Create a new view page Create a new H5P contentbank plugin Adapt or create DB tables as needed for the plugin Create capabilities for the H5P plugin. Implement a null privacy provider for the plugin Implement the option to upload H5P content to content bank Add new PHP Unit tests Add behat tests or create a new issue to add them
13.summary: Create a new H5P activity
description: As a teacher I want to create an H5P content activity So that I can use the H5P activities as other Moodle activities . Acceptance criteria: Create a new activity type for teachers to be able to upload an H5P file and render it in the course. Be able to define activities standard options such as Availability, Restrict access and other common module settings. . List of tasks: Create new mod_p plugin skeleton Adapt or create DB tables as needed Create capabilities Implement a null privacy provider for now Create a new edit page and its form Create a new view page Implement Moodles basic activity completion not using H5P completion Add behat tests or create a new issue to add them
14.summary: Implement events for H5P content bank
description: As a manager I want to log users activity So that I can check when H5P content in the content bank has been created, updated, deleted or viewed. . Acceptance criteria: Log when content in the H5P content bank has been created. Log when content in the H5P content bank has been updated. Log when content in the H5P content bank has been deleted. Log when content in the H5P content bank has been viewed. . List of tasks: Create contentbank_p viewed event. Create contentbank_p created event. Create contentbank_p updated event. Create contentbank_p deleted event.
15.summary: Implement appropriate privacy provider for H5P activity
description: As a user I want H5P activity implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the H5P module privacy provider. . List of tasks: Implement provider class for mod_p
16.summary: Implement events for H5P activity
description: As a teacher I want to log users activity So that I can when H5P activity has been created, updated, deleted or viewed. . Acceptance criteria: Log when a H5P activity has been created. Log when a H5P activity has been updated. Log when a H5P activity has been deleted. Log when a H5P activity has been viewed. . List of tasks: Create mod_p viewed event. Create mod_p created event. Create mod_p updated event. Create mod_p deleted event.
17.summary: Create basic skeleton for a global xAPI library needed for H5P content
description: A basic xAPI LRS support is needed In order to get statements from H5P content. This first issue will cover the following needs: Have a "lib/xAPI" library for the main LRS access point A generic Moodle webservice layer which wraps a xAPI statement processing xAPI handler base classes which every plugin can extend to use xAPI on their code xAPI statement class to generate xAPI statements with all related classes for handling actors (user, group), objects and verbs (the rest of xAPI properties would be compatible but validations will be responsibility of every plugin for now). PHPUnit test Null privacy provider The web service for processing a xAPI statement will delegate part of the process to specific plugins like the future mod_p. . xAPI generic webservice (component, statement) The web service receive a frankenstyle component responsible to handle part of the statement and a xAPI statement structure. xAPI Statement generic processing method will: xAPI checks the statement structure, if any check fails, it returns an error. That means: Check that only supported xAPI attributes are used Check all users and groups are created in the LMS xAPI checks if the component has a xAPI handling class implementation. Otherwise it returns an error. For every statement: xAPI asks again the plugin to you convert into a standard event. In case the plugin could not convert some statement into an event, this statement will be marked as rejected and xAPI continue to the next statement. xAPI handler will trigger all the generated events Once all statements are processed: If ALL statements are marked as not processed it returns an error. If some statement could be processed, returns an array containing true if the statement is processed and false" otherwise.
18.summary: Add generic statement support for xAPI library
description: Create the elements needed for handling statement in the xAPI LRS library: Basic xAPI statement post event used in cases where plugins not implement its own events The generic Statement handling base class that plguins can extend to post xAPI statements. Statement JSON basic schema validation in the rest xAPI LRS library PHP Unit Tests for the previous 3 components
19.summary: Implement appropriate privacy provider for content bank
description: As a user I want content bank implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the content bank privacy provider. Export data for all the contexts allowed (System, Course Category and Course). . List of tasks: Implement provider class for contentbank
20.summary: Implement appropriate privacy provider for H5P content bank plugin
description: As a user I want H5P content bank implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the H5P content bank privacy provider. . List of tasks: Implement provider class for contentbank_p
21.summary: Implement events for content bank
description: As a manager I want to log users activity So that I can check when content in the content bank has been created, updated, deleted or viewed. . Acceptance criteria: Log when content in the content bank has been uploaded. Log when content in the content bank has been updated. Log when content in the content bank has been deleted. Log when content in the content bank has been viewed. . List of tasks: Create contentbank viewed event. Create contentbank uploaded event. Create contentbank updated event. Create contentbank deleted event.
22.summary: Rename content in the content bank
description: As an instructional designer I want to have the option to change the name of the content So that I can correct mistakes, typos, order content in a better way or make the content easier to find. . Acceptance criteria: Be able to change existing contents name. . List of tasks: Implement functions needed to change the name of the content. Create or use capabilities to update content. Implement the UI to rename content.
23.summary: H5P deployment needs to lock
description: When deploying a new H5P resource we need to ensure that we dont start deploying the same H5P in another thread (e.g. for another session/user). At the moment this is possible: Login as a user and upload the course-presentation.p Use the test-p.html file to test it Whilst it unpacks open a different browser or a private browsing tab Log in at the same user (or a different one) and view the same p file again Wait Observe that in the 2nd and all subsequent loads we get a warning: code Error: mdb->get_record() found more than one record! line 1599 of /lib/dml/moodle_database.php: call to debugging() line 1559 of /lib/dml/moodle_database.php: call to moodle_database->get_record_sql() line 1538 of /lib/dml/moodle_database.php: call to moodle_database->get_record_select() line 235 of /p/classes/player.php: call to moodle_database->get_record() line 101 of /p/classes/player.php: call to core_p\player->get_p_id() line 39 of /p/embed.php: call to core_p\player->__construct() code
24.summary: Add copyright and download settings to H5P activity
description: Add to the H5P activity the same settings ATTO H5P plugin have: Allow download Embed button Copyright button
25.summary: Include H5P Activity backup and restore options
description: As a manager I want to able to include H5P activity in course backup and restore process So that I can backup and restore courses with all their activities . Acceptance criteria: H5P activities should be included in the course backup file. H5P activities should be restored from course backup files. . List of tasks: Implement backup classes for mod_p Implement restore classes for mod_p
26.summary: Add support for result, attachments, context to core_xapi library
description: The basic xAPI library covers actor, verb, object parts of statement but uses generic items as attachment, result or context. In case some early adopters uses that other statement properties will difficult the future grow of that library. By implementing basic classes for handling those properties future improvements will be compatible with that initial implementations also and will prevent Moodle to use a long term deprecation protocol and release 3.9 with a more complete xAPI solution. Link to the xAPI specification:
27.summary: Integrate content bank and H5P content creator
description: As an instructional designer I want to create H5P new content in the content bank So that I can share my brand new content with other users in the site . Acceptance criteria: Be able to access H5P editor via content bank and create new H5P content from scratch. Be able to manage created H5P content as any other content in the content bank. . List of tasks: Define information wokflow between content bank and H5P content editor. Implement needed classes, method and functions to fully integrate H5P content editor and content bank management system. Add new PHP Unit tests Add behat tests or create a new issue to add them Prototype:
28.summary: Prepare Moodle to be ready when p.org down completely so that only the author can see the test content
description: H5P will do some changes this year to close p.org down completely so that only the author can see the test content. So, we have to remove all the p.org references from Moodle and move or remove URL/embed code in H5P atto plugin to H5P advanced options in the H5P atto plugin. Also, we have to update the Doc, according to these changes. . List of tasks Remove p.org from "Allowed sources" for the Display H5P filter. Review the H5P Atto button, to remove the embed part (in order to simplify this screen, because this part was added to make easier include content coming from p.org).
29.summary: H5P editor: integrate translations with Moodle String API
description: H5P editor has a folder with all supported languages (and their translations) in JS files. It would be good to integrate these translations to Moodle String API, in order to make easier to translate them.
30.summary: H5P Editor: evaluate the change of the built-in WYSIWYG editor
description: The H5P editor comes with CKEditor| as the default WYSIWYG editor. At this time, there is no option to change this editor. CKEditor is not natively supported by Moodle, and we are not considering adding a new editor. Lets research if it is possible to change/remove the CKEditor and make the required changes accordingly.
31.summary: Improve CSS for content bank templates
description: In some templates and CSS has been created based on Moodles file-picker to style the content bank in a similar way to file-picker, but to allow to customize it based on it own specific needs. Most of the CSS can be replaced with bootstrap utility classes, so theres room for improvement. This issue is to work on those improvements.
32.summary: Implement H5P attempt deletion option on reset course
description: Implement the specific reset options for mod_pactivity.This way when users go to reset course they can choose to delete H5P attempts as well.
33.summary: H5P editor: support content-type translations
description: H5P content-type libraries have their own JS language files. For now, the very first version of the editor () doesnt implement the required methods for loading and using the information on these language files. . List of tasks Implement the required methods for supporting content-type libraries localization. Investigate the best approach to load this information: database table vs MUC. Try to find a mechanism to let users upgrade language strings (depending on the final solution, this could be done on a separate issue).
34.summary: Create xAPI activity report inside mod_p
description: Add the possibility to show a report on the xAPI statements reported to a specific mod_p activity. This issue include: Add a attempts view in the mod_p Display the log data from the xAPI statement posted by a specific attempt Add behat test for this features
35.summary: Backup and restore options for course level content bank
description: During course backup and restore process, content bank content should be backup and restored with the rest of the data. Contents from other contexts content banks picked as reference in courses activities/resources will be added to the backup file as a copy. So the relation between those contents and the content bank will be cut in the restored course.
36.summary: New WebService mod_pactivity_get_pactivity_access_information
description: This WS should return access information required by an external client to check if and how to display the activity module. For p, since it seems there are no special conditions to check, it should be enough to return the module capabilities and if the current user has the capabilities enabled or not. Check mod_scorm_get_scorm_access_information for reference
37.summary: New WebService mod_pactivity_get_pactivities_by_courses
description: This WS is required by the Moodle app in order to fetch the activity information for displaying it to app users. Please, note that this WS should return all the information in the pactivity table. Exporters should be used to export the table information if possible. Check mod_workshop_external::get_workshops_by_courses for reference (it should look practically the same)
38.summary: Add xAPI result support on mod_pactivity
description: Once the mod_pactivity accepts tracking information, the xAPI result in statement must be converted and stored in the gradebook.
39.summary: New WebService mod_pactivity_view_pactivity
description: This WS is required for triggering the course module viewed event and update the module completion status from an external client for an H5Pactivity. For reference, check the WS functions: mod_workshop_external_view_workshop or mod_lesson_external_view_lesson
40.summary: Existing H5P content edition via content bank
description: As an instructional designer I want to edit existing H5P in the content bank So that I can improve, update or fix existing H5P content in the site . Acceptance criteria: Be able to access H5P editor via content bank to change existing H5P content. . List of tasks: Define information wokflow between content bank and H5P content editor to fill the editor with existing content. Implement needed classes, method and functions to edit existing H5P content. Add new PHP Unit tests Add behat tests or create a new issue to add them
41.summary: Create a new view type list in the Content Bank
description: As an instructional designer I want to see the contents in mode list view in the content bank So that I can sort the contents by date, size, name or type. . Acceptance criteria: Be able to see the contents in mode list view in the content bank. (See the screenshot called contentbanklistview.png) Be able to sort the contents by name, last modified, size and type. Be able to see the vertical scrollbar when the content were are many. Be able to search the content using the "Search" input in the list view. Be able to change the type of view between list view and icon view. Icon view should be ordered by name. . Note See the prototype|
42.summary: The H5P check_updates_since callback should return H5P attempts information
description: The check_updates_since callback checks if the module has any update that affects the current user for a given time. This function is used by the Moodle app to update the "downloaded" status of offline activities so we can let our users know that there are updates in the Moodle site that need to be synchronised in the app. The callback is missing updates information related to attempts (pactivity_attempts table) because they may affect the user or the information displayed in the app. A reference implementation can be found in mod/scorm/lib.php
43.summary: Implement search functionality for the repository_contentbank
description: As a teacher I want to be able to search in the content bank repository by contents name So that I can find the content I need to select in the file picker . Acceptance criteria: Be able to search content by name in the content bank repository Reset search criteria to see all content in the content bank repository . List of tasks: Implement needed methods or functions to search in the content bank repository. Design and implement search results view. Reset the search criteria in order to go back to see all view.
44.summary: Add duration, completion and success to H5P activity attempts
description: H5P xAPI statements can provide a duration field to know the time spent in that content. In order to have a better attempt report, this data should be stored in the attempts table. It happens the same with other fields like result.completion and result.success that can be helpful for future features like completion conditions and must be stored in attempts as well.
45.summary: Add a new index for contextid in the contentbank_content
description: Adding an index to "contextid" in the contentbank_content table will optimize the query (which would be good also for the contentbank repository and the search feature).
46.summary: Implement search functionality for the content bank
description: As an instructional designer I want to be able to search in the content bank by contents name So that I can find the content I need . Acceptance criteria: Be able to search content by name in the content bank Be able to go back to see all content in the content bank . List of tasks: Design and implement search results view Design and implement a way to go back to see all view . Prototype:
47.summary: Create a new repository for the content bank
description: As a teacher I want to select from the file picker the H5P content created in the Content bank So that I can reuse it easily everywhere (activities, resources...). . Acceptance criteria: Create a new repository for users to be able to select and reuse content uploaded/created in the Content bank. Show the content in the content bank inside the file picker. Select content from this repository and attach it everywhere where the file picker is displayed. . List of tasks: Create new repository_contentbank plugin skeleton Adapt or create DB tables as needed Create capabilities Implement the Privacy API or implement a null privacy provider and create a new issue Create a view for the content bank to be shown inside the repository_contentbank
48.summary: New mobile WebService to support mod_pactivity_get_results
description: In order to be able to access the H5P reports it is necessary some WS. This WS should return the necessary data to display the results report in the official moodle app. In this case, the data from the report export_to_template should work. Check mod_scorm_get_scorm_access_information for reference. And for the other mobile WS on mod_pactivity
49.summary: New mobile WebService to support mod_pactivity_get_attempts
description: In order to be able to access the H5P reports it is necessary a WS. This WS should return the necessary data to display the attempts report in the official moodle app. In this case, the data from the report export_to_template should work. Check mod_scorm_get_scorm_access_information for reference. And for the other mobile WS on mod_pactivity.
50.summary: Render specific icons for different H5P content types in content bank
description: Following the prototype ( we should render an specific H5P icon for different H5P content types instead of the default one. Because we need to deploy the H5P content to know the H5P content type in each package, we will change the current workflow to redirect to content view page when a new content is uploaded.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: H5P for Moodle 3.9
description: Further development of the H5P integration| Integration of H5P content types with Moodle gradebook and activity completion. Improved integration of H5P content type selection in Moodles activity chooser.
### Response:
1.summary: Improve admin UI to manage H5P libraries and give information about H5P tools status
description: Improve admin UI for H5P management: Add icons to installed content types list in Site administration > H5P > Manage H5P content types Add a new page to show the admins information about the status of different H5P tools installed: tool name, status and description. Would be good to have links to management page for each tool from this new overview page, and an option to run the scheduled task without having to access to the Scheduled tasks page if everything is configured properly.
2.summary: Add Admin UI to delete existing H5P libraries
description: Whilst reviewing the H5P integration () an issue has been raised to control who can install/update the content-type libraries. The list of all the content-type libraries will be displayed in a page. Admins should be able to remove libraries from here too.
3.summary: Implement search API for the content bank
description: As an instructional designer I want to be able to search in the content bank by contents name So that I can find the content I need . List of tasks: Implement needed methods or functions to search in the content bank.
4.summary: Add a mechanism to support multi H5P core_api versions
description: H5P integration is composed of: A core library: A set of PHP + JS code, currently at version 1.24. The content types. The content types available through their API. The content types make use of features in the core library. User-content: Content using those content-type. The issue is that H5P frequently updates its core library. When they do so: They reserve the right to make their content types require the latest version of the core library. If that version is not available, they tell you to upgrade the core library. Where the content type is upgraded in tandem with the core library, then we are now saying that you must update your content to require the latest version of that content type... which now requires the latest version. Other known issues: The libraries are non-trivial to upgrade because they may introduce breaking API changes which we need to implement something on our side to solve; Some customizations have been done in order to improve the integration with the Moodle API. We will need to decide which is the best way to proceed for upgrading the library core. Some approaches (there may be more): Move the current integration to a new plugin in a new plugintype with the option of installing additional plugintypes. Create a third-party plugin for upgrading it ( such as the app does with the additional features 3rd party plugin). Update the H5P core library in Moodle with each minor release (treat it as a security issue).
5.summary: New activity icon for H5P
description: Right now we are using the same icon as the current plugin. Since it will be displayed as a native activity among other activities, its icon should follow the same aesthetics.
6.summary: H5P: get site UUID using H5P API
description: adds a task to install the latest version of the H5P content types. It requires connecting to the H5P API, whose endpoints expects a POST with "application/x-www-form-urlencoded" data, which must at least include the sites UUID. Although the sites UUID could be generated locally, with the only limitation of not being longer than 36 characters, the correct way to do this is to send a request to the "api.p.org/v1/sites" endpoint without any UUID and obtain a unique UUID that will be registered for the site. The goal of this issue is getting the UUID from the H5P API and use it in any H5P API request. Submission of additional information, although not sensitive, should be acknowledged by a site administrator, and is beyond the scope of this issue. Source:
7.summary: Apply Display H5P filter inside tags
description: As explained in Display H5P filter is ignoring H5P URLs inside tags like But when somebody copy an H5P content URL from a Chrome browser address bar and paste it in Moodle rich text editor, is pasted as a link, inside tags. So Display H5P filter is not applied in those cases. Convert URLs into links and images filter is ignoring content inside tags as well, but Multimedia plugins filter is not ignoring them. So maybe the best behavior for filters should be decided and implement it consistently all along Moodle filters.
8.summary: H5P player should accept webservice/pluginfile.php and tokenpluginfile.php URLs
description: Right now the player only accepts /pluginfile.php URLs to find the p files. It would be nice if it also accepted webservice/pluginfile.php and tokenpluginfile.php URLs, since theyre also valid URLs to retrieve the file. E.g. this URL works fine: But this one gives an error: H5P file not found (invalid contextid)
9.summary: H5P editor integration
description: . Summary Integrate the H5P editor with all its functionality in core. Based on the H5P Editor PHP library and the mod_hvp plugin. . User stories _As an instructional designer_ _I want to modify an existing H5P content_ _So I edit the content in the H5P editor_ _As an instructional designer_ _I want to create a new H5P content_ _So I create the content in the H5P editor_ . Tasks - Add H5P editor library in core (lib/p/editor) - Moodle-ish the implementation of the interfaces (following Moodle coding standards) - Display inside a standalone form (lib/p/editor.php) - Integrate translations with Moodle (if possible)
10.summary: Add a delete content option to the content bank
description: As an instructional designer I want to be able to remove existing content from the content bank So that I can delete wrong or old content . Acceptance criteria: Be able to delete existing content. The user would see a warning message because we cant know if that content is in use, or where is used. The user could confirm or cancel deletion. . List of tasks: Implement needed methods or functions to delete content. Implement needed capabilities to delete own/other users content. Implement the warning informing the user. Adapt H5P player to be sure theres no error if the file to render doesnt exist.
11.summary: Add xAPI statement support to mod_p
description: Implement the required classes to use xAPI statement post inside mod_p. This implementation requires: Implement the extension of xapi_statement_base as \mod_p\xapi_handler class which override: statement_to_event: convert a xAPI statement to a mod_p event (plus programming that event) Add xAPI LRS URL to mod_p player and implement the JS method to send xAPI statements from the H5P content Code behat tests
12.summary: Create a new contentbank plugin type and a new H5P plugin in the content bank
description: As an instructional designer I want to have a shared content bank So that I can share content with other users in the site As an instructional designer I want to be able to upload H5P fils to the content bank So that I can share content with other users in the site . Acceptance criteria: Be able to upload some H5P content that everybody with proper permission can see. Be able to implement plugins that would manage some other content type and share with other users. . List of tasks: Create new contentbank plugin type Create DB tables as needed for the content bank Create generic capabilities for the Content Bank Implement a null privacy provider for now Create a new view page Create a new H5P contentbank plugin Adapt or create DB tables as needed for the plugin Create capabilities for the H5P plugin. Implement a null privacy provider for the plugin Implement the option to upload H5P content to content bank Add new PHP Unit tests Add behat tests or create a new issue to add them
13.summary: Create a new H5P activity
description: As a teacher I want to create an H5P content activity So that I can use the H5P activities as other Moodle activities . Acceptance criteria: Create a new activity type for teachers to be able to upload an H5P file and render it in the course. Be able to define activities standard options such as Availability, Restrict access and other common module settings. . List of tasks: Create new mod_p plugin skeleton Adapt or create DB tables as needed Create capabilities Implement a null privacy provider for now Create a new edit page and its form Create a new view page Implement Moodles basic activity completion not using H5P completion Add behat tests or create a new issue to add them
14.summary: Implement events for H5P content bank
description: As a manager I want to log users activity So that I can check when H5P content in the content bank has been created, updated, deleted or viewed. . Acceptance criteria: Log when content in the H5P content bank has been created. Log when content in the H5P content bank has been updated. Log when content in the H5P content bank has been deleted. Log when content in the H5P content bank has been viewed. . List of tasks: Create contentbank_p viewed event. Create contentbank_p created event. Create contentbank_p updated event. Create contentbank_p deleted event.
15.summary: Implement appropriate privacy provider for H5P activity
description: As a user I want H5P activity implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the H5P module privacy provider. . List of tasks: Implement provider class for mod_p
16.summary: Implement events for H5P activity
description: As a teacher I want to log users activity So that I can when H5P activity has been created, updated, deleted or viewed. . Acceptance criteria: Log when a H5P activity has been created. Log when a H5P activity has been updated. Log when a H5P activity has been deleted. Log when a H5P activity has been viewed. . List of tasks: Create mod_p viewed event. Create mod_p created event. Create mod_p updated event. Create mod_p deleted event.
17.summary: Create basic skeleton for a global xAPI library needed for H5P content
description: A basic xAPI LRS support is needed In order to get statements from H5P content. This first issue will cover the following needs: Have a "lib/xAPI" library for the main LRS access point A generic Moodle webservice layer which wraps a xAPI statement processing xAPI handler base classes which every plugin can extend to use xAPI on their code xAPI statement class to generate xAPI statements with all related classes for handling actors (user, group), objects and verbs (the rest of xAPI properties would be compatible but validations will be responsibility of every plugin for now). PHPUnit test Null privacy provider The web service for processing a xAPI statement will delegate part of the process to specific plugins like the future mod_p. . xAPI generic webservice (component, statement) The web service receive a frankenstyle component responsible to handle part of the statement and a xAPI statement structure. xAPI Statement generic processing method will: xAPI checks the statement structure, if any check fails, it returns an error. That means: Check that only supported xAPI attributes are used Check all users and groups are created in the LMS xAPI checks if the component has a xAPI handling class implementation. Otherwise it returns an error. For every statement: xAPI asks again the plugin to you convert into a standard event. In case the plugin could not convert some statement into an event, this statement will be marked as rejected and xAPI continue to the next statement. xAPI handler will trigger all the generated events Once all statements are processed: If ALL statements are marked as not processed it returns an error. If some statement could be processed, returns an array containing true if the statement is processed and false" otherwise.
18.summary: Add generic statement support for xAPI library
description: Create the elements needed for handling statement in the xAPI LRS library: Basic xAPI statement post event used in cases where plugins not implement its own events The generic Statement handling base class that plguins can extend to post xAPI statements. Statement JSON basic schema validation in the rest xAPI LRS library PHP Unit Tests for the previous 3 components
19.summary: Implement appropriate privacy provider for content bank
description: As a user I want content bank implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the content bank privacy provider. Export data for all the contexts allowed (System, Course Category and Course). . List of tasks: Implement provider class for contentbank
20.summary: Implement appropriate privacy provider for H5P content bank plugin
description: As a user I want H5P content bank implements the right privacy provider based on the user data stored So that my privacy rights are protected . Acceptance criteria: All user content information should be managed by the H5P content bank privacy provider. . List of tasks: Implement provider class for contentbank_p
21.summary: Implement events for content bank
description: As a manager I want to log users activity So that I can check when content in the content bank has been created, updated, deleted or viewed. . Acceptance criteria: Log when content in the content bank has been uploaded. Log when content in the content bank has been updated. Log when content in the content bank has been deleted. Log when content in the content bank has been viewed. . List of tasks: Create contentbank viewed event. Create contentbank uploaded event. Create contentbank updated event. Create contentbank deleted event.
22.summary: Rename content in the content bank
description: As an instructional designer I want to have the option to change the name of the content So that I can correct mistakes, typos, order content in a better way or make the content easier to find. . Acceptance criteria: Be able to change existing contents name. . List of tasks: Implement functions needed to change the name of the content. Create or use capabilities to update content. Implement the UI to rename content.
23.summary: H5P deployment needs to lock
description: When deploying a new H5P resource we need to ensure that we dont start deploying the same H5P in another thread (e.g. for another session/user). At the moment this is possible: Login as a user and upload the course-presentation.p Use the test-p.html file to test it Whilst it unpacks open a different browser or a private browsing tab Log in at the same user (or a different one) and view the same p file again Wait Observe that in the 2nd and all subsequent loads we get a warning: code Error: mdb->get_record() found more than one record! line 1599 of /lib/dml/moodle_database.php: call to debugging() line 1559 of /lib/dml/moodle_database.php: call to moodle_database->get_record_sql() line 1538 of /lib/dml/moodle_database.php: call to moodle_database->get_record_select() line 235 of /p/classes/player.php: call to moodle_database->get_record() line 101 of /p/classes/player.php: call to core_p\player->get_p_id() line 39 of /p/embed.php: call to core_p\player->__construct() code
24.summary: Add copyright and download settings to H5P activity
description: Add to the H5P activity the same settings ATTO H5P plugin have: Allow download Embed button Copyright button
25.summary: Include H5P Activity backup and restore options
description: As a manager I want to able to include H5P activity in course backup and restore process So that I can backup and restore courses with all their activities . Acceptance criteria: H5P activities should be included in the course backup file. H5P activities should be restored from course backup files. . List of tasks: Implement backup classes for mod_p Implement restore classes for mod_p
26.summary: Add support for result, attachments, context to core_xapi library
description: The basic xAPI library covers actor, verb, object parts of statement but uses generic items as attachment, result or context. In case some early adopters uses that other statement properties will difficult the future grow of that library. By implementing basic classes for handling those properties future improvements will be compatible with that initial implementations also and will prevent Moodle to use a long term deprecation protocol and release 3.9 with a more complete xAPI solution. Link to the xAPI specification:
27.summary: Integrate content bank and H5P content creator
description: As an instructional designer I want to create H5P new content in the content bank So that I can share my brand new content with other users in the site . Acceptance criteria: Be able to access H5P editor via content bank and create new H5P content from scratch. Be able to manage created H5P content as any other content in the content bank. . List of tasks: Define information wokflow between content bank and H5P content editor. Implement needed classes, method and functions to fully integrate H5P content editor and content bank management system. Add new PHP Unit tests Add behat tests or create a new issue to add them Prototype:
28.summary: Prepare Moodle to be ready when p.org down completely so that only the author can see the test content
description: H5P will do some changes this year to close p.org down completely so that only the author can see the test content. So, we have to remove all the p.org references from Moodle and move or remove URL/embed code in H5P atto plugin to H5P advanced options in the H5P atto plugin. Also, we have to update the Doc, according to these changes. . List of tasks Remove p.org from "Allowed sources" for the Display H5P filter. Review the H5P Atto button, to remove the embed part (in order to simplify this screen, because this part was added to make easier include content coming from p.org).
29.summary: H5P editor: integrate translations with Moodle String API
description: H5P editor has a folder with all supported languages (and their translations) in JS files. It would be good to integrate these translations to Moodle String API, in order to make easier to translate them.
30.summary: H5P Editor: evaluate the change of the built-in WYSIWYG editor
description: The H5P editor comes with CKEditor| as the default WYSIWYG editor. At this time, there is no option to change this editor. CKEditor is not natively supported by Moodle, and we are not considering adding a new editor. Lets research if it is possible to change/remove the CKEditor and make the required changes accordingly.
31.summary: Improve CSS for content bank templates
description: In some templates and CSS has been created based on Moodles file-picker to style the content bank in a similar way to file-picker, but to allow to customize it based on it own specific needs. Most of the CSS can be replaced with bootstrap utility classes, so theres room for improvement. This issue is to work on those improvements.
32.summary: Implement H5P attempt deletion option on reset course
description: Implement the specific reset options for mod_pactivity.This way when users go to reset course they can choose to delete H5P attempts as well.
33.summary: H5P editor: support content-type translations
description: H5P content-type libraries have their own JS language files. For now, the very first version of the editor () doesnt implement the required methods for loading and using the information on these language files. . List of tasks Implement the required methods for supporting content-type libraries localization. Investigate the best approach to load this information: database table vs MUC. Try to find a mechanism to let users upgrade language strings (depending on the final solution, this could be done on a separate issue).
34.summary: Create xAPI activity report inside mod_p
description: Add the possibility to show a report on the xAPI statements reported to a specific mod_p activity. This issue include: Add a attempts view in the mod_p Display the log data from the xAPI statement posted by a specific attempt Add behat test for this features
35.summary: Backup and restore options for course level content bank
description: During course backup and restore process, content bank content should be backup and restored with the rest of the data. Contents from other contexts content banks picked as reference in courses activities/resources will be added to the backup file as a copy. So the relation between those contents and the content bank will be cut in the restored course.
36.summary: New WebService mod_pactivity_get_pactivity_access_information
description: This WS should return access information required by an external client to check if and how to display the activity module. For p, since it seems there are no special conditions to check, it should be enough to return the module capabilities and if the current user has the capabilities enabled or not. Check mod_scorm_get_scorm_access_information for reference
37.summary: New WebService mod_pactivity_get_pactivities_by_courses
description: This WS is required by the Moodle app in order to fetch the activity information for displaying it to app users. Please, note that this WS should return all the information in the pactivity table. Exporters should be used to export the table information if possible. Check mod_workshop_external::get_workshops_by_courses for reference (it should look practically the same)
38.summary: Add xAPI result support on mod_pactivity
description: Once the mod_pactivity accepts tracking information, the xAPI result in statement must be converted and stored in the gradebook.
39.summary: New WebService mod_pactivity_view_pactivity
description: This WS is required for triggering the course module viewed event and update the module completion status from an external client for an H5Pactivity. For reference, check the WS functions: mod_workshop_external_view_workshop or mod_lesson_external_view_lesson
40.summary: Existing H5P content edition via content bank
description: As an instructional designer I want to edit existing H5P in the content bank So that I can improve, update or fix existing H5P content in the site . Acceptance criteria: Be able to access H5P editor via content bank to change existing H5P content. . List of tasks: Define information wokflow between content bank and H5P content editor to fill the editor with existing content. Implement needed classes, method and functions to edit existing H5P content. Add new PHP Unit tests Add behat tests or create a new issue to add them
41.summary: Create a new view type list in the Content Bank
description: As an instructional designer I want to see the contents in mode list view in the content bank So that I can sort the contents by date, size, name or type. . Acceptance criteria: Be able to see the contents in mode list view in the content bank. (See the screenshot called contentbanklistview.png) Be able to sort the contents by name, last modified, size and type. Be able to see the vertical scrollbar when the content were are many. Be able to search the content using the "Search" input in the list view. Be able to change the type of view between list view and icon view. Icon view should be ordered by name. . Note See the prototype|
42.summary: The H5P check_updates_since callback should return H5P attempts information
description: The check_updates_since callback checks if the module has any update that affects the current user for a given time. This function is used by the Moodle app to update the "downloaded" status of offline activities so we can let our users know that there are updates in the Moodle site that need to be synchronised in the app. The callback is missing updates information related to attempts (pactivity_attempts table) because they may affect the user or the information displayed in the app. A reference implementation can be found in mod/scorm/lib.php
43.summary: Implement search functionality for the repository_contentbank
description: As a teacher I want to be able to search in the content bank repository by contents name So that I can find the content I need to select in the file picker . Acceptance criteria: Be able to search content by name in the content bank repository Reset search criteria to see all content in the content bank repository . List of tasks: Implement needed methods or functions to search in the content bank repository. Design and implement search results view. Reset the search criteria in order to go back to see all view.
44.summary: Add duration, completion and success to H5P activity attempts
description: H5P xAPI statements can provide a duration field to know the time spent in that content. In order to have a better attempt report, this data should be stored in the attempts table. It happens the same with other fields like result.completion and result.success that can be helpful for future features like completion conditions and must be stored in attempts as well.
45.summary: Add a new index for contextid in the contentbank_content
description: Adding an index to "contextid" in the contentbank_content table will optimize the query (which would be good also for the contentbank repository and the search feature).
46.summary: Implement search functionality for the content bank
description: As an instructional designer I want to be able to search in the content bank by contents name So that I can find the content I need . Acceptance criteria: Be able to search content by name in the content bank Be able to go back to see all content in the content bank . List of tasks: Design and implement search results view Design and implement a way to go back to see all view . Prototype:
47.summary: Create a new repository for the content bank
description: As a teacher I want to select from the file picker the H5P content created in the Content bank So that I can reuse it easily everywhere (activities, resources...). . Acceptance criteria: Create a new repository for users to be able to select and reuse content uploaded/created in the Content bank. Show the content in the content bank inside the file picker. Select content from this repository and attach it everywhere where the file picker is displayed. . List of tasks: Create new repository_contentbank plugin skeleton Adapt or create DB tables as needed Create capabilities Implement the Privacy API or implement a null privacy provider and create a new issue Create a view for the content bank to be shown inside the repository_contentbank
48.summary: New mobile WebService to support mod_pactivity_get_results
description: In order to be able to access the H5P reports it is necessary some WS. This WS should return the necessary data to display the results report in the official moodle app. In this case, the data from the report export_to_template should work. Check mod_scorm_get_scorm_access_information for reference. And for the other mobile WS on mod_pactivity
49.summary: New mobile WebService to support mod_pactivity_get_attempts
description: In order to be able to access the H5P reports it is necessary a WS. This WS should return the necessary data to display the attempts report in the official moodle app. In this case, the data from the report export_to_template should work. Check mod_scorm_get_scorm_access_information for reference. And for the other mobile WS on mod_pactivity.
50.summary: Render specific icons for different H5P content types in content bank
description: Following the prototype ( we should render an specific H5P icon for different H5P content types instead of the default one. Because we need to deploy the H5P content to know the H5P content type in each package, we will change the current workflow to redirect to content view page when a new content is uploaded.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle Community Sites
summary: Moodle community sites 3.3.1 upgrade
description: Moodle 3.3.1 is scheduled for release on Monday 10 July 2017.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.3.1
description:
2.summary: Upgrade learn.moodle.net to 3.3.1
description:
3.summary: Upgrade lang.moodle.org to 3.3.1
description:
4.summary: Upgrade school.demo.moodle.net to 3.3.1
description:
5.summary: Upgrade demo.moodle.net to 3.3.1
description:
6.summary: Upgrade dev.moodle.org to 3.3.1
description:
7.summary: Upgrade moodle.net to 3.3.1
description:
8.summary: Upgrade download.moodle.org to 3.3.1
description:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle Community Sites
summary: Moodle community sites 3.3.1 upgrade
description: Moodle 3.3.1 is scheduled for release on Monday 10 July 2017.
### Response:
1.summary: Upgrade moodle.org to 3.3.1
description:
2.summary: Upgrade learn.moodle.net to 3.3.1
description:
3.summary: Upgrade lang.moodle.org to 3.3.1
description:
4.summary: Upgrade school.demo.moodle.net to 3.3.1
description:
5.summary: Upgrade demo.moodle.net to 3.3.1
description:
6.summary: Upgrade dev.moodle.org to 3.3.1
description:
7.summary: Upgrade moodle.net to 3.3.1
description:
8.summary: Upgrade download.moodle.org to 3.3.1
description:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Improvements to CSS and themes
description: This epic is a collection of improvements raised in the discussion and dev docs here: and here: The overall goal is to improve our CSS and provide better guidelines for developers.
| Solvable | 1.summary: Add to docs page the relationship between base, bootstrapbase and clean themes.
description: We need a clear policy on where to apply fixes, mobile enhancements, responsive elements and more. If we add a layer of mobile enhancements to bootstrapbase, we are adding more code that themers may not want (especially if they are designing for mobile already). If we add this code to clean we will make clean very complex and harder to use as a template. I think we need a new theme that inherits on bootstrapbase that we can use to add complicated responsive enhancements. Themers can then choose to inherit from the vanilla bootstrapbase, or this enhanced version.
2.summary: Add CSS template library to the docs
description: We need to document our reusable patterns of HTML/CSS so we dont repeat the same CSS over and over for each plugin/core component with specific selectors. Totara has an element library plugin which is a good starting point, but needs to be expanded. This should document the current patterns/elements in Moodle 2.5 and list changes to those patterns/elements in releases. This will greatly benefit themers as it will reduce the list of custom styles they have to override. More reading:
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Improvements to CSS and themes
description: This epic is a collection of improvements raised in the discussion and dev docs here: and here: The overall goal is to improve our CSS and provide better guidelines for developers.
### Response:
1.summary: Add to docs page the relationship between base, bootstrapbase and clean themes.
description: We need a clear policy on where to apply fixes, mobile enhancements, responsive elements and more. If we add a layer of mobile enhancements to bootstrapbase, we are adding more code that themers may not want (especially if they are designing for mobile already). If we add this code to clean we will make clean very complex and harder to use as a template. I think we need a new theme that inherits on bootstrapbase that we can use to add complicated responsive enhancements. Themers can then choose to inherit from the vanilla bootstrapbase, or this enhanced version.
2.summary: Add CSS template library to the docs
description: We need to document our reusable patterns of HTML/CSS so we dont repeat the same CSS over and over for each plugin/core component with specific selectors. Totara has an element library plugin which is a good starting point, but needs to be expanded. This should document the current patterns/elements in Moodle 2.5 and list changes to those patterns/elements in releases. This will greatly benefit themers as it will reduce the list of custom styles they have to override. More reading:
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Messaging improvements
description: Some changes we would like to see done for 3.3.
| Unsolvable | 1.summary: A site configuration option to limit contacts search and messaging based on the courses you are in
description: A site configuration option to limit contacts search and messaging based on the courses you are in - if you are a student
2.summary: Send messages to members in groups
description: A function for sending messages to (multiple) groups. For example: Teacher wants to send message to all members in group A, D, E without addressing the students individually. Today there isnt any easy way to accomplish this.
3.summary: When we have a button or link that toggles the state - it should reflect the current state
description: All buttons / links that toggle state should be indicators of the current state - not the state the thing will switch to when you activate the button/link. E.g. "Block contact" should not be red because the contact is not currently blocked.
4.summary: Site-wide option to force messages only from contacts
description: We need a site wide setting so that users can specify they only want messages from contacts. This should also probably be a user preference as well. We also need to change the contact system so it behaves more like friends on FB, where both parties need to agree to it before it works. That way we prevent users simply adding a user as a contact before messaging them.
5.summary: Remove in-line styles in the JS.
description: We currently center the loading template in the messaging area, and rather than style the loading-icon CSS style with text-align: center (because it is a span and wont work) we place it in an outer div with the style hard-coded. This is bad.
6.summary: Private reply in forums
description: Add ability to reply privately to individual users from a forum. I guess that should send a message using the messaging system.
7.summary: Change "Edit" to an icon in messaging app
description: Marina mentioned that it might be worth changing "Edit" to an icon because that word has some long translations that can mess with the layout (see Russian language pack). Check if that is the case and then make the change if required.
8.summary: Messaging as a blocked user throws exception
description: Trying to message a user that has blocked you gives an error dialogue in the messages ui rather than just notifying the user that the user has blocked them. It should either pop up a non error dialogue or render the interface slightly differently to indicate the user is blocked and disable the messaging text area and stuff.
9.summary: Confusing Edit link on messages page
description: It was a surprise to me to find that the Edit link is actually for deleting a message! It is especially confusing when there are no messages. Is it possible to make things similar to elsewhere in Moodle e.g. use an x icon? If there are no messages, is it possible to not show the option to delete messages?
10.summary: Move API to one location
description: Currently messaging functions exist in message/lib.php and message/classes/api.php. Lets move them all to api.php and deprecate the ones in message/lib.php
11.summary: Move notifications into separate table
description: Once we merge the messaging tables it would be a further improvement to then split notifications into a separate table and stop treating them as special messages.
12.summary: Make message search box search not only message content but user name
description: When using the message search box, text gets searched in message contents, not usernames. Wouldnt it be nice if one could search for usernames too ?
13.summary: Add ability to send images via the messaging interface
description: let users allow send files through message. users can share their resources with message.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Messaging improvements
description: Some changes we would like to see done for 3.3.
### Response:
1.summary: A site configuration option to limit contacts search and messaging based on the courses you are in
description: A site configuration option to limit contacts search and messaging based on the courses you are in - if you are a student
2.summary: Send messages to members in groups
description: A function for sending messages to (multiple) groups. For example: Teacher wants to send message to all members in group A, D, E without addressing the students individually. Today there isnt any easy way to accomplish this.
3.summary: When we have a button or link that toggles the state - it should reflect the current state
description: All buttons / links that toggle state should be indicators of the current state - not the state the thing will switch to when you activate the button/link. E.g. "Block contact" should not be red because the contact is not currently blocked.
4.summary: Site-wide option to force messages only from contacts
description: We need a site wide setting so that users can specify they only want messages from contacts. This should also probably be a user preference as well. We also need to change the contact system so it behaves more like friends on FB, where both parties need to agree to it before it works. That way we prevent users simply adding a user as a contact before messaging them.
5.summary: Remove in-line styles in the JS.
description: We currently center the loading template in the messaging area, and rather than style the loading-icon CSS style with text-align: center (because it is a span and wont work) we place it in an outer div with the style hard-coded. This is bad.
6.summary: Private reply in forums
description: Add ability to reply privately to individual users from a forum. I guess that should send a message using the messaging system.
7.summary: Change "Edit" to an icon in messaging app
description: Marina mentioned that it might be worth changing "Edit" to an icon because that word has some long translations that can mess with the layout (see Russian language pack). Check if that is the case and then make the change if required.
8.summary: Messaging as a blocked user throws exception
description: Trying to message a user that has blocked you gives an error dialogue in the messages ui rather than just notifying the user that the user has blocked them. It should either pop up a non error dialogue or render the interface slightly differently to indicate the user is blocked and disable the messaging text area and stuff.
9.summary: Confusing Edit link on messages page
description: It was a surprise to me to find that the Edit link is actually for deleting a message! It is especially confusing when there are no messages. Is it possible to make things similar to elsewhere in Moodle e.g. use an x icon? If there are no messages, is it possible to not show the option to delete messages?
10.summary: Move API to one location
description: Currently messaging functions exist in message/lib.php and message/classes/api.php. Lets move them all to api.php and deprecate the ones in message/lib.php
11.summary: Move notifications into separate table
description: Once we merge the messaging tables it would be a further improvement to then split notifications into a separate table and stop treating them as special messages.
12.summary: Make message search box search not only message content but user name
description: When using the message search box, text gets searched in message contents, not usernames. Wouldnt it be nice if one could search for usernames too ?
13.summary: Add ability to send images via the messaging interface
description: let users allow send files through message. users can share their resources with message.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: MUA Project: Make Atto Editor more accessible
description: This epic covers deliverable elements of the MUA "Make Atto Editor more accessible" project described in . Issues created in this epic must be linked back to the relevant user stories that they solve. The intent of this issue is to bring together the project into a single issue covering most of the functionality and submit for integration.
| Unsolvable | 1.summary: Use aria-expanded to indicate the state of the "Show/hide advanced buttons" button
description: we should add the aria-expanded attribute to the "Show/hide advanced buttons" button. Maybe aria-pressed="true" as well.
2.summary: Move the screen reader helper button to the first row
description: Move the screen reader helper button to the first row so that they are visible even when the advanced buttons are hidden.
3.summary: Add aria-pressed to the toolbar buttons that are toggle buttons
description: Buttons like Bold, Italic, Superscript are toggle buttons. They have a selected or unselected state. So we need to use aria-pressed to indicate their state.
4.summary: Give users an indication that they encountered an editor
description: When using Atto, you land on a series of buttons without being warned of the presence of a text editor. Only JAWS mentions that there is a toolbar based on the "toolbar" role of the button group. But that does not constitute an explicit mention of the presence of the publisher. Additionally, users of screenreaders may need assistance getting started with this interactive component. So I suggest placing a little offscreen text that precedes the text editor: "You are going to meet a text editor. If you need help navigating this component, activate the following button: ". The help button, also displayed off-screen, would command the opening of an accessible dialog box, as in the following example Example on the image: !screenshot-1.png! !screenshot-2.png!
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: MUA Project: Make Atto Editor more accessible
description: This epic covers deliverable elements of the MUA "Make Atto Editor more accessible" project described in . Issues created in this epic must be linked back to the relevant user stories that they solve. The intent of this issue is to bring together the project into a single issue covering most of the functionality and submit for integration.
### Response:
1.summary: Use aria-expanded to indicate the state of the "Show/hide advanced buttons" button
description: we should add the aria-expanded attribute to the "Show/hide advanced buttons" button. Maybe aria-pressed="true" as well.
2.summary: Move the screen reader helper button to the first row
description: Move the screen reader helper button to the first row so that they are visible even when the advanced buttons are hidden.
3.summary: Add aria-pressed to the toolbar buttons that are toggle buttons
description: Buttons like Bold, Italic, Superscript are toggle buttons. They have a selected or unselected state. So we need to use aria-pressed to indicate their state.
4.summary: Give users an indication that they encountered an editor
description: When using Atto, you land on a series of buttons without being warned of the presence of a text editor. Only JAWS mentions that there is a toolbar based on the "toolbar" role of the button group. But that does not constitute an explicit mention of the presence of the publisher. Additionally, users of screenreaders may need assistance getting started with this interactive component. So I suggest placing a little offscreen text that precedes the text editor: "You are going to meet a text editor. If you need help navigating this component, activate the following button: ". The help button, also displayed off-screen, would command the opening of an accessible dialog box, as in the following example Example on the image: !screenshot-1.png! !screenshot-2.png!
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Review third party libraries for new versions (3.0)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review.
| Unsolvable | 1.summary: Upgrade FPDI library in assignfeedback_editpdf to 1.5.4 for Moodle 3.0 release
description: Library FPDI Current version 1.4.4 Latest version 1.5.2 Make sure to update files: - mod/assign/feedback/editpdf/fpdi (library itself) - mod/assign/feedback/editpdf/thirdpartylibs.xml (indicate the current version) - mod/assign/feedback/editpdf/fpdi/readme_moodle.txt (indicate the current version and/or changes made)
2.summary: Upgrade PHPExcel library to 1.8.1 for Moodle 3.0 release
description: Library: PHPExcel Current version: 1.8.0 Latest version: 1.8.1
3.summary: Upgrade FPDI to 1.5.4 for Moodle 3.0 release
description: Library: FPDI Current version: 1.4.4 Latest version: 1.5.4 Note that on 1.5.1 release notes we can see that there are changes breaking backwards compatibility, although I havent checked if these changes affects us.
4.summary: Upgrade Auth_RADIUS to 1.1.0 for Moodle 3.0 release
description: Library: Pear Auth_RADIUS Current version: 1.0.7 Latest version: 1.1.0 I see that, at least, there is a change in the constructor, our current version is using the PHP 7 deprecated one, which should be replaced if we want moodle to work in PHP 7
5.summary: Upgrade HTML2Text to 3.0.0 for Moodle 3.0 release
description: Library: HTML2Text Current version: 1.0.1 Latest version: 2.0.1 and were closed as wont fix, but the moodle current version is not compatible with PHP 7, is using the new constructor so we should update to it.
6.summary: lib/graphlib.php is not credited in lib/thirdpartylibs.xml
description: I might be missing something, but this looks like a third party lib according to the main doc block, it is used by different moodle core plugins, and it is not credited in thirdpartylibs.xml
7.summary: Upgrade PHPMailer to 5.2.13 for Moodle 3.0 release
description: Library: PHPMailer Current version: 5.2.9 Latest version: 5.2.13
8.summary: Upgrade bootstrap to 2.3.2 for Moodle 3.0 release
description: I dont know how realistic this is, but there is a bootstrap 2.3.2.
9.summary: Upgrade Html5shiv to 3.7.3 for Moodle 3.0 release
description: Library html5shiv Current version 3.6.2 Latest version 3.7.3
10.summary: Upgrade less.php to 1.7.0.7 for Moodle 3.0 release
description: Library less.php Current version 1.7.0.3 Latest version 1.7.0.7
11.summary: Upgrade google api php client to 1.1.4 for Moodle 3.0 release
description: Library Google APIs Client Library for PHP Current version 1.1.2 Latest version 1.1.4
12.summary: Upgrade htmlpurifier to 4.7.0 for Moodle 3.0 release
description: Library htmlpurifier Current version 4.6.0 Latest version 4.7.0
13.summary: Upgrade minify library to 2.2.1 for Moodle 3.0 release
description: Library minify Current version 2.1.7 Latest version 2.2.1
14.summary: Upgrade TCPDF library to 6.2.12 for Moodle 3.0 release
description: Library TCPDF Current version 6.2.6 Latest version 6.2.12
15.summary: Upgrade jQuery to 1.11.3 for Moodle 3.0 release
description: Library jQuery Current version 1.11.2 Latest version 1.11.3
16.summary: Upgrade zend library to 1.12.16 for Moodle 3.0 release
description: Library Zend framework Current version 1.10.6 Latest version 1.12.16 Look at and
17.summary: Upgrade horde to 5.2.7 for Moodle 3.0 release
description: Library horde Current version 5.2.1 Latest version 5.2.10
18.summary: Upgrade requirejs library to 2.1.20 for Moodle 3.0 release
description: Library requirejs Current version 2.1.15 Latest version 2.1.20
19.summary: Upgrade loglevel library to 1.4.0 for Moodle 3.0 release
description: Library loglevel Current version 1.2.0 Latest version 1.4.0
20.summary: Upgrade Rangy library to 1.3.0 for Moodle 3.0 release
description: There is a newer version - we should upgrade.
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Review third party libraries for new versions (3.0)
description: There are a number of third-party libraries distributed with Moodle. Before the major release, the available versions of these libraries should be reviewed. Check the list at which should be up to date with lib/thirdpartylibs.xml and other thirdpartylibs.xml files distributed around Moodle. Add any newly incorporated libraries into the list Check the available versions of each library If there is a significant new version and updating is recommended, the new version should be integrated by creating a sub-task to this issue and processing it through integration independently. If there is a readme_moodle.txt file with the plugin, this describes the customisations made for Moodle. Check when doing your review.
### Response:
1.summary: Upgrade FPDI library in assignfeedback_editpdf to 1.5.4 for Moodle 3.0 release
description: Library FPDI Current version 1.4.4 Latest version 1.5.2 Make sure to update files: - mod/assign/feedback/editpdf/fpdi (library itself) - mod/assign/feedback/editpdf/thirdpartylibs.xml (indicate the current version) - mod/assign/feedback/editpdf/fpdi/readme_moodle.txt (indicate the current version and/or changes made)
2.summary: Upgrade PHPExcel library to 1.8.1 for Moodle 3.0 release
description: Library: PHPExcel Current version: 1.8.0 Latest version: 1.8.1
3.summary: Upgrade FPDI to 1.5.4 for Moodle 3.0 release
description: Library: FPDI Current version: 1.4.4 Latest version: 1.5.4 Note that on 1.5.1 release notes we can see that there are changes breaking backwards compatibility, although I havent checked if these changes affects us.
4.summary: Upgrade Auth_RADIUS to 1.1.0 for Moodle 3.0 release
description: Library: Pear Auth_RADIUS Current version: 1.0.7 Latest version: 1.1.0 I see that, at least, there is a change in the constructor, our current version is using the PHP 7 deprecated one, which should be replaced if we want moodle to work in PHP 7
5.summary: Upgrade HTML2Text to 3.0.0 for Moodle 3.0 release
description: Library: HTML2Text Current version: 1.0.1 Latest version: 2.0.1 and were closed as wont fix, but the moodle current version is not compatible with PHP 7, is using the new constructor so we should update to it.
6.summary: lib/graphlib.php is not credited in lib/thirdpartylibs.xml
description: I might be missing something, but this looks like a third party lib according to the main doc block, it is used by different moodle core plugins, and it is not credited in thirdpartylibs.xml
7.summary: Upgrade PHPMailer to 5.2.13 for Moodle 3.0 release
description: Library: PHPMailer Current version: 5.2.9 Latest version: 5.2.13
8.summary: Upgrade bootstrap to 2.3.2 for Moodle 3.0 release
description: I dont know how realistic this is, but there is a bootstrap 2.3.2.
9.summary: Upgrade Html5shiv to 3.7.3 for Moodle 3.0 release
description: Library html5shiv Current version 3.6.2 Latest version 3.7.3
10.summary: Upgrade less.php to 1.7.0.7 for Moodle 3.0 release
description: Library less.php Current version 1.7.0.3 Latest version 1.7.0.7
11.summary: Upgrade google api php client to 1.1.4 for Moodle 3.0 release
description: Library Google APIs Client Library for PHP Current version 1.1.2 Latest version 1.1.4
12.summary: Upgrade htmlpurifier to 4.7.0 for Moodle 3.0 release
description: Library htmlpurifier Current version 4.6.0 Latest version 4.7.0
13.summary: Upgrade minify library to 2.2.1 for Moodle 3.0 release
description: Library minify Current version 2.1.7 Latest version 2.2.1
14.summary: Upgrade TCPDF library to 6.2.12 for Moodle 3.0 release
description: Library TCPDF Current version 6.2.6 Latest version 6.2.12
15.summary: Upgrade jQuery to 1.11.3 for Moodle 3.0 release
description: Library jQuery Current version 1.11.2 Latest version 1.11.3
16.summary: Upgrade zend library to 1.12.16 for Moodle 3.0 release
description: Library Zend framework Current version 1.10.6 Latest version 1.12.16 Look at and
17.summary: Upgrade horde to 5.2.7 for Moodle 3.0 release
description: Library horde Current version 5.2.1 Latest version 5.2.10
18.summary: Upgrade requirejs library to 2.1.20 for Moodle 3.0 release
description: Library requirejs Current version 2.1.15 Latest version 2.1.20
19.summary: Upgrade loglevel library to 1.4.0 for Moodle 3.0 release
description: Library loglevel Current version 1.2.0 Latest version 1.4.0
20.summary: Upgrade Rangy library to 1.3.0 for Moodle 3.0 release
description: There is a newer version - we should upgrade.
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Quiz and Question bank in Moodle 4.0
description: Introduction The Quiz and Question in Moodle 4.0 project aims to improve behaviour and structure around questions and the question bank and probably some more. This project has been initiated by tkorner, lucaboesch and timhunt and is now in a project/funding phase under the operational lead by a.bonaccorso. Extra Detail If you want extra detail about the development status the github issue for the project is here: Goals Some (but not all) of the goals of this project are: Convert Moodle question activities into first class activities (modules), to enable easier sharing and provide greater flexibility to question banks Making question bank functionality extensible via plugins Making it easier for other activities to leverage question bank functionality Adding extra functionality to the core question bank, such as better filtering functionality and add comments Adding versioning support to questions in Moodle Bug fixes and improvements Epic Issue Integration order: There is a specific order to the integration of the issues in this epic. As there are dependencies and refactoring we need to take into account. We want to be able to make changes without breaking anything while we are in an "in progress" state. Therefore, to help keep things more clear, the following is the order in each issue in this tracker that needs to be integrated. The following can be integrated in any order: Add qbank_comment to core Add qbank_statistics Add column sort order to core Question bank bulk actions UI qbank_managecategories UI enhancement We can then integrate the following: Implement question versioning After these are integrated, one of these can be integrated in any order: Add qbank_history to core Add qbank_usage to core UI Considerations To help with alignment for Moodle 4.0 UX changes, please find the link below that shows the planned Quiz activity navigation prototype: Moodle 4.0 Quiz activity navigation with question bank| Moodle 4.1 and Next Steps The following epic has been created for ongoing changes that will land in Moodle 4.1:
| Unsolvable | 1.summary: Create new plugin type - Qbank
description: Currently all Question bank features are "hard coded" in Moodle core and are not very extensible. This issue will introduce a new "Question bank" plugin type, with the `qbank_` prefix. It will also refactor core code to allow provide a straightforward interface to create plugins that provide question bank functionality. This means contributors can make their own qbank_ plugins to introduce new question bank functionality. NOTE: Existing question bank features will not be replaced by this tracker, and will still continue to function. Each individual qbank_ plugin tracker issue will both introduce an existing core feature as a plugin and replace the current core functionality. This is so core Moodle wont be "broken" be the refactoring. Functionality qbank_ can plugins implement with this change: Ability to define action items for questions. E.g. import/export, copy, delete, tag Ability to define their own column/s to the question overview table. E.g. view author, last modified time. Ability to add their own tabs to the question bank view Ability define a navigation node if required Ability to override or create new nodes and implement your own from the plugin or create a new one
2.summary: Add qbank_exportquestions to core
description: This implementation will introduce a qbank plugin "exporquestions" which will add the export feature in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the export questions tab.
3.summary: Add qbank_editquestion to core
description: This implementation will introduce a qbank plugin "editquestion" which will implement the edit question, add question and copy question actions in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling these actions.
4.summary: Add qbank_viewquestiontext to core
description: This implementation will introduce a qbank plugin "viewquestiontext" which will view the question text row in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question text row in the question view.
5.summary: Add qbank_viewquestionname to core
description: This implementation will introduce a qbank plugin "viewquestionname" which will view the question name column in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the question name column.
6.summary: Add qbank_viewquestiontype to core
description: This implementation will introduce a qbank plugin "viewquestiontype" which will view the question type column in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question type in the question bank view.
7.summary: Add qbank_managecategories to core
description: This implementation will introduce a qbank plugin "managecategories" which will add the question categories feature in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the category tab.
8.summary: Add qbank_importquestions to core
description: This implementation will introduce a qbank plugin "importquestions" which will allow user to import a bank of questions in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question import in the question bank view.
9.summary: Add qbank_viewcreator to core
description: This implementation will introduce a qbank plugin "viewcreator" which will view the question creator/modifier column in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the question creator and modifier column in the question bank view.
10.summary: Add qbank_previewquestion to core
description: This implementation will introduce a qbank plugin "previewquestion" which will view the preview question action in the question bank actions by replacing the core classes, scripts and yui modules. This plugin will also replace the preview option in the edit question form. Having this plugin will give users the flexibility of enabling or disabling this feature from the question bank view. This change will also allow other qbank plugins to add elements or information in the preview question page by implementing a callback. It also changes the pop up to page redirect from base view page to make sure any changes in preview reflect in the base view, for example, comments added and the number of comments in the comments column changes while back from the preview page. Other locations like edit and qtype plugins where the preview is implemented, stays the same.
11.summary: Add qbank_deletequestion to core
description: This implementation will introduce a qbank plugin "deletequestion" which will implement the delete question action in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
12.summary: Add a columnsortorder settings page
description: This implementation will introduce a feature "columnsortorder" which will add the column sort order feature in an external page. Having this feature will give users the flexibility of sorting plugin columns in the question bank view.
13.summary: Add qbank_exporttoxml to core
description: This implementation will introduce a qbank plugin "exporttoxml" which will implement the export to xml action in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
14.summary: Add qbank_bulkmove to core
description: Create new plugin to bulk move questions between question banks
15.summary: Add qbank_tagquestion to core
description: This implementation will introduce a qbank plugin "tagquestion" which will implement the tag question actions in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
16.summary: Add qbank_comment to core
description: This implementation will introduce a qbank plugin "comment" which will allow users with the capability to comment in a question. It also implements a callback for the question preview page to view and add comments from the preview page. Comment plugin is implemented using the existing comments API from the core.
17.summary: Update mod_quiz for new question bank
description: This implementation will introduce changes to the mod_quiz to implement the new qbank api for view. Major changes are introduced in the custom view and also all the legacy points to the old qbank are changed to qbank plugins where needed. It also deprecated and deletes classes and scripts which were kept not to break mod_quiz for the new api implementation.
18.summary: Add question versions
description: Allow questions to have multiple versions. This issue provides the core APIs and database schema changes for questions to have multiple versions. The ability to add/edit question versions via mod_quiz or the upcoming mod_qbank will not be implemented in this tracker. They will have their own trackers More information about this issue specification:
19.summary: Quiz 4.0 Class renaming and deprecation
description: This tracker is to remove all the depracated classes and add the references to renameclasses.php. After all the plugins are integrated, the old deprecated classes are no longer needed as some of them are moved classes/local/bank or a qbank plugin. As different classes might require in different places while integrating plugins, this tracker will help the build to do the class cleanup after inetgrating the plugin and also get rid of any regression.
20.summary: Add qbank_usage to core
description: Create a plugin to view the column to show the usage of the question in different quizzes. The number in the usage column should be clickable link, which should pop up a page where it will show the question and also a table of content to view where this question is used, previewquestion plugin and moodle table_sql can be a reference for this issue.
21.summary: Add qbank_statistics
description: Build a plugin to show the following columns: Facility index Discriminative efficiency
22.summary: Question bank bulk action UI
description: In Moodle 4.0 contributors will be able to write their own qbank_ plugins that extend the question bank functionality. One of the types of functionality that can be developed is "bulk actions". These are actions that operate on multiple questions at once. Update July 8, 2021 Re-visit the implementation of import, export, and managecategories to have those plugins as a part of bulk actions and implement the navigation node as a way of representation rather than relying on it to integration in the question bank, this one might need some deep thinking and some changes to plugins by creating some flexibilities around bulk actions and plain navigation UI.
23.summary: Create behat tests for qbank plugins uninstall & double check session checks
description: Currently its possible to enable, disable and uninstall question bank plugins, create behat tests to test for any possible regression.
24.summary: Add qbank_history to core
description: Question history plugin will show the versions of the questions. With the versioning changes, the base view of the question bank will show the latest version of questions and every time a question is edited or changed, a new version is created. This plugin will show all the versions of the question using the same qbank api. This plugin is an example of the extendability of the qbank API in different areas.
25.summary: Questions: Add custom fields
description: Implement custom fields for questions using the Moodle custom fields API. This will allow teachers and question creators to store extra metadata against questions in a very flexible way. This is part of the epic . Data stored in question custom fields, can be shown to students during a quiz, or can be hidden and only shown to teachers etc. The data in the custom fields can also be leveraged by plugins in the new qbank_ plugin class.
26.summary: Improve upgrade.txt for questionlib and core_question
description: Improve the upgrade.txt for question in lib and core_question as well qbank for some more information for developers.
27.summary: Refactor quiz slot and question status js
description: Refactor the quiz slot js to update the slot rather than doing a page reload. Refactor the question status js to have delegated events.
28.summary: Question status UI/UX update
description: Changing question status is currently possible using a clickable link in the qbank page where clicking that link opens a pop-up to change the status. Change this to a dropdown instead to follow the UI/UX policy.
29.summary: Behat navigation steps for core question bank
description: This is something that should be done anyway, but is particularly to help people maintaining third-party plugins. We want to be able to say things like: noformat When I am on the "Course 1" "core_question > course question bank" page When I am on the "Course 1" "core_question > course question import" page When I am on the "Course 1" "core_question > course question export" page When I am on the "Test question" "core_question > edit" page logged in as teacher When I am on the "Test question" "core_question > preview" page logged in as teacher noformat
30.summary: New question bank features should have help popups
description: It would be great if the following question bank features could have help popups to explain them: Discriminative efficiency Facility index Need for revision Usage
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Quiz and Question bank in Moodle 4.0
description: Introduction The Quiz and Question in Moodle 4.0 project aims to improve behaviour and structure around questions and the question bank and probably some more. This project has been initiated by tkorner, lucaboesch and timhunt and is now in a project/funding phase under the operational lead by a.bonaccorso. Extra Detail If you want extra detail about the development status the github issue for the project is here: Goals Some (but not all) of the goals of this project are: Convert Moodle question activities into first class activities (modules), to enable easier sharing and provide greater flexibility to question banks Making question bank functionality extensible via plugins Making it easier for other activities to leverage question bank functionality Adding extra functionality to the core question bank, such as better filtering functionality and add comments Adding versioning support to questions in Moodle Bug fixes and improvements Epic Issue Integration order: There is a specific order to the integration of the issues in this epic. As there are dependencies and refactoring we need to take into account. We want to be able to make changes without breaking anything while we are in an "in progress" state. Therefore, to help keep things more clear, the following is the order in each issue in this tracker that needs to be integrated. The following can be integrated in any order: Add qbank_comment to core Add qbank_statistics Add column sort order to core Question bank bulk actions UI qbank_managecategories UI enhancement We can then integrate the following: Implement question versioning After these are integrated, one of these can be integrated in any order: Add qbank_history to core Add qbank_usage to core UI Considerations To help with alignment for Moodle 4.0 UX changes, please find the link below that shows the planned Quiz activity navigation prototype: Moodle 4.0 Quiz activity navigation with question bank| Moodle 4.1 and Next Steps The following epic has been created for ongoing changes that will land in Moodle 4.1:
### Response:
1.summary: Create new plugin type - Qbank
description: Currently all Question bank features are "hard coded" in Moodle core and are not very extensible. This issue will introduce a new "Question bank" plugin type, with the `qbank_` prefix. It will also refactor core code to allow provide a straightforward interface to create plugins that provide question bank functionality. This means contributors can make their own qbank_ plugins to introduce new question bank functionality. NOTE: Existing question bank features will not be replaced by this tracker, and will still continue to function. Each individual qbank_ plugin tracker issue will both introduce an existing core feature as a plugin and replace the current core functionality. This is so core Moodle wont be "broken" be the refactoring. Functionality qbank_ can plugins implement with this change: Ability to define action items for questions. E.g. import/export, copy, delete, tag Ability to define their own column/s to the question overview table. E.g. view author, last modified time. Ability to add their own tabs to the question bank view Ability define a navigation node if required Ability to override or create new nodes and implement your own from the plugin or create a new one
2.summary: Add qbank_exportquestions to core
description: This implementation will introduce a qbank plugin "exporquestions" which will add the export feature in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the export questions tab.
3.summary: Add qbank_editquestion to core
description: This implementation will introduce a qbank plugin "editquestion" which will implement the edit question, add question and copy question actions in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling these actions.
4.summary: Add qbank_viewquestiontext to core
description: This implementation will introduce a qbank plugin "viewquestiontext" which will view the question text row in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question text row in the question view.
5.summary: Add qbank_viewquestionname to core
description: This implementation will introduce a qbank plugin "viewquestionname" which will view the question name column in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the question name column.
6.summary: Add qbank_viewquestiontype to core
description: This implementation will introduce a qbank plugin "viewquestiontype" which will view the question type column in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question type in the question bank view.
7.summary: Add qbank_managecategories to core
description: This implementation will introduce a qbank plugin "managecategories" which will add the question categories feature in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the category tab.
8.summary: Add qbank_importquestions to core
description: This implementation will introduce a qbank plugin "importquestions" which will allow user to import a bank of questions in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling the question import in the question bank view.
9.summary: Add qbank_viewcreator to core
description: This implementation will introduce a qbank plugin "viewcreator" which will view the question creator/modifier column in the question bank view by replacing the core classes. Having this plugin will give users the flexibility of enabling or disabling the question creator and modifier column in the question bank view.
10.summary: Add qbank_previewquestion to core
description: This implementation will introduce a qbank plugin "previewquestion" which will view the preview question action in the question bank actions by replacing the core classes, scripts and yui modules. This plugin will also replace the preview option in the edit question form. Having this plugin will give users the flexibility of enabling or disabling this feature from the question bank view. This change will also allow other qbank plugins to add elements or information in the preview question page by implementing a callback. It also changes the pop up to page redirect from base view page to make sure any changes in preview reflect in the base view, for example, comments added and the number of comments in the comments column changes while back from the preview page. Other locations like edit and qtype plugins where the preview is implemented, stays the same.
11.summary: Add qbank_deletequestion to core
description: This implementation will introduce a qbank plugin "deletequestion" which will implement the delete question action in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
12.summary: Add a columnsortorder settings page
description: This implementation will introduce a feature "columnsortorder" which will add the column sort order feature in an external page. Having this feature will give users the flexibility of sorting plugin columns in the question bank view.
13.summary: Add qbank_exporttoxml to core
description: This implementation will introduce a qbank plugin "exporttoxml" which will implement the export to xml action in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
14.summary: Add qbank_bulkmove to core
description: Create new plugin to bulk move questions between question banks
15.summary: Add qbank_tagquestion to core
description: This implementation will introduce a qbank plugin "tagquestion" which will implement the tag question actions in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
16.summary: Add qbank_comment to core
description: This implementation will introduce a qbank plugin "comment" which will allow users with the capability to comment in a question. It also implements a callback for the question preview page to view and add comments from the preview page. Comment plugin is implemented using the existing comments API from the core.
17.summary: Update mod_quiz for new question bank
description: This implementation will introduce changes to the mod_quiz to implement the new qbank api for view. Major changes are introduced in the custom view and also all the legacy points to the old qbank are changed to qbank plugins where needed. It also deprecated and deletes classes and scripts which were kept not to break mod_quiz for the new api implementation.
18.summary: Add question versions
description: Allow questions to have multiple versions. This issue provides the core APIs and database schema changes for questions to have multiple versions. The ability to add/edit question versions via mod_quiz or the upcoming mod_qbank will not be implemented in this tracker. They will have their own trackers More information about this issue specification:
19.summary: Quiz 4.0 Class renaming and deprecation
description: This tracker is to remove all the depracated classes and add the references to renameclasses.php. After all the plugins are integrated, the old deprecated classes are no longer needed as some of them are moved classes/local/bank or a qbank plugin. As different classes might require in different places while integrating plugins, this tracker will help the build to do the class cleanup after inetgrating the plugin and also get rid of any regression.
20.summary: Add qbank_usage to core
description: Create a plugin to view the column to show the usage of the question in different quizzes. The number in the usage column should be clickable link, which should pop up a page where it will show the question and also a table of content to view where this question is used, previewquestion plugin and moodle table_sql can be a reference for this issue.
21.summary: Add qbank_statistics
description: Build a plugin to show the following columns: Facility index Discriminative efficiency
22.summary: Question bank bulk action UI
description: In Moodle 4.0 contributors will be able to write their own qbank_ plugins that extend the question bank functionality. One of the types of functionality that can be developed is "bulk actions". These are actions that operate on multiple questions at once. Update July 8, 2021 Re-visit the implementation of import, export, and managecategories to have those plugins as a part of bulk actions and implement the navigation node as a way of representation rather than relying on it to integration in the question bank, this one might need some deep thinking and some changes to plugins by creating some flexibilities around bulk actions and plain navigation UI.
23.summary: Create behat tests for qbank plugins uninstall & double check session checks
description: Currently its possible to enable, disable and uninstall question bank plugins, create behat tests to test for any possible regression.
24.summary: Add qbank_history to core
description: Question history plugin will show the versions of the questions. With the versioning changes, the base view of the question bank will show the latest version of questions and every time a question is edited or changed, a new version is created. This plugin will show all the versions of the question using the same qbank api. This plugin is an example of the extendability of the qbank API in different areas.
25.summary: Questions: Add custom fields
description: Implement custom fields for questions using the Moodle custom fields API. This will allow teachers and question creators to store extra metadata against questions in a very flexible way. This is part of the epic . Data stored in question custom fields, can be shown to students during a quiz, or can be hidden and only shown to teachers etc. The data in the custom fields can also be leveraged by plugins in the new qbank_ plugin class.
26.summary: Improve upgrade.txt for questionlib and core_question
description: Improve the upgrade.txt for question in lib and core_question as well qbank for some more information for developers.
27.summary: Refactor quiz slot and question status js
description: Refactor the quiz slot js to update the slot rather than doing a page reload. Refactor the question status js to have delegated events.
28.summary: Question status UI/UX update
description: Changing question status is currently possible using a clickable link in the qbank page where clicking that link opens a pop-up to change the status. Change this to a dropdown instead to follow the UI/UX policy.
29.summary: Behat navigation steps for core question bank
description: This is something that should be done anyway, but is particularly to help people maintaining third-party plugins. We want to be able to say things like: noformat When I am on the "Course 1" "core_question > course question bank" page When I am on the "Course 1" "core_question > course question import" page When I am on the "Course 1" "core_question > course question export" page When I am on the "Test question" "core_question > edit" page logged in as teacher When I am on the "Test question" "core_question > preview" page logged in as teacher noformat
30.summary: New question bank features should have help popups
description: It would be great if the following question bank features could have help popups to explain them: Discriminative efficiency Facility index Need for revision Usage
|
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic. | project: Moodle
summary: Moodle Tour/Walkthough/Instructional overlays for first time user on page
description: There are quite a number of Tour/walkthough frameworks which can be used out-of-box to introduce new users to Moodle pages. Currently it is hard of non-computer savy user to start using Moodle and being LMS Moodle should make it easy for people to understand how contents are placed on the page. Some of the frameworks which can be used
| Solvable | 1.summary: Moodle Tour/Walkthough/Instructional overlays for first time user on page (User tours)
description: There are quite a number of Tour/walkthough frameworks which can be used out-of-box to introduce new users to Moodle pages. Currently it is hard of non-computer savy user to start using Moodle and being LMS Moodle should make it easy for people to understand how contents are placed on the page. Some of the frameworks which can be used
| Below is an instruction that describes a task, paired with an input that provides an epic with this format:
"project": "Name of the project"
"summary": "Summary of the epic user story"
"description": "Description of the epic user story". Write a response that appropriately completes the request.### Instruction:
Break this epic user story into smaller tasks to help the developers understand the epic better, you can divide this epic into as much as you want depending on the complexity of the epic.
### Input:
project: Moodle
summary: Moodle Tour/Walkthough/Instructional overlays for first time user on page
description: There are quite a number of Tour/walkthough frameworks which can be used out-of-box to introduce new users to Moodle pages. Currently it is hard of non-computer savy user to start using Moodle and being LMS Moodle should make it easy for people to understand how contents are placed on the page. Some of the frameworks which can be used
### Response:
1.summary: Moodle Tour/Walkthough/Instructional overlays for first time user on page (User tours)
description: There are quite a number of Tour/walkthough frameworks which can be used out-of-box to introduce new users to Moodle pages. Currently it is hard of non-computer savy user to start using Moodle and being LMS Moodle should make it easy for people to understand how contents are placed on the page. Some of the frameworks which can be used
|