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
summary: Review third party libraries for new versions (3.5)
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: Quick link Remaining open issues in this epic|
| Unsolvable | 1.summary: Remove mssql DML
description: We now only support php7 + for master. This means mssql will not work. We need to remove or deprecate it from core to prevent confusion etc. For reference:
| 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.5)
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: Quick link Remaining open issues in this epic|
### Response:
1.summary: Remove mssql DML
description: We now only support php7 + for master. This means mssql will not work. We need to remove or deprecate it from core to prevent confusion etc. For reference:
|
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.4
description: In 3.4 we can remove functionality that was deprecated in 3.0 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.4. 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.0
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.0 should be replaced with exceptions in 3.4 This includes all functions in lib/deprecatedlib.php that say since 3.0 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.4 - please list them in this issue description_
2.summary: Remove strings deprecated in 3.0
description: Remove strings from language files under the heading "Deprecated in Moodle 3.0" and the respective lines in deprecated.txt files See also
3.summary: Final deprecation of very old groups-related functions
description: some of the very old apis were properly deprecated only after 2.9. Do final deprecation for those. groupmode() get_current_group set_current_group
4.summary: Final deprecation of filter_manager::text_filtering_hash() and moodle_text_filter::hash()
description: Both filter_manager::text_filtering_hash and moodle_text_filter::hash were deprecated for 3.0 by . Now its time to kill them completely. Note they have not been in use since many years ago, just we proceed with the deprecation really later. Ciao :-)
5.summary: Final deprecation of completion_cron()
description: Replaced by scheduled tasks in
6.summary: Final deprecation / removal of is_web_crawler()
description: Deprecated in 3.0, replaced with core_useragent method in
7.summary: Move "Messages" block out from the standard Moodle distribution
description: This block is no longer needed with new messaging UI
8.summary: Remove behat steps deprecated in 3.0
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.0 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.4
description: In 3.4 we can remove functionality that was deprecated in 3.0 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.4. 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.0
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.0 should be replaced with exceptions in 3.4 This includes all functions in lib/deprecatedlib.php that say since 3.0 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.4 - please list them in this issue description_
2.summary: Remove strings deprecated in 3.0
description: Remove strings from language files under the heading "Deprecated in Moodle 3.0" and the respective lines in deprecated.txt files See also
3.summary: Final deprecation of very old groups-related functions
description: some of the very old apis were properly deprecated only after 2.9. Do final deprecation for those. groupmode() get_current_group set_current_group
4.summary: Final deprecation of filter_manager::text_filtering_hash() and moodle_text_filter::hash()
description: Both filter_manager::text_filtering_hash and moodle_text_filter::hash were deprecated for 3.0 by . Now its time to kill them completely. Note they have not been in use since many years ago, just we proceed with the deprecation really later. Ciao :-)
5.summary: Final deprecation of completion_cron()
description: Replaced by scheduled tasks in
6.summary: Final deprecation / removal of is_web_crawler()
description: Deprecated in 3.0, replaced with core_useragent method in
7.summary: Move "Messages" block out from the standard Moodle distribution
description: This block is no longer needed with new messaging UI
8.summary: Remove behat steps deprecated in 3.0
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.0 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: Usability improvements for grade export and import
description: Export Have a quickdump to csv that takes no parameters and can be optionally linked to the Grader report -- Would contain a row of weights and a row of maximum points -- Would contain a blank row after each category for teacher calculations -- Add support for letter grades as well: Import Excel paste -- Can import data via copy/paste from Excel (text field entry option, instead of file) -- Saves trouble of saving file as csv and then importing CSV file preview (UCSB) -- Not user friendly right now, but is resilient -- Gives preview of parsed file input and allows mapping of data from file to Moodle fields -- On submit, gives preview and diagnosis data --- Lets user know about potential updates --- Errors and tells user why (invalid student, invalid grade) --- Duplicate scores are skipped -- Then can continue with import --- Moodle.org decided to only allow full/perfect imports, because importing of half data can leave user confused/lost Idea: Have data in a table and allow user to fix data right there.
| Unsolvable | 1.summary: Improved interface for export of grades
description: Add the ability to dump grade data to CSV without selecting parameters, optionally linked to the grader report. The solution should: contain a row of weights and a row of maximum points contain a blank row after each category for teacher calculations have support for letter grades as well (see )
2.summary: Copy and paste import from excel into the gradebook.
description: It would be convenient to just copy and paste rows from excel straight into the gradebook. This could be added to the csv import form.
| 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: Usability improvements for grade export and import
description: Export Have a quickdump to csv that takes no parameters and can be optionally linked to the Grader report -- Would contain a row of weights and a row of maximum points -- Would contain a blank row after each category for teacher calculations -- Add support for letter grades as well: Import Excel paste -- Can import data via copy/paste from Excel (text field entry option, instead of file) -- Saves trouble of saving file as csv and then importing CSV file preview (UCSB) -- Not user friendly right now, but is resilient -- Gives preview of parsed file input and allows mapping of data from file to Moodle fields -- On submit, gives preview and diagnosis data --- Lets user know about potential updates --- Errors and tells user why (invalid student, invalid grade) --- Duplicate scores are skipped -- Then can continue with import --- Moodle.org decided to only allow full/perfect imports, because importing of half data can leave user confused/lost Idea: Have data in a table and allow user to fix data right there.
### Response:
1.summary: Improved interface for export of grades
description: Add the ability to dump grade data to CSV without selecting parameters, optionally linked to the grader report. The solution should: contain a row of weights and a row of maximum points contain a blank row after each category for teacher calculations have support for letter grades as well (see )
2.summary: Copy and paste import from excel into the gradebook.
description: It would be convenient to just copy and paste rows from excel straight into the gradebook. This could be added to the csv import form.
|
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.0 polish: issues identified as part of reviewing Moodle 4.0 prior to reaching beta
description: This epic will collate the issues we identify as needing to be resolved as part of the Moodle 4.0 release.
| Unsolvable | 1.summary: Secondary navigation visual improvements: Border radius
description: This navigation elements should have square corners, even if bootstrap is configured to display rounded corners !rounded-corners.png|width=592,height=144!
2.summary: Secondary navigation visual improvements: Inconsistent borders
description: When focused, the secondary navigation does not have a consistent border width. !focus-border.png|width=686,height=167!
3.summary: Secondary navigation visual improvements: Font weight and tab width
description: In the current code, active tabs have a different width from those tabs which is not active. This causes the navigation to move around a little bit when navigating. !active-width.png|width=656,height=226! I think we tried to come with some solutions to this some time ago, but it still feels unpolished. I suggest we keep the same font-weight for active tabs Current: !Screenshot 2021-10-20 at 14.47.09.png|width=618,height=143! Then: !Screenshot 2021-10-20 at 14.46.58.png|width=610,height=148!
4.summary: Navbar when user is not logged in
description: Right now, in the prototype site, this is how the navbar looks when the user is not logged in: !Screenshot 2021-10-20 at 15.11.08.png|width=616,height=119! These are the proposed rules, for each scenario: !Screenshot 2021-10-20 at 15.09.03.png|width=358,height=335! 1) Configuration: Global search: activated Language packs: more than one Printed in the UI: Global search icon/module Divider Language selector Divider Log in (Only the link, no "You are not logged in." string next to it) 2) Configuration: Global search: activated Language packs: only one Printed in the UI: Global search icon/module Divider Log in (Only the link, no "You are not logged in." string next to it) 3) Configuration: Global search: not activated Language packs: more than one Printed in the UI: Language selector Divider Log in (Only the link, no "You are not logged in." string next to it) 4) Configuration: Global search: not activated Language packs: only one Printed in the UI: Log in (Only the link, no "You are not logged in." string next to it)
5.summary: User menu improvements
description: This is the new user menu: !Screenshot 2021-10-20 at 10.27.40.png|width=524,height=612! Elements: Profile Grades Calendar Private files ------ (Divider) Preferences Language Switch role to... ------ (Divider) Log out Some details: There is no "Dashboard" element anymore "Calendar" leads to the site-level calendar (not context aware) There are no icons anymore SB EDIT: Calendar item is being added in This issue can be about adding in the private files item and styling as per the screenshot
6.summary: Margin between site name / site logo and primary navigation
description: I suggest adding a "mr-4" class in the site name or site logo, so it is not displayed too close from the primary navigation. !site-logo-margin.png|width=668,height=270! Right now: !Screenshot 2021-10-20 at 15.33.46.png|width=641,height=79! With the "mr-4" class: !Screenshot 2021-10-20 at 15.33.35.png|width=658,height=79!
7.summary: The welcome message is displayed in other pages than the dashboard
description: To reproduce it: Go to the prototype site: Be sure that you are not logged in Access the page via URL Log in The Welcome message is displayed in the "My courses" page !Screenshot 2021-10-20 at 16.18.35.png|width=675,height=319!
8.summary: A different padding for the "Add an activity and resource" element
description: Right now, its padding is set by the classes px-3 py-2, which make it look like this: !Screenshot 2021-10-26 at 16.53.03.png|width=670! Lets use instead a p-3 class for its padding, which will make it look like this: !Screenshot 2021-10-26 at 17.03.30.png|width=670!
9.summary: "Add topic after" should be "Add a section below" and have a blue border
description: Right now, this is how the element which adds more sections to the course looks like: !Screenshot 2021-10-26 at 11.08.55.png|width=424,height=216! (Sorry about the poor screenshot I took it from a meeting) It should look like this: !Screenshot 2021-10-26 at 17.01.51.png|width=615,height=300! No "plus" icon Text says "Add a section below" There is also a border in the top of it separating it from the "Add activity or resource" component. The border color is the same used in the links ($primary) Its displayed after (in the bottom of) every section
10.summary: Homogenise logo displaying over the platform
description: . The problem Right now, this is how the current logos and site name work: . Scenario 1 Configuration: - Uploaded core_admin | logocompact: yes - Uploaded core_admin | logo: yes Pages: - Site home: -- The "core_admin | logo" file (big image) is displayed at the header of the page. -- The site "short name" is displayed before the primary navigation. - Every other page: -- The "core_admin | logocompact" file (small image) is displayed before the primary navigation. -- The site "short name" is not displayed anywhere else. - Login: -- The "core_admin | logo" file (big image) is displayed on the login page. . Scenario 2 Configuration: - Uploaded core_admin | logocompact: no - Uploaded core_admin | logo: yes Pages: - Site home: -- The "core_admin | logo" file (big image) is displayed at the header of the page. -- The site "short name" is displayed before the primary navigation. - Every other page: -- The site "short name" is displayed before the primary navigation. - Login: -- The "core_admin | logo" file (big image) is displayed on the login page . Scenario 3 Configuration: - Uploaded core_admin | logocompact: yes - Uploaded core_admin | logo: no Pages: - Site home: -- The site "full name" is displayed at the header of the page. -- Nothing is displayed before the primary navigation. - Every other page: -- The "core_admin | logocompact" file (small image) is displayed before the primary navigation. - Login: -- The site "full name" is displayed on the login page. . Scenario 4 Configuration: - Uploaded core_admin | logocompact: no - Uploaded core_admin | logo: no Pages: - Site home: -- The site "full name" is displayed at the header of the page. -- Nothing is displayed before the primary navigation. - Every other page: -- The site "short name" is displayed before the primary navigation. - Login: -- The site "full name" is displayed on the login page. This behaviour has presented many problems until this point: - Its not straightforward for newcomers - Switching between the logo and site short name makes the primary navigation position giggle, which feels inconsistent . The proposed solution: If logo compact (small) is uploaded: - Pages: -- Home: --- The logo (small) will be displayed next to the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- The logo (small) will be displayed next to the primary navigation -- Login: no affect If the logo compact (small) is not uploaded: - Pages: -- Home: --- The site short name will be displayed next to the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- The site short name will be displayed next to the primary navigation -- Login: no affect If the logo (large) is updated: - Pages: -- Home: --- Doesnt affect the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- Doesnt affect the primary navigation -- Login: --- The logo (large) will be displayed on the login page If the logo (large) is not updated: - Pages: -- Home: --- Doesnt affect the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- Doesnt affect the primary navigation -- Login: --- The site full name will be displayed on the login page
11.summary: Ensure support email address is mandatory
description: To make it easier for our users to get additional assistance we want to ensure the site support email address is always configured. For this purpose we want to introduce the following changes: Make the site support email address mandatory (Administration > Server > Support contact). List the email address in the new ? pop-up. Add the ability to set the support email during CLI installation, but make it optional in this case so that we dont negatively affect any automations/scripts etc the partners/cloud etc may use to create new sites.
12.summary: Fix the appearance in "My courses" page
description: This is how it looks right now when hovering or active: !Screenshot 2021-11-04 at 10.15.54.png|width=675,height=245! This is how it looks in the prototype: !Screenshot 2021-11-04 at 10.16.02.png|width=676,height=310!
13.summary: Adapt existing blocks Web Services to support the new "My courses" page
description: Currently we have separated web services for retrieving course and dashboard blocks, but there is no a way to retrieve the blocks (my over view block only in this case) from the new "My courses" page After discussing this with mathewmay we believe that the best way to support this could be by just adding a new parameter to core_block_get_dashboard_blocks to indicate from which page to retrieve the blocks. Apart from the previous a new Web Service to trigger the mycourses_viewed event will be necessary (core_my_view_mycourses) and it seems we are missing from some time the equivalent for dashboard, core_my_view_dashboard)
14.summary: Provide option of having My courses as defaulthomepage
description: In Moodle 4.0, the course overview block is being moved from the Dashboard to My courses. This will leave only the calendar and timeline blocks on the Dashboard. For sites which dont use the calendar or timeline blocks, such as sites offering self-paced courses, it would be good to provide the option of having My courses as defaulthomepage. Edited to add further information: Thus, the site admin setting Start page for users (defaulthomepage) should have an additional option My courses. The default value should remain as Dashboard (for new and upgraded sites). For upgraded sites, whatever value was set previously should remain unchanged. If defaulthomepage is set as User preference, then users should be able to select their preference via the User menu > Preferences > Start page and have the choice of Dashboard, Site home and My courses. (PS the name Home page is being changed to Start page in .)
15.summary: Change "Home page for users" strings
description: We are not changing the order of the elements in the primary navigation. So this setting strings are slightly misleading ATM: !Screenshot 2021-11-16 at 15.58.46.png|width=548,height=81! This is the strings that I propose instead: !Screenshot 2021-11-16 at 15.59.48.png|width=508,height=80!
16.summary: Remove "Course overview" text from the "My courses" page
description: This string is not in the prototype, so it should be removed: !Screenshot 2021-11-04 at 10.18.26.png|width=652,height=254!
17.summary: "My courses" search box looks different from the dropdowns
description: The search box: should have square or rounded corners, depending on the theme variable configuration should have the same height as the dropdown menus !Screenshot 2021-11-04 at 10.22.45.png|width=667,height=220!
18.summary: Make the block drawer wider
description: Right now, both "Course index" and "Blocks" drawers have the same 285px width. Although this width is perfect for the "Course index", its a bit narrow for blocks. I propose increasing the block drawer width in 30px (315px instead of current 285px). !Screenshot 2021-11-16 at 15.27.06.png|width=292,height=526!
19.summary: The footer should not be displayed unless debug mode is on
description: The footer container is still showing in the site as a dark strip in the bottom of the page. !Screenshot 2021-11-18 at 14.50.49.png|width=674! It only makes sense to display the old footer when debugging mode is on, otherwise it should disappear completely. !Screenshot 2021-11-18 at 14.51.11.png|width=674!
20.summary: "Add weeks" and "Add topic after" improvements
description: In the weekly format, this is how we are currently printing the link to add more weeks to the course: !Screenshot 2021-10-26 at 17.09.50.png|width=661,height=81! This is my proposal: !proposal.png|width=650,height=94! No "plus" icon Text says "Add week" There is also a border in the top of it separating it from the "Add activity or resource" component. The border color is the same used in the links ($primary) Its displayed only in the bottom of the course (differently from the "Add section below", which is displayed after every section see )
21.summary: Remove the text "(except removed from view)" from the "Course overview" block filter options
description: In previous user testings, we found some hesitance from users to use the current filter in the "Course overview block". -Changing the current option from "All (except removed from view)" to "All" would save us some screen real estate (especially in small devices) and make it easier to use.- Note: Im mentioning the "Course overview" block in this issue because I think that the current "My courses" page uses the same code as this block (so we wouldnt duplicate the code). However, if the code from the "Course overview" block is different from the "My courses" page code, I would suggest updating the string in both, especially on the "My courses" page. Issue update: lets change the existing strings (see comments below): current "All" string to "All (including removed from view)" current "All (except removed from view) string to "All" !Screenshot 2021-11-23 at 08.05.41.png|width=635,height=361!
22.summary: Add blocks drawer to Dashboard and (maybe) Home frontpage
description: Currently on Dashboard and Home pages the blocks are always visible but not as a drawer, so the user cant hide/show the blocks. We did agree some time ago that the dashboard should also have the collapsible block drawer. Lets add the blocks drawer to dashboard and review wether the Home page should also use the blocks drawer.
23.summary: Secondary navigation display improvements
description: The following things have been picked up in a design review. We either need to fix or explain reasons for the following: When clicking the more menu the first element is highlighted (but not actually selected). Also visible in the user menu. When clicking a tab, there is a blue outline instead of just a line at the bottom. When something is selected we need a tick (not a highlighted cell).
24.summary: Login container should be rounded
description: Right now the main container in the login page has square borders. It should be rounded or square depending on the theme configuration. !Screenshot 2021-12-14 at 10.19.52.png|width=407,height=242!
25.summary: Update page background to white
description: The page background on the dashboard and my courses page is grey. As a result the main area looks like an island in the middle. The background should be white to match the figma prototype|
| 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.0 polish: issues identified as part of reviewing Moodle 4.0 prior to reaching beta
description: This epic will collate the issues we identify as needing to be resolved as part of the Moodle 4.0 release.
### Response:
1.summary: Secondary navigation visual improvements: Border radius
description: This navigation elements should have square corners, even if bootstrap is configured to display rounded corners !rounded-corners.png|width=592,height=144!
2.summary: Secondary navigation visual improvements: Inconsistent borders
description: When focused, the secondary navigation does not have a consistent border width. !focus-border.png|width=686,height=167!
3.summary: Secondary navigation visual improvements: Font weight and tab width
description: In the current code, active tabs have a different width from those tabs which is not active. This causes the navigation to move around a little bit when navigating. !active-width.png|width=656,height=226! I think we tried to come with some solutions to this some time ago, but it still feels unpolished. I suggest we keep the same font-weight for active tabs Current: !Screenshot 2021-10-20 at 14.47.09.png|width=618,height=143! Then: !Screenshot 2021-10-20 at 14.46.58.png|width=610,height=148!
4.summary: Navbar when user is not logged in
description: Right now, in the prototype site, this is how the navbar looks when the user is not logged in: !Screenshot 2021-10-20 at 15.11.08.png|width=616,height=119! These are the proposed rules, for each scenario: !Screenshot 2021-10-20 at 15.09.03.png|width=358,height=335! 1) Configuration: Global search: activated Language packs: more than one Printed in the UI: Global search icon/module Divider Language selector Divider Log in (Only the link, no "You are not logged in." string next to it) 2) Configuration: Global search: activated Language packs: only one Printed in the UI: Global search icon/module Divider Log in (Only the link, no "You are not logged in." string next to it) 3) Configuration: Global search: not activated Language packs: more than one Printed in the UI: Language selector Divider Log in (Only the link, no "You are not logged in." string next to it) 4) Configuration: Global search: not activated Language packs: only one Printed in the UI: Log in (Only the link, no "You are not logged in." string next to it)
5.summary: User menu improvements
description: This is the new user menu: !Screenshot 2021-10-20 at 10.27.40.png|width=524,height=612! Elements: Profile Grades Calendar Private files ------ (Divider) Preferences Language Switch role to... ------ (Divider) Log out Some details: There is no "Dashboard" element anymore "Calendar" leads to the site-level calendar (not context aware) There are no icons anymore SB EDIT: Calendar item is being added in This issue can be about adding in the private files item and styling as per the screenshot
6.summary: Margin between site name / site logo and primary navigation
description: I suggest adding a "mr-4" class in the site name or site logo, so it is not displayed too close from the primary navigation. !site-logo-margin.png|width=668,height=270! Right now: !Screenshot 2021-10-20 at 15.33.46.png|width=641,height=79! With the "mr-4" class: !Screenshot 2021-10-20 at 15.33.35.png|width=658,height=79!
7.summary: The welcome message is displayed in other pages than the dashboard
description: To reproduce it: Go to the prototype site: Be sure that you are not logged in Access the page via URL Log in The Welcome message is displayed in the "My courses" page !Screenshot 2021-10-20 at 16.18.35.png|width=675,height=319!
8.summary: A different padding for the "Add an activity and resource" element
description: Right now, its padding is set by the classes px-3 py-2, which make it look like this: !Screenshot 2021-10-26 at 16.53.03.png|width=670! Lets use instead a p-3 class for its padding, which will make it look like this: !Screenshot 2021-10-26 at 17.03.30.png|width=670!
9.summary: "Add topic after" should be "Add a section below" and have a blue border
description: Right now, this is how the element which adds more sections to the course looks like: !Screenshot 2021-10-26 at 11.08.55.png|width=424,height=216! (Sorry about the poor screenshot I took it from a meeting) It should look like this: !Screenshot 2021-10-26 at 17.01.51.png|width=615,height=300! No "plus" icon Text says "Add a section below" There is also a border in the top of it separating it from the "Add activity or resource" component. The border color is the same used in the links ($primary) Its displayed after (in the bottom of) every section
10.summary: Homogenise logo displaying over the platform
description: . The problem Right now, this is how the current logos and site name work: . Scenario 1 Configuration: - Uploaded core_admin | logocompact: yes - Uploaded core_admin | logo: yes Pages: - Site home: -- The "core_admin | logo" file (big image) is displayed at the header of the page. -- The site "short name" is displayed before the primary navigation. - Every other page: -- The "core_admin | logocompact" file (small image) is displayed before the primary navigation. -- The site "short name" is not displayed anywhere else. - Login: -- The "core_admin | logo" file (big image) is displayed on the login page. . Scenario 2 Configuration: - Uploaded core_admin | logocompact: no - Uploaded core_admin | logo: yes Pages: - Site home: -- The "core_admin | logo" file (big image) is displayed at the header of the page. -- The site "short name" is displayed before the primary navigation. - Every other page: -- The site "short name" is displayed before the primary navigation. - Login: -- The "core_admin | logo" file (big image) is displayed on the login page . Scenario 3 Configuration: - Uploaded core_admin | logocompact: yes - Uploaded core_admin | logo: no Pages: - Site home: -- The site "full name" is displayed at the header of the page. -- Nothing is displayed before the primary navigation. - Every other page: -- The "core_admin | logocompact" file (small image) is displayed before the primary navigation. - Login: -- The site "full name" is displayed on the login page. . Scenario 4 Configuration: - Uploaded core_admin | logocompact: no - Uploaded core_admin | logo: no Pages: - Site home: -- The site "full name" is displayed at the header of the page. -- Nothing is displayed before the primary navigation. - Every other page: -- The site "short name" is displayed before the primary navigation. - Login: -- The site "full name" is displayed on the login page. This behaviour has presented many problems until this point: - Its not straightforward for newcomers - Switching between the logo and site short name makes the primary navigation position giggle, which feels inconsistent . The proposed solution: If logo compact (small) is uploaded: - Pages: -- Home: --- The logo (small) will be displayed next to the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- The logo (small) will be displayed next to the primary navigation -- Login: no affect If the logo compact (small) is not uploaded: - Pages: -- Home: --- The site short name will be displayed next to the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- The site short name will be displayed next to the primary navigation -- Login: no affect If the logo (large) is updated: - Pages: -- Home: --- Doesnt affect the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- Doesnt affect the primary navigation -- Login: --- The logo (large) will be displayed on the login page If the logo (large) is not updated: - Pages: -- Home: --- Doesnt affect the primary navigation --- The site full name will be displayed in the page header -- Other pages: --- Doesnt affect the primary navigation -- Login: --- The site full name will be displayed on the login page
11.summary: Ensure support email address is mandatory
description: To make it easier for our users to get additional assistance we want to ensure the site support email address is always configured. For this purpose we want to introduce the following changes: Make the site support email address mandatory (Administration > Server > Support contact). List the email address in the new ? pop-up. Add the ability to set the support email during CLI installation, but make it optional in this case so that we dont negatively affect any automations/scripts etc the partners/cloud etc may use to create new sites.
12.summary: Fix the appearance in "My courses" page
description: This is how it looks right now when hovering or active: !Screenshot 2021-11-04 at 10.15.54.png|width=675,height=245! This is how it looks in the prototype: !Screenshot 2021-11-04 at 10.16.02.png|width=676,height=310!
13.summary: Adapt existing blocks Web Services to support the new "My courses" page
description: Currently we have separated web services for retrieving course and dashboard blocks, but there is no a way to retrieve the blocks (my over view block only in this case) from the new "My courses" page After discussing this with mathewmay we believe that the best way to support this could be by just adding a new parameter to core_block_get_dashboard_blocks to indicate from which page to retrieve the blocks. Apart from the previous a new Web Service to trigger the mycourses_viewed event will be necessary (core_my_view_mycourses) and it seems we are missing from some time the equivalent for dashboard, core_my_view_dashboard)
14.summary: Provide option of having My courses as defaulthomepage
description: In Moodle 4.0, the course overview block is being moved from the Dashboard to My courses. This will leave only the calendar and timeline blocks on the Dashboard. For sites which dont use the calendar or timeline blocks, such as sites offering self-paced courses, it would be good to provide the option of having My courses as defaulthomepage. Edited to add further information: Thus, the site admin setting Start page for users (defaulthomepage) should have an additional option My courses. The default value should remain as Dashboard (for new and upgraded sites). For upgraded sites, whatever value was set previously should remain unchanged. If defaulthomepage is set as User preference, then users should be able to select their preference via the User menu > Preferences > Start page and have the choice of Dashboard, Site home and My courses. (PS the name Home page is being changed to Start page in .)
15.summary: Change "Home page for users" strings
description: We are not changing the order of the elements in the primary navigation. So this setting strings are slightly misleading ATM: !Screenshot 2021-11-16 at 15.58.46.png|width=548,height=81! This is the strings that I propose instead: !Screenshot 2021-11-16 at 15.59.48.png|width=508,height=80!
16.summary: Remove "Course overview" text from the "My courses" page
description: This string is not in the prototype, so it should be removed: !Screenshot 2021-11-04 at 10.18.26.png|width=652,height=254!
17.summary: "My courses" search box looks different from the dropdowns
description: The search box: should have square or rounded corners, depending on the theme variable configuration should have the same height as the dropdown menus !Screenshot 2021-11-04 at 10.22.45.png|width=667,height=220!
18.summary: Make the block drawer wider
description: Right now, both "Course index" and "Blocks" drawers have the same 285px width. Although this width is perfect for the "Course index", its a bit narrow for blocks. I propose increasing the block drawer width in 30px (315px instead of current 285px). !Screenshot 2021-11-16 at 15.27.06.png|width=292,height=526!
19.summary: The footer should not be displayed unless debug mode is on
description: The footer container is still showing in the site as a dark strip in the bottom of the page. !Screenshot 2021-11-18 at 14.50.49.png|width=674! It only makes sense to display the old footer when debugging mode is on, otherwise it should disappear completely. !Screenshot 2021-11-18 at 14.51.11.png|width=674!
20.summary: "Add weeks" and "Add topic after" improvements
description: In the weekly format, this is how we are currently printing the link to add more weeks to the course: !Screenshot 2021-10-26 at 17.09.50.png|width=661,height=81! This is my proposal: !proposal.png|width=650,height=94! No "plus" icon Text says "Add week" There is also a border in the top of it separating it from the "Add activity or resource" component. The border color is the same used in the links ($primary) Its displayed only in the bottom of the course (differently from the "Add section below", which is displayed after every section see )
21.summary: Remove the text "(except removed from view)" from the "Course overview" block filter options
description: In previous user testings, we found some hesitance from users to use the current filter in the "Course overview block". -Changing the current option from "All (except removed from view)" to "All" would save us some screen real estate (especially in small devices) and make it easier to use.- Note: Im mentioning the "Course overview" block in this issue because I think that the current "My courses" page uses the same code as this block (so we wouldnt duplicate the code). However, if the code from the "Course overview" block is different from the "My courses" page code, I would suggest updating the string in both, especially on the "My courses" page. Issue update: lets change the existing strings (see comments below): current "All" string to "All (including removed from view)" current "All (except removed from view) string to "All" !Screenshot 2021-11-23 at 08.05.41.png|width=635,height=361!
22.summary: Add blocks drawer to Dashboard and (maybe) Home frontpage
description: Currently on Dashboard and Home pages the blocks are always visible but not as a drawer, so the user cant hide/show the blocks. We did agree some time ago that the dashboard should also have the collapsible block drawer. Lets add the blocks drawer to dashboard and review wether the Home page should also use the blocks drawer.
23.summary: Secondary navigation display improvements
description: The following things have been picked up in a design review. We either need to fix or explain reasons for the following: When clicking the more menu the first element is highlighted (but not actually selected). Also visible in the user menu. When clicking a tab, there is a blue outline instead of just a line at the bottom. When something is selected we need a tick (not a highlighted cell).
24.summary: Login container should be rounded
description: Right now the main container in the login page has square borders. It should be rounded or square depending on the theme configuration. !Screenshot 2021-12-14 at 10.19.52.png|width=407,height=242!
25.summary: Update page background to white
description: The page background on the dashboard and my courses page is grey. As a result the main area looks like an island in the middle. The background should be white to match the figma prototype|
|
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.2/3.6.6 upgrade
description: Moodle 3.7.2 is scheduled for release on Monday 9 September 2019.
| Unsolvable | 1.summary: Upgrade archive.moodle.net to 3.7.2
description:
2.summary: Upgrade moodle.org to 3.7.2
description:
3.summary: Upgrade dev.moodle.org to 3.6.6
description:
4.summary: Upgrade learn.moodle.org to 3.7.2
description:
5.summary: Upgrade school.moodledemo.net to 3.7.2
description:
6.summary: Upgrade sandbox.moodledemo.net to 3.7.2
description:
7.summary: Upgrade lang.moodle.org to 3.6.6
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.2/3.6.6 upgrade
description: Moodle 3.7.2 is scheduled for release on Monday 9 September 2019.
### Response:
1.summary: Upgrade archive.moodle.net to 3.7.2
description:
2.summary: Upgrade moodle.org to 3.7.2
description:
3.summary: Upgrade dev.moodle.org to 3.6.6
description:
4.summary: Upgrade learn.moodle.org to 3.7.2
description:
5.summary: Upgrade school.moodledemo.net to 3.7.2
description:
6.summary: Upgrade sandbox.moodledemo.net to 3.7.2
description:
7.summary: Upgrade lang.moodle.org to 3.6.6
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
summary: Forms improvements targeted for Moodle 3.1
description: Collection of forms improvements targeted for Moodle 3.1.
| Unsolvable | 1.summary: Convert mform element text to use a mustache template / renderable
description: Convert mform element text to use a mustache template / renderable
2.summary: Create an AMD module that will retrieve all the values for a form, ready for ajax
description: Jquery provides a $(.form).serialize() and $(.form).serializeArray() which almost do what we need - they just need to be wrapped in a function that will make the format of the array of values, match what we would expect in a webservice.
3.summary: Make a standard way to get errors from a webservice and associate them with fields in a form.
description: E.g. If we submit data to a "create_group" function, and the data fails validation, we need to know which field failed validation so we can show an error message next to the appropriate field. This probably requires: A) Improving the way we return errors from webservices so that (if known) the fieldname is able to be read. B) A javascript function to take a list of errors and inject them into a form. Worth looking at
4.summary: Determine the best way to define forms in javascript.
description: Options: JS only api that loosely resembles the mforms api In a mustache template with some magic processing In php - exporting the form definition in a standard format and sending it to the JS
5.summary: Create an AMD module that will receive current data to be displayed in a form.
description: When editing a form we will need to populate the form elements with current data.
| 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: Forms improvements targeted for Moodle 3.1
description: Collection of forms improvements targeted for Moodle 3.1.
### Response:
1.summary: Convert mform element text to use a mustache template / renderable
description: Convert mform element text to use a mustache template / renderable
2.summary: Create an AMD module that will retrieve all the values for a form, ready for ajax
description: Jquery provides a $(.form).serialize() and $(.form).serializeArray() which almost do what we need - they just need to be wrapped in a function that will make the format of the array of values, match what we would expect in a webservice.
3.summary: Make a standard way to get errors from a webservice and associate them with fields in a form.
description: E.g. If we submit data to a "create_group" function, and the data fails validation, we need to know which field failed validation so we can show an error message next to the appropriate field. This probably requires: A) Improving the way we return errors from webservices so that (if known) the fieldname is able to be read. B) A javascript function to take a list of errors and inject them into a form. Worth looking at
4.summary: Determine the best way to define forms in javascript.
description: Options: JS only api that loosely resembles the mforms api In a mustache template with some magic processing In php - exporting the form definition in a standard format and sending it to the JS
5.summary: Create an AMD module that will receive current data to be displayed in a form.
description: When editing a form we will need to populate the form elements with current data.
|
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 changes for 3.2
description: This epic will consolidate the changes to the messaging UI (which also covers API changes needed).
| Unsolvable | 1.summary: Messages panel should default to the list of recent conversations
description: Default to list of recent conversations most recent at top Show icon / some visualisation for online/offline
2.summary: Discussions should be infinitely scrollable
description: Display scrollable discussion latest messages at the bottom lazy loading to allow infinite scroll-back through history (no paging) Ability to delete individual message or clear all messages
3.summary: Editable list of contacts - with option to block a user
description: editable list of contacts - with option to block a user
4.summary: Create new interface for messages/index.php
description: Change messages/index.php to use templates and create the basic app layout in place to allow working on components with it. 2 column layout to add messages and contacts tab etc.
5.summary: Search to find people across your own courses - based on which courses you are in
description: search to find people across your own courses - based on which courses you are in
6.summary: Search to find people across the site
description: Search to find people across the site
7.summary: Ability to select a found person, see their profile
description: Ability to select a found person, see their profile
8.summary: Ability to send a message to a searched user
description: Ability to send a message
9.summary: Add Contact needs a different UI to view/add contacts more like telegram/skype
description: Search current contacts first if any, if not, prompts to add New Contact option like telegram - with searching of courses After listing current matching contacts, as an extra option to search courses
10.summary: Message search
description: Shows list of the conversations where the text of message appears When clicked it loads the conversation and preloads down to where that text is found in that conversation List of saved or prior searches, with a way to clear all of them
11.summary: Preferences Page
description: This page should be split into two main parts: User messages preferences A site option to default users to force only contacts for messages (off by default) Notifications preferences (for other automatic notifications) Enables user to manage the preferences as now, but with a more simplified interface Grouped by System and Courses, perhaps collapsible Hide the offline/online better in the UI Move output configurations to their own pages Perhaps modal screen with gear on top of each column
12.summary: Make the notifications more like a stream of events
description: Date to be shown as time past e.g. 1 hour ago, 1 day ago Name highlighted Course highlighted Key message separated ICON for the correct type of activity/thing Unlimited scrolling back Additionally, the Notifications preferences should be directly accessed from here. Should be accessible easily via function/API to show in dashboard block, or in menu (unread notification count???)
13.summary: User Profile Page
description: Button to "Add to my contacts" ( Friending ) Button to "Send a message" (exists) Should have a number on it if messages pending from user When clicked, shows popup with message history and ability to send a new one
14.summary: Add message custom menu item
description: Option to mark all messages as read Add icon for messages (chat message icon from mobile app) Icon will be plain when no notifications pending Icon will show a badge (number) on it when there are some messages pending The badge count for messages only decreases when you actually go in and view that conversation and message itself is marked as read Dropdown shows the recent conversations
15.summary: Add notification custom menu item
description: Icon for notifications (Bell as per mobile app). Icons will be plain when no unread notifications pending Icon will show a badge on it when there are unread notifications When dropdown is viewed notifications are marked as read Dropdown always shows recent notifications (read or not)
16.summary: Deprecate any functions in message/lib.php that are no longer used
description: Go through message/lib.php and deprecate any remaining functions that are not used (make sure to re-check the file if you deprecate a function as the deprecated function may have been using a function you checked prior and did not deprecate because it was in use).
17.summary: Replace popup message type with notification menu in menu bar
description: Replace the popup notification type in favour of the header nav bar notification method. It is redundant to have both.
18.summary: Replace asterix being used to show online users
description: We need to display something more noticeable than an asterix. It is simply a placeholder for now.
19.summary: We need to display a message if there are no conversations or contacts
description: Currently the space is empty. Tell the user something.
20.summary: Show message when no search results found
description: If a user searches something and there are no search results then the panel is left empty - we should show them something.
21.summary: Most recent message in conversation shown in popover and contact panel should indicate who sent it
description: We need to indicate who was the person who sent the last message viewed. This is done in numerous apps (see FB, telegram, skype, text messaging). Currently you have no idea if the last message shown in the popover or contact panel was from you or the other user.
22.summary: Separate page for notifications
description: Notifications should have its own page, not just a drop down.
23.summary: Show icons for blocked users
description: Need to be able to quickly identify which users are blocked.
24.summary: Initial page with no contacts/conversations needs text
description: There will be a lot of users who have never used messaging before because the old system was bad. We need to provide more information on the messaging page if the user has no messages or contacts.
25.summary: Make sure "do not reply email" isnt showing up in conversations
description: Juan mentioned they ran into something like that in the mobile app. See for details.
26.summary: The messaging button on a users profile should take them to the messaging UI
description: Currently it opens a pop-up for the user to send a message. It was decided to remove this and direct the user to the messaging page instead.
27.summary: Responsive design for messaging interface so that it is usable on smaller screens
description: The messaging interface needs to look good on smaller screens as well.
28.summary: Improve notification popover
description: Remove the one-line summary. For the notification summary use HTML always. No expand or collapse, use read more link that directs to notifications page (to do in ). Remove all/new slider - show unread notifications same as for messages (include access hide text for Unread notification for accessibility).
29.summary: Add help icon to explain online and offline on preferences page.
description: Its confusing terminology. Maybe change the strings to logged in / logged out?
30.summary: Revert hack used to display only one checkbox for the Web notification preferences
description: This was done just before UX testing, its not nice and was a quick hack, see -
31.summary: Accessibility improvements for messaging and notification popover
description: Include access hide text for unread messages. Bold text and gray background for unread messages to keep consistent with notifications page (see ).
32.summary: Add class properties and improve docs for message area renderables
description: It was easier for early development to be able to change it at a whim with little effort but I think for readability purposes (noted by fred (fresh eyes)) it is a lot easier having docs so we know what each renderable consists of, rather than guessing what the stdClass being passed contains by looking at export_for_template.
33.summary: "Delete all" conversation deletion should pop up a confirmation dialogue
description: After changing the way conversations are deleted to be a single click on "Delete all" we should add a confirmation dialogue to make sure a user doesnt accidentally delete a conversation. Changes to conversation deletion are done in
34.summary: Change "forced" language string in preference pages
description: Change the "forced" language string in the preference pages to something else. The string shows up when the admin forces a type of notification to be on at a site level.
35.summary: Add "New Message" button to messaging app
description: Add a "New Message" button to create a new message without having to look someone up in the contacts tab and choosing a user.
36.summary: Change language to "Direct Message" on profile page
description: Change language string from "Message" to "Direct Message" on profile page.
37.summary: Verify how "block non-contacts from messaging me" setting works
description: Confirm that if that setting is enabled that only users Ive added as a contact can message me, not users whove added me as a contact.
38.summary: Change conversations to messages in messaging UI
description: Martin asked for "messages" and "conversations" to be changed to "chats". To make sure "Chat" is translated. AMOS script Change other references to "messages" or "conversations" to "chats" while youre at it.
39.summary: The API and WS should not be tied directly to renderables
description: Ideally they should be returning generic information that can then be used to create an instance of a renderable if needed, or be used by other parts of the code.
40.summary: Do not store all selectors in one JS file
description: The selector list in message_area.js contains the list of all the selectors, which got quite large in the end.
41.summary: Fix messaging UI in boost
description: Its currently broken, very very broken.
42.summary: Confirming delete all does not unlock the search bar or contacts tab
description: Go to the messaging area. Click on a conversations. Click on Edit. Click on Delete all. Confirm the deletion. Try click on the contacts tab and notice you cant.
43.summary: Fix issues from integration review
description: Fix the issues Dan raised in his review.
44.summary: Fix failing behat tests
description: We need to ensure behat is passing before we can submit for integration.
45.summary: Invalid response from message_get_profile WS
description: The messagearea_get_profile can fail due to the renderable returning get_string($this->country, countries); in export_for_template but the WS expecting core_user::get_property_type(country). Example - noformatcountry => Invalid response value detected: Invalid external api response: the value is "New Zealand", the server was expecting "alpha" typeError code: invalidresponsenoformat
46.summary: WS fails when user is required to change password
description: Log in as an admin. Edit the profile for another user. Set Force password change. Log in as that user. Notice the following error is thrown by the WS. noformat You cannot proceed without changing your password, however there is no available page for changing it. Please contact your Moodle Administrator. noformat
| 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 changes for 3.2
description: This epic will consolidate the changes to the messaging UI (which also covers API changes needed).
### Response:
1.summary: Messages panel should default to the list of recent conversations
description: Default to list of recent conversations most recent at top Show icon / some visualisation for online/offline
2.summary: Discussions should be infinitely scrollable
description: Display scrollable discussion latest messages at the bottom lazy loading to allow infinite scroll-back through history (no paging) Ability to delete individual message or clear all messages
3.summary: Editable list of contacts - with option to block a user
description: editable list of contacts - with option to block a user
4.summary: Create new interface for messages/index.php
description: Change messages/index.php to use templates and create the basic app layout in place to allow working on components with it. 2 column layout to add messages and contacts tab etc.
5.summary: Search to find people across your own courses - based on which courses you are in
description: search to find people across your own courses - based on which courses you are in
6.summary: Search to find people across the site
description: Search to find people across the site
7.summary: Ability to select a found person, see their profile
description: Ability to select a found person, see their profile
8.summary: Ability to send a message to a searched user
description: Ability to send a message
9.summary: Add Contact needs a different UI to view/add contacts more like telegram/skype
description: Search current contacts first if any, if not, prompts to add New Contact option like telegram - with searching of courses After listing current matching contacts, as an extra option to search courses
10.summary: Message search
description: Shows list of the conversations where the text of message appears When clicked it loads the conversation and preloads down to where that text is found in that conversation List of saved or prior searches, with a way to clear all of them
11.summary: Preferences Page
description: This page should be split into two main parts: User messages preferences A site option to default users to force only contacts for messages (off by default) Notifications preferences (for other automatic notifications) Enables user to manage the preferences as now, but with a more simplified interface Grouped by System and Courses, perhaps collapsible Hide the offline/online better in the UI Move output configurations to their own pages Perhaps modal screen with gear on top of each column
12.summary: Make the notifications more like a stream of events
description: Date to be shown as time past e.g. 1 hour ago, 1 day ago Name highlighted Course highlighted Key message separated ICON for the correct type of activity/thing Unlimited scrolling back Additionally, the Notifications preferences should be directly accessed from here. Should be accessible easily via function/API to show in dashboard block, or in menu (unread notification count???)
13.summary: User Profile Page
description: Button to "Add to my contacts" ( Friending ) Button to "Send a message" (exists) Should have a number on it if messages pending from user When clicked, shows popup with message history and ability to send a new one
14.summary: Add message custom menu item
description: Option to mark all messages as read Add icon for messages (chat message icon from mobile app) Icon will be plain when no notifications pending Icon will show a badge (number) on it when there are some messages pending The badge count for messages only decreases when you actually go in and view that conversation and message itself is marked as read Dropdown shows the recent conversations
15.summary: Add notification custom menu item
description: Icon for notifications (Bell as per mobile app). Icons will be plain when no unread notifications pending Icon will show a badge on it when there are unread notifications When dropdown is viewed notifications are marked as read Dropdown always shows recent notifications (read or not)
16.summary: Deprecate any functions in message/lib.php that are no longer used
description: Go through message/lib.php and deprecate any remaining functions that are not used (make sure to re-check the file if you deprecate a function as the deprecated function may have been using a function you checked prior and did not deprecate because it was in use).
17.summary: Replace popup message type with notification menu in menu bar
description: Replace the popup notification type in favour of the header nav bar notification method. It is redundant to have both.
18.summary: Replace asterix being used to show online users
description: We need to display something more noticeable than an asterix. It is simply a placeholder for now.
19.summary: We need to display a message if there are no conversations or contacts
description: Currently the space is empty. Tell the user something.
20.summary: Show message when no search results found
description: If a user searches something and there are no search results then the panel is left empty - we should show them something.
21.summary: Most recent message in conversation shown in popover and contact panel should indicate who sent it
description: We need to indicate who was the person who sent the last message viewed. This is done in numerous apps (see FB, telegram, skype, text messaging). Currently you have no idea if the last message shown in the popover or contact panel was from you or the other user.
22.summary: Separate page for notifications
description: Notifications should have its own page, not just a drop down.
23.summary: Show icons for blocked users
description: Need to be able to quickly identify which users are blocked.
24.summary: Initial page with no contacts/conversations needs text
description: There will be a lot of users who have never used messaging before because the old system was bad. We need to provide more information on the messaging page if the user has no messages or contacts.
25.summary: Make sure "do not reply email" isnt showing up in conversations
description: Juan mentioned they ran into something like that in the mobile app. See for details.
26.summary: The messaging button on a users profile should take them to the messaging UI
description: Currently it opens a pop-up for the user to send a message. It was decided to remove this and direct the user to the messaging page instead.
27.summary: Responsive design for messaging interface so that it is usable on smaller screens
description: The messaging interface needs to look good on smaller screens as well.
28.summary: Improve notification popover
description: Remove the one-line summary. For the notification summary use HTML always. No expand or collapse, use read more link that directs to notifications page (to do in ). Remove all/new slider - show unread notifications same as for messages (include access hide text for Unread notification for accessibility).
29.summary: Add help icon to explain online and offline on preferences page.
description: Its confusing terminology. Maybe change the strings to logged in / logged out?
30.summary: Revert hack used to display only one checkbox for the Web notification preferences
description: This was done just before UX testing, its not nice and was a quick hack, see -
31.summary: Accessibility improvements for messaging and notification popover
description: Include access hide text for unread messages. Bold text and gray background for unread messages to keep consistent with notifications page (see ).
32.summary: Add class properties and improve docs for message area renderables
description: It was easier for early development to be able to change it at a whim with little effort but I think for readability purposes (noted by fred (fresh eyes)) it is a lot easier having docs so we know what each renderable consists of, rather than guessing what the stdClass being passed contains by looking at export_for_template.
33.summary: "Delete all" conversation deletion should pop up a confirmation dialogue
description: After changing the way conversations are deleted to be a single click on "Delete all" we should add a confirmation dialogue to make sure a user doesnt accidentally delete a conversation. Changes to conversation deletion are done in
34.summary: Change "forced" language string in preference pages
description: Change the "forced" language string in the preference pages to something else. The string shows up when the admin forces a type of notification to be on at a site level.
35.summary: Add "New Message" button to messaging app
description: Add a "New Message" button to create a new message without having to look someone up in the contacts tab and choosing a user.
36.summary: Change language to "Direct Message" on profile page
description: Change language string from "Message" to "Direct Message" on profile page.
37.summary: Verify how "block non-contacts from messaging me" setting works
description: Confirm that if that setting is enabled that only users Ive added as a contact can message me, not users whove added me as a contact.
38.summary: Change conversations to messages in messaging UI
description: Martin asked for "messages" and "conversations" to be changed to "chats". To make sure "Chat" is translated. AMOS script Change other references to "messages" or "conversations" to "chats" while youre at it.
39.summary: The API and WS should not be tied directly to renderables
description: Ideally they should be returning generic information that can then be used to create an instance of a renderable if needed, or be used by other parts of the code.
40.summary: Do not store all selectors in one JS file
description: The selector list in message_area.js contains the list of all the selectors, which got quite large in the end.
41.summary: Fix messaging UI in boost
description: Its currently broken, very very broken.
42.summary: Confirming delete all does not unlock the search bar or contacts tab
description: Go to the messaging area. Click on a conversations. Click on Edit. Click on Delete all. Confirm the deletion. Try click on the contacts tab and notice you cant.
43.summary: Fix issues from integration review
description: Fix the issues Dan raised in his review.
44.summary: Fix failing behat tests
description: We need to ensure behat is passing before we can submit for integration.
45.summary: Invalid response from message_get_profile WS
description: The messagearea_get_profile can fail due to the renderable returning get_string($this->country, countries); in export_for_template but the WS expecting core_user::get_property_type(country). Example - noformatcountry => Invalid response value detected: Invalid external api response: the value is "New Zealand", the server was expecting "alpha" typeError code: invalidresponsenoformat
46.summary: WS fails when user is required to change password
description: Log in as an admin. Edit the profile for another user. Set Force password change. Log in as that user. Notice the following error is thrown by the WS. noformat You cannot proceed without changing your password, however there is no available page for changing it. Please contact your Moodle Administrator. noformat
|
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: Security and Privacy
description: Security and Privacy
| Unsolvable | 1.summary: Come up with statement, approach, and workflow for privacy/security testing
description: This needs to be ready for the same time as the grant announcement. ---- IMPORTANT: See thread
2.summary: Review recommendations from paper "Keeping Unwanted Messages Off the Fediverse"
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: MoodleNet
summary: Security and Privacy
description: Security and Privacy
### Response:
1.summary: Come up with statement, approach, and workflow for privacy/security testing
description: This needs to be ready for the same time as the grant announcement. ---- IMPORTANT: See thread
2.summary: Review recommendations from paper "Keeping Unwanted Messages Off the Fediverse"
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: Mobile improvements for Dashboard and Course Overview page
description: This is the Mobile Epic for
| Unsolvable | 1.summary: Create New "Recent accessed items" block
description: Following
2.summary: Add "All" option to dropdown menu in my overview courses
description: The dropdown menu will be implemented in Moodle 3.6, see and .
3.summary: Dropdown to filter events by days in timeline
description: New dropdown menu to filter events in timeline implemented as a part of . The current webservice function core_calendar_get_action_events_by_course can be used for all sort options with the correct "timesortfrom" and "timesortto" parameters.
4.summary: Group timeline events by date
description: The new timeline block in Moodle 3.6 implemented as part of groups the list of events by date (see the prototype in the MDL issue).
5.summary: Get dashboard block info
description: There a new WS on called core_block_get_dashboard_blocks. We should get data from that to show blocks on the dashboard. Current courses and timeline tabs should be shown as blocks.
6.summary: Add ability to hide courses from the course overview page
description: Following
7.summary: Add ability to star courses from the course overview page
description: Following
8.summary: Create New "Recent Courses" Block
description: Following
9.summary: Add hidden and starred option to dropdown menu in my overview block
description: Related to and . It does not use visible field since its a separate functionlity from hidden by the teacher.
10.summary: Separate my overview and timeline from core
description: Divide both blocks adding a new blocks infrastructure.
11.summary: Add user preferences to remember view selections in timeline and myoverview block
description: Like and but saving the preference in the localstorage.
12.summary: Create Sort dropdown with "Last accessed & Title" in course overview
description: See and . We need some way to get the last access time of the user in each course, the WS function core_enrol_get_users_courses does not return the last access.
13.summary: Add Starred option to Dashboard
description: Related to
14.summary: Build Starred Courses Block
description: Following
15.summary: Add View dropdown with Card, List and Summary views to my overview
description: See and .
16.summary: Improve on dashboard blocks interface
description: We shoud discuss with UX how do we show blocks on the dashboard. The current solution shows all the blocks one bellow the other but navigation can be very difficult due to scrolling. Some ideas are: Show blocks as tabs. Show a selector on top to filter the block to be shown. Have a list of blocks and click on the title to navigate to the content. Collapsible blocks. A mix of solutions. We can have the same problem in the site home, also in the future course blocks. Please note that phone and tablet/desktop views are completely different. For desktop and tablet we can try to mimic what the web interface does but for mobile phone view we have several doubts like if we should implement horizontal scrolling as it is being done in the Starred and Recent courses blocks, etc..
17.summary: Add and review improvements done on dashboard
description: There are some tiny issues coming up with . is related to . Do not show summary on card view anymore. Add horizontal scroll to recently accessed courses and starred courses. Add horizontal scroll to Recently accessed items. Remove progress bar and actions on course cards different from Course overview. Show 2+ cards on horizontal scroll on init. Reduce card height to match web version.
| 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: Mobile improvements for Dashboard and Course Overview page
description: This is the Mobile Epic for
### Response:
1.summary: Create New "Recent accessed items" block
description: Following
2.summary: Add "All" option to dropdown menu in my overview courses
description: The dropdown menu will be implemented in Moodle 3.6, see and .
3.summary: Dropdown to filter events by days in timeline
description: New dropdown menu to filter events in timeline implemented as a part of . The current webservice function core_calendar_get_action_events_by_course can be used for all sort options with the correct "timesortfrom" and "timesortto" parameters.
4.summary: Group timeline events by date
description: The new timeline block in Moodle 3.6 implemented as part of groups the list of events by date (see the prototype in the MDL issue).
5.summary: Get dashboard block info
description: There a new WS on called core_block_get_dashboard_blocks. We should get data from that to show blocks on the dashboard. Current courses and timeline tabs should be shown as blocks.
6.summary: Add ability to hide courses from the course overview page
description: Following
7.summary: Add ability to star courses from the course overview page
description: Following
8.summary: Create New "Recent Courses" Block
description: Following
9.summary: Add hidden and starred option to dropdown menu in my overview block
description: Related to and . It does not use visible field since its a separate functionlity from hidden by the teacher.
10.summary: Separate my overview and timeline from core
description: Divide both blocks adding a new blocks infrastructure.
11.summary: Add user preferences to remember view selections in timeline and myoverview block
description: Like and but saving the preference in the localstorage.
12.summary: Create Sort dropdown with "Last accessed & Title" in course overview
description: See and . We need some way to get the last access time of the user in each course, the WS function core_enrol_get_users_courses does not return the last access.
13.summary: Add Starred option to Dashboard
description: Related to
14.summary: Build Starred Courses Block
description: Following
15.summary: Add View dropdown with Card, List and Summary views to my overview
description: See and .
16.summary: Improve on dashboard blocks interface
description: We shoud discuss with UX how do we show blocks on the dashboard. The current solution shows all the blocks one bellow the other but navigation can be very difficult due to scrolling. Some ideas are: Show blocks as tabs. Show a selector on top to filter the block to be shown. Have a list of blocks and click on the title to navigate to the content. Collapsible blocks. A mix of solutions. We can have the same problem in the site home, also in the future course blocks. Please note that phone and tablet/desktop views are completely different. For desktop and tablet we can try to mimic what the web interface does but for mobile phone view we have several doubts like if we should implement horizontal scrolling as it is being done in the Starred and Recent courses blocks, etc..
17.summary: Add and review improvements done on dashboard
description: There are some tiny issues coming up with . is related to . Do not show summary on card view anymore. Add horizontal scroll to recently accessed courses and starred courses. Add horizontal scroll to Recently accessed items. Remove progress bar and actions on course cards different from Course overview. Show 2+ cards on horizontal scroll on init. Reduce card height to match web version.
|
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: Fix the messaging table mess to allow group functionality (and more) for future releases
description: Currently there are two tables (message and message_read) with messages jumping between them. Notifications are also stored in these tables. It is time to fix this mess.
| Unsolvable | 1.summary: Create new tables for messages and notifications and convert existing API to use these
description: Currently we have message and message_read. These could be a single table with a "read" column. Some amount of profiling will be necessary to check that the check for unread messages does not unduly burden the server if the message table is large.
2.summary: Write ad-hoc task to upgrade old messages to the new system
description: It will be common for sites to have 10 million+ messages/notifications in these tables. We need to create a sensible way to transfer this data to the new table structures.
| 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: Fix the messaging table mess to allow group functionality (and more) for future releases
description: Currently there are two tables (message and message_read) with messages jumping between them. Notifications are also stored in these tables. It is time to fix this mess.
### Response:
1.summary: Create new tables for messages and notifications and convert existing API to use these
description: Currently we have message and message_read. These could be a single table with a "read" column. Some amount of profiling will be necessary to check that the check for unread messages does not unduly burden the server if the message table is large.
2.summary: Write ad-hoc task to upgrade old messages to the new system
description: It will be common for sites to have 10 million+ messages/notifications in these tables. We need to create a sensible way to transfer this data to the new table structures.
|
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: Add facility for students to enter appointment-related data
description: Several feature requests have been made regarding data that is provided by students when they book an appointment - for example, they could choose the location of the appointment or upload a file. Im just collecting these requests here for a better overview.
| Solvable | 1.summary: New Scheduler setting allowing students to enter a location
description: I was at a meeting with one of our departments today, and they thought that Scheduler has a great deal of potential. We went through setting up an instance and then somebody said "How can students tell us where they are?" Huh?? Turns out that these meetings take place at a location the student chooses - that might be in their space, or in a place where they would like to display their work, or somebodys office, or wherever. Theyre art students, but this would be good for students of design, performance, horticulture, anything involving site visits, etc. So Id like to propose an extra setting which when enabled gives each slot an extra text field with a label prompting students to enter a location. Where enabled, this should be forced, so students can only save once they have completed it. Where an existing record is changed, this should trigger an email to both student and tutor.
2.summary: Comment field in Scheduler
description: The scheduler is very handy and works quite well so far. However, a comments field (let us name the field) where the registrant can put in a small text for the teacher would be really helpful. The text could contain the agenda for the meeting and perhaps a link to the folder of the project.
| 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: Add facility for students to enter appointment-related data
description: Several feature requests have been made regarding data that is provided by students when they book an appointment - for example, they could choose the location of the appointment or upload a file. Im just collecting these requests here for a better overview.
### Response:
1.summary: New Scheduler setting allowing students to enter a location
description: I was at a meeting with one of our departments today, and they thought that Scheduler has a great deal of potential. We went through setting up an instance and then somebody said "How can students tell us where they are?" Huh?? Turns out that these meetings take place at a location the student chooses - that might be in their space, or in a place where they would like to display their work, or somebodys office, or wherever. Theyre art students, but this would be good for students of design, performance, horticulture, anything involving site visits, etc. So Id like to propose an extra setting which when enabled gives each slot an extra text field with a label prompting students to enter a location. Where enabled, this should be forced, so students can only save once they have completed it. Where an existing record is changed, this should trigger an email to both student and tutor.
2.summary: Comment field in Scheduler
description: The scheduler is very handy and works quite well so far. However, a comments field (let us name the field) where the registrant can put in a small text for the teacher would be really helpful. The text could contain the agenda for the meeting and perhaps a link to the folder of the project.
|
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.0.2 upgrade
description: Moodle 3.0.2 scheduled release: Monday 11 January 2016
| Unsolvable | 1.summary: Upgrade moodle.org to 3.0.2
description:
2.summary: Upgrade learn.moodle.net to 3.0.2
description:
3.summary: Upgrade lang.moodle.org to 3.0.2
description:
4.summary: Upgrade school.demo.moodle.net to 3.0.2
description:
5.summary: Upgrade demo.moodle.net to 3.0.2
description:
6.summary: Upgrade dev.moodle.org to 3.0.2
description:
7.summary: Upgrade moodle.net to 3.0.2
description:
8.summary: Upgrade moodlemoot.org sites to 3.0.2
description:
9.summary: Upgrade download.moodle.org to 3.0.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 Community Sites 3.0.2 upgrade
description: Moodle 3.0.2 scheduled release: Monday 11 January 2016
### Response:
1.summary: Upgrade moodle.org to 3.0.2
description:
2.summary: Upgrade learn.moodle.net to 3.0.2
description:
3.summary: Upgrade lang.moodle.org to 3.0.2
description:
4.summary: Upgrade school.demo.moodle.net to 3.0.2
description:
5.summary: Upgrade demo.moodle.net to 3.0.2
description:
6.summary: Upgrade dev.moodle.org to 3.0.2
description:
7.summary: Upgrade moodle.net to 3.0.2
description:
8.summary: Upgrade moodlemoot.org sites to 3.0.2
description:
9.summary: Upgrade download.moodle.org to 3.0.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: Epic: Collect together deprecated and planned code changes for Moodle 3.1
description: In 3.1 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.1. 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 functio issues and not lose sight of them, this issue will be used to collect them together.
| Unsolvable | 1.summary: Deprecate writing to legacy log store
description: Deprecate writing to legacy log store. 2.9 is probably not the right time for it, but I am adding this here to keep track of when this should be deprecated. Also, deprecate xxx_get_view_actions() and xxx_get_post_actions() from all modules.
2.summary: Remove removedoublecr() and importmodifiedaikenstyle()
description: Deprecated in
3.summary: Remove get_collapsing_icon()
description: Deprecated in
4.summary: Remove calendar_normalize_tz()
description: calendar_normalize_tz()s functionality is being replaced by calendar_map_windows_to_olson(), introduced in .
5.summary: Remove message_current_user_is_involved()
description: Deprecated in .
6.summary: Remove sql_internal_reader, sql_select_reader and other deprecations
description: Deprecated during
7.summary: Remove deprecated web services
description: Final deprecation after . We decided to delay it one more major version to give time to users who customized the moodle mobile app
8.summary: Remove block_base->config_save()
description: Deprecated in
9.summary: Drop support for old navigation API callbacks in local plugins
description: Given that is integrated into Moodle 2.9, we should drop support for the old callbacks (with _extends_ in the name) for local plugins. The code is to be simplified to something like code foreach (get_plugin_list_with_function(local, extend_navigation) as $function) $function($this); code
10.summary: Remove guess_antolope_row_size()
description: The method guess_antolope_row_size() was deprecated on 2.9. Now, we should proceed with the final deprecation of this method.
11.summary: Remove useredit_shared_definition_preferences()
description: Remove useredit_shared_definition_preferences() was deprecated on 2.9. Now, we should proceed with the final deprecation of this method.
12.summary: Remove set_logging()
description: Remove set_logging() in lib/dml/moodle_database.php as it is not used anywhere in core.
13.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php in 3.1
description: As per all functions in lib/deprecatedlib.php that were deprecated in 2.9 should be replaced with exceptions in 3.1 Make sure is completed, otherwise remove body of functions deprecated earlier if needed This includes all functions in lib/deprecatedlib.php that say since 2.9 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.1 - please list them in this issue description_
14.summary: Properly deprecate get_file_url()
description: Properly deprecate get_file_url() with debugging message Usages get_file_url() code backup/util/helper/restore_structure_parser_processor.class.php: $replace = array(get_file_url($this->courseid)); lib/rsslib.php: return get_file_url($contextid./.$usertoken./.$componentname./.$additionalargs./rss.xml, null, rssfile); lib/wiki_to_markdown.php: $coursefileurl = get_file_url($this->courseid); code
15.summary: Properly deprecate notify()
description: Properly deprecate notify() notify() code backup/cc/cc2moodle.php: notify(The course is empty); backup/cc/entities.class.php: notify(WARNING: Cannot copy the file . $source . to . $destination); backup/cc/restore_cc.php: notify(get_string(cc_import_req_php5, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_dom, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_libxml, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_libxmlminversion, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_xsl, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_req_auth, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_invalid_schema, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_manifest_dont_load, imscc)); question/engine/upgrade/upgradelib.php: notify("Question sessions for questions " . code
16.summary: Deprecate the old events system
description: While it has been implied that the new events system was replacing the old one, only a debugging message for those using _events_trigger_ directly was showing up. At some point we will have to remove: - events_trigger() - The old events trigger from the new one (cf. get_legacy_eventname, get_legacy_eventdata) - events_trigger_legacy() - The handler system Though before we remove those we must deprecate them, then only 2 releases later we will be able to entirely remove these API. IMO the deprecation of these can happen any time from now, the new events were shipped with 2.6.
17.summary: Remove deprecated capabilities from list
description: There are two capabilities with names This capability is deprecated and does nothing. Surely they dont need to be listed on the edit roles page and course and activity permissions pages? !deprecated caps.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: Epic: Collect together deprecated and planned code changes for Moodle 3.1
description: In 3.1 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.1. 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 functio issues and not lose sight of them, this issue will be used to collect them together.
### Response:
1.summary: Deprecate writing to legacy log store
description: Deprecate writing to legacy log store. 2.9 is probably not the right time for it, but I am adding this here to keep track of when this should be deprecated. Also, deprecate xxx_get_view_actions() and xxx_get_post_actions() from all modules.
2.summary: Remove removedoublecr() and importmodifiedaikenstyle()
description: Deprecated in
3.summary: Remove get_collapsing_icon()
description: Deprecated in
4.summary: Remove calendar_normalize_tz()
description: calendar_normalize_tz()s functionality is being replaced by calendar_map_windows_to_olson(), introduced in .
5.summary: Remove message_current_user_is_involved()
description: Deprecated in .
6.summary: Remove sql_internal_reader, sql_select_reader and other deprecations
description: Deprecated during
7.summary: Remove deprecated web services
description: Final deprecation after . We decided to delay it one more major version to give time to users who customized the moodle mobile app
8.summary: Remove block_base->config_save()
description: Deprecated in
9.summary: Drop support for old navigation API callbacks in local plugins
description: Given that is integrated into Moodle 2.9, we should drop support for the old callbacks (with _extends_ in the name) for local plugins. The code is to be simplified to something like code foreach (get_plugin_list_with_function(local, extend_navigation) as $function) $function($this); code
10.summary: Remove guess_antolope_row_size()
description: The method guess_antolope_row_size() was deprecated on 2.9. Now, we should proceed with the final deprecation of this method.
11.summary: Remove useredit_shared_definition_preferences()
description: Remove useredit_shared_definition_preferences() was deprecated on 2.9. Now, we should proceed with the final deprecation of this method.
12.summary: Remove set_logging()
description: Remove set_logging() in lib/dml/moodle_database.php as it is not used anywhere in core.
13.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php in 3.1
description: As per all functions in lib/deprecatedlib.php that were deprecated in 2.9 should be replaced with exceptions in 3.1 Make sure is completed, otherwise remove body of functions deprecated earlier if needed This includes all functions in lib/deprecatedlib.php that say since 2.9 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.1 - please list them in this issue description_
14.summary: Properly deprecate get_file_url()
description: Properly deprecate get_file_url() with debugging message Usages get_file_url() code backup/util/helper/restore_structure_parser_processor.class.php: $replace = array(get_file_url($this->courseid)); lib/rsslib.php: return get_file_url($contextid./.$usertoken./.$componentname./.$additionalargs./rss.xml, null, rssfile); lib/wiki_to_markdown.php: $coursefileurl = get_file_url($this->courseid); code
15.summary: Properly deprecate notify()
description: Properly deprecate notify() notify() code backup/cc/cc2moodle.php: notify(The course is empty); backup/cc/entities.class.php: notify(WARNING: Cannot copy the file . $source . to . $destination); backup/cc/restore_cc.php: notify(get_string(cc_import_req_php5, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_dom, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_libxml, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_libxmlminversion, imscc)); backup/cc/restore_cc.php: notify(get_string(cc_import_req_xsl, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_req_auth, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_invalid_schema, imscc)); backup/cc/restore_cc.php: notify(get_string(cc2moodle_manifest_dont_load, imscc)); question/engine/upgrade/upgradelib.php: notify("Question sessions for questions " . code
16.summary: Deprecate the old events system
description: While it has been implied that the new events system was replacing the old one, only a debugging message for those using _events_trigger_ directly was showing up. At some point we will have to remove: - events_trigger() - The old events trigger from the new one (cf. get_legacy_eventname, get_legacy_eventdata) - events_trigger_legacy() - The handler system Though before we remove those we must deprecate them, then only 2 releases later we will be able to entirely remove these API. IMO the deprecation of these can happen any time from now, the new events were shipped with 2.6.
17.summary: Remove deprecated capabilities from list
description: There are two capabilities with names This capability is deprecated and does nothing. Surely they dont need to be listed on the edit roles page and course and activity permissions pages? !deprecated caps.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: Prepare Moodle for PHP7
description: PHP 7 is on the horizon for October of this year. It needs to be tested for compatibility, as there are some backwards compatibility breakers in there. So by the time PHP 7 rolls around, we need to either a) be confident that Moodle will run fine (and probably blazing fast!) on it, or b) We need to update our required versions to put an upper cap on supported versions, as all our release notes and checks are 5.4.4 (or whatever) and higher. If changes are needed, we may want to amend old release notes for no longer supported Moodle versions with upper limits. I know its still early on, but I want to make sure this gets on the radar, as PHP 7 is supposed to drop right around the time of Moodle 3.0. You can see the accepted changes for PHP 7 here:
| Unsolvable | 1.summary: Replace reserved word usage from \core\progress\null (PHP7)
description: "null" has become a reserved word in PHP7, meaning it cannot be used for a class name, as is done by \core\progress\null, or a syntax error occurs. Here is a change renaming the class to none.
2.summary: Upgrade to phpunit 4.x
description: Moodle is currently using quite an ancient and unsupported phpunit. This means we cannot expect new features or bug fixes for the used release, which can create problems for test development. Also, I found when testing with php7 that something weird happens in the phpunit error handler, resulting in "class not found" fatals - this doesnt happen with newer phpunit, so rather than working around it (probably a temporary php7 bug anyway), I figure we can just upgrade phpunit as something more worthwhile. established that there is some deprecated assertions, in particular, calls to assertTag and assertNotTag. I have implemented one of the proposed solutions as an override function which implements the functionality Moodle needs, via some XPath queries generated in the test.
3.summary: Get working support for PHP7 in core (all-in-one auto-generated branch)
description: AFAIK the only remaining core issues needed for PHP7 () to work are: 1) Handful of syntax errors (improper break/continue, duplicate function args) 2) deprecated PHP4 style constructor usage in core and bundled libs 3) Testing, core handler, should gracefully deal with new Throwables 4) eval() may throw new ParseError and other Throwables Ive resolved these with some help from tests and a script to perform the bulk deprecated constructor updates (see: - this uses a proper php-parser, so it is a little more reliable than what I could cobble together with sed.
4.summary: PHP7 constructor changes
description: tlevi has made a first pass at these, however we need to split these out into moodle core, moodle third-party supported libs, and the third-party libs were going to have to hack. Additionally, this should depend upon in order to simplify the deprecation process.
5.summary: Use proper __construct in forms API for PHP7 support
description: in forms API we use class name as constructor, should be __construct()
6.summary: Make Moodle code compatible with Exception/Throwable changes in PHP7
description:
7.summary: Authentication API: all constructors should be called __construct() to be compatible with PHP7
description: Authentication API: all constructors should be called __construct() to be compatible with PHP7
8.summary: Upgrade ADODB to 5.20.1 for PHP7 compatibility
description: ADODB just released 5.20 with PHP7 fixes.
9.summary: Upgrade FPDI to 1.6 for php7 compatibility
description: claims that version 1.6.0 is php7 compatible.
10.summary: Upgrade (or patch) Horde library
description: We currently have 5.2.7, latest released 5.2.8| but we actually need the next one that will contain commit
11.summary: Auth_Radius in 2.9 uses constructors deprecated in PHP7
description: Library auth_radius was upgraded in 3.0 but in 2.9 it is still old
12.summary: Replace reserved word usage from \core\progress\null (PHP7) (backport of )
description: Request to backport to 2.9
13.summary: Remove PHP7 restriction
description: This will be a final task in the PHP7 support epic
14.summary: set_magic_quotes_runtime and magic_quotes_runtime removed from php7
description: git grep "set_magic_quotes_runtime(" highlights some required changes: adodb: they are commented phpmailer: should be fine phpexcel: Just commented in seems better to do it there (no strong opinion about it) tcpdf: I doubt they will change it, we should probably address this one as part of this issue
15.summary: preg_replace /e removed from PHP7
description: As reported by php7cc: code File: /home/davidm/Desktop/moodlecode/int/master/lib/typo3/class.t3lib_div.php > Line 5380: Removed regular expression modifier "e" used preg_replace(/( \"()+|$))/eiU, self::makeRedirectUrl("\\0", . $lengthLimit . ," . $index_script_url . "), $message); code code File: /home/davidm/Desktop/moodlecode/int/master/lib/editor/tinymce/plugins/spellchecker/classes/GoogleSpell.php > Line 132: Removed regular expression modifier "e" used preg_replace(&x(0-9a-f+);ei, chr(hexdec("\\1")), $string); > Line 133: Removed regular expression modifier "e" used preg_replace(&(0-9+);e, chr(\\1), $string); code code File: /home/davidm/Desktop/moodlecode/int/master/lib/adodb/drivers/adodb-db2ora.inc.php > Line 41: Removed regular expression modifier "e" used preg_replace(/(:0-9+)/e, _colontrack(\\\1\), $sql); code Just commented about this in
16.summary: object reserved from php7 onwards
description: php7cc reported that object is reserved in PHP7 File: /home/davidm/Desktop/moodlecode/int/master/lib/setuplib.php > Line 66: Name "object" that is reserved for future use (does not cause an error in PHP 7) used as a class, interface or trait name class object extends \stdClass
17.summary: Link from lib.upgrade.txt
description: Would be helpful as an important reference.
| 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 PHP7
description: PHP 7 is on the horizon for October of this year. It needs to be tested for compatibility, as there are some backwards compatibility breakers in there. So by the time PHP 7 rolls around, we need to either a) be confident that Moodle will run fine (and probably blazing fast!) on it, or b) We need to update our required versions to put an upper cap on supported versions, as all our release notes and checks are 5.4.4 (or whatever) and higher. If changes are needed, we may want to amend old release notes for no longer supported Moodle versions with upper limits. I know its still early on, but I want to make sure this gets on the radar, as PHP 7 is supposed to drop right around the time of Moodle 3.0. You can see the accepted changes for PHP 7 here:
### Response:
1.summary: Replace reserved word usage from \core\progress\null (PHP7)
description: "null" has become a reserved word in PHP7, meaning it cannot be used for a class name, as is done by \core\progress\null, or a syntax error occurs. Here is a change renaming the class to none.
2.summary: Upgrade to phpunit 4.x
description: Moodle is currently using quite an ancient and unsupported phpunit. This means we cannot expect new features or bug fixes for the used release, which can create problems for test development. Also, I found when testing with php7 that something weird happens in the phpunit error handler, resulting in "class not found" fatals - this doesnt happen with newer phpunit, so rather than working around it (probably a temporary php7 bug anyway), I figure we can just upgrade phpunit as something more worthwhile. established that there is some deprecated assertions, in particular, calls to assertTag and assertNotTag. I have implemented one of the proposed solutions as an override function which implements the functionality Moodle needs, via some XPath queries generated in the test.
3.summary: Get working support for PHP7 in core (all-in-one auto-generated branch)
description: AFAIK the only remaining core issues needed for PHP7 () to work are: 1) Handful of syntax errors (improper break/continue, duplicate function args) 2) deprecated PHP4 style constructor usage in core and bundled libs 3) Testing, core handler, should gracefully deal with new Throwables 4) eval() may throw new ParseError and other Throwables Ive resolved these with some help from tests and a script to perform the bulk deprecated constructor updates (see: - this uses a proper php-parser, so it is a little more reliable than what I could cobble together with sed.
4.summary: PHP7 constructor changes
description: tlevi has made a first pass at these, however we need to split these out into moodle core, moodle third-party supported libs, and the third-party libs were going to have to hack. Additionally, this should depend upon in order to simplify the deprecation process.
5.summary: Use proper __construct in forms API for PHP7 support
description: in forms API we use class name as constructor, should be __construct()
6.summary: Make Moodle code compatible with Exception/Throwable changes in PHP7
description:
7.summary: Authentication API: all constructors should be called __construct() to be compatible with PHP7
description: Authentication API: all constructors should be called __construct() to be compatible with PHP7
8.summary: Upgrade ADODB to 5.20.1 for PHP7 compatibility
description: ADODB just released 5.20 with PHP7 fixes.
9.summary: Upgrade FPDI to 1.6 for php7 compatibility
description: claims that version 1.6.0 is php7 compatible.
10.summary: Upgrade (or patch) Horde library
description: We currently have 5.2.7, latest released 5.2.8| but we actually need the next one that will contain commit
11.summary: Auth_Radius in 2.9 uses constructors deprecated in PHP7
description: Library auth_radius was upgraded in 3.0 but in 2.9 it is still old
12.summary: Replace reserved word usage from \core\progress\null (PHP7) (backport of )
description: Request to backport to 2.9
13.summary: Remove PHP7 restriction
description: This will be a final task in the PHP7 support epic
14.summary: set_magic_quotes_runtime and magic_quotes_runtime removed from php7
description: git grep "set_magic_quotes_runtime(" highlights some required changes: adodb: they are commented phpmailer: should be fine phpexcel: Just commented in seems better to do it there (no strong opinion about it) tcpdf: I doubt they will change it, we should probably address this one as part of this issue
15.summary: preg_replace /e removed from PHP7
description: As reported by php7cc: code File: /home/davidm/Desktop/moodlecode/int/master/lib/typo3/class.t3lib_div.php > Line 5380: Removed regular expression modifier "e" used preg_replace(/( \"()+|$))/eiU, self::makeRedirectUrl("\\0", . $lengthLimit . ," . $index_script_url . "), $message); code code File: /home/davidm/Desktop/moodlecode/int/master/lib/editor/tinymce/plugins/spellchecker/classes/GoogleSpell.php > Line 132: Removed regular expression modifier "e" used preg_replace(&x(0-9a-f+);ei, chr(hexdec("\\1")), $string); > Line 133: Removed regular expression modifier "e" used preg_replace(&(0-9+);e, chr(\\1), $string); code code File: /home/davidm/Desktop/moodlecode/int/master/lib/adodb/drivers/adodb-db2ora.inc.php > Line 41: Removed regular expression modifier "e" used preg_replace(/(:0-9+)/e, _colontrack(\\\1\), $sql); code Just commented about this in
16.summary: object reserved from php7 onwards
description: php7cc reported that object is reserved in PHP7 File: /home/davidm/Desktop/moodlecode/int/master/lib/setuplib.php > Line 66: Name "object" that is reserved for future use (does not cause an error in PHP 7) used as a class, interface or trait name class object extends \stdClass
17.summary: Link from lib.upgrade.txt
description: Would be helpful as an important reference.
|
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.8 upgrade
description: Moodle 2.8 scheduled release: Monday 10 November 2014 Target completion date of this epic: Friday 14 November 2014
| Unsolvable | 1.summary: META: Upgrade moodle.org to 2.8
description:
2.summary: Upgrade demo.moodle.net to 2.8.1
description:
3.summary: Upgrade school.demo.moodle.net to 2.8
description:
4.summary: Upgrade moodle.net to 2.8
description:
5.summary: Upgrade dev.moodle.org to 2.8
description:
6.summary: Upgrade research.moodle.net to 2.8
description:
7.summary: Upgrade download.moodle.org to 2.8
description:
8.summary: Upgrade lang.moodle.org to 2.8
description:
9.summary: Upgrade learn.moodle.net to 2.5.9
description: Upgrading to the latest 2.5.x would be a good preparation for upgrading to 2.8.x ().
10.summary: Upgrade moodlemoot.org sites to 2.8.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 sites 2.8 upgrade
description: Moodle 2.8 scheduled release: Monday 10 November 2014 Target completion date of this epic: Friday 14 November 2014
### Response:
1.summary: META: Upgrade moodle.org to 2.8
description:
2.summary: Upgrade demo.moodle.net to 2.8.1
description:
3.summary: Upgrade school.demo.moodle.net to 2.8
description:
4.summary: Upgrade moodle.net to 2.8
description:
5.summary: Upgrade dev.moodle.org to 2.8
description:
6.summary: Upgrade research.moodle.net to 2.8
description:
7.summary: Upgrade download.moodle.org to 2.8
description:
8.summary: Upgrade lang.moodle.org to 2.8
description:
9.summary: Upgrade learn.moodle.net to 2.5.9
description: Upgrading to the latest 2.5.x would be a good preparation for upgrading to 2.8.x ().
10.summary: Upgrade moodlemoot.org sites to 2.8.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: MoodleNet
summary: Users should be able to @ mention other users and communities, and + mention collections
description: Users should be able to @ mention other users and communities, and + mention collections
| Solvable | 1.summary: Every (users/communities) and +mention (collection) is auto-hyperlinked
description: Every time a user another user or a community, or +mentions a collection, it should be auto-hyperlinked to the relevant user/community/collection.
| 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 @ mention other users and communities, and + mention collections
description: Users should be able to @ mention other users and communities, and + mention collections
### Response:
1.summary: Every (users/communities) and +mention (collection) is auto-hyperlinked
description: Every time a user another user or a community, or +mentions a collection, it should be auto-hyperlinked to the relevant user/community/collection.
|
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: XMLRPC to be or not to be
description: . Current situation: There are a good list of xmlrpc related issues| in the tracker (35 at the time of writing this). PHP 8.0 has moved the xmlrpc extension out| from core, now available @ PECL (in "beta" status right now - RC2). We use XMLRPC in various places: Mnet: Both inter-server communication and authentication plugin. Webservices: As a supported protocol on its own. Portfolio (mahara). Exceptions here and there because we are using (incorrectly) stuff within webservice/xmlrpc plugin from other parts of Moodle. (See for example). ... . Possible paths (non unique, use by use): We continue using XMLRPC PECL one or PHP-only alternative 3rd party lib. We stop using XMLRPC Removing features or Changing features to another WS protocol. In any case, this requires to be analysed, use by use, and come with a clear outcome (can imagine this becoming an epic) for each. But current situation is really bad (all the points exposed), and we should aim to change that. Moodle 4.0 could be a good moment to break this nut! Ciao :-)
| Unsolvable | 1.summary: Warn where XMLRPC is currently in use
description: XMLRPC is in an unsupportable state and we will need to warn users of its impending doom. We can do so in a selection of places: admin/environment.xml Warn if xmlrpc webservice protocol is enabled Warn if any mnet features are enabled on the webservice protocols page on the various MNet configuration pages
2.summary: Remove webservice_xmlrpc from core
description: This is about to completely: (/) Remove webservice_xmlrpc from core (this exact issue). (/) Create a repository @ moodlehq with current version (for 4.1 and up). Keeping history (howto guide| But using this command to only extract master history, without tags and renaming to main: code git filter-repo --subdirectory webservice/xmlrpc --refs master && git branch -m master main code (/) Add own environment.xml file to require the xmlrpc extension. (/) Add basic license (gpl-3) and readme information. (/) Bump version, add release (1.0) and requires 4.1. (WiP) Perform some exploratory testing with the protocol installed as plugin. (/) Add it to the plugins database. (link| Look in docs to add information about its current status. Ensure that upgrade says it and to install it before upgrade to keep all the conf working. (/) (none found): Verify if there is any MDLQA that should be removed that is testing this ws protocol. Close any remaining xmlrpc-webservice issue in the MDL tracker, pointing there to this issue (issues list| (/) Once this is integrated, change the plugin GHA workflow to apply all the "TODOs" there (to point to upstream repo and branch).
3.summary: Review which parts of need to be reverted for 4.1
description: In a bunch of warns were added when uses of the xmlrpc extension are detected. With the replacement happening in , surely some of those warnings dont have sense anymore. Visit them and consider which ones are worth being kept.
4.summary: Remove the xmlrpc extension recommendation in environmental checks
description: With the replacement of the extension by php library happening @ and the removal of the webservice_xmlrpc, core doesnt need the xmlrpc extension anymore. - Remove the requirement from environment.xml (all supported branches) for 4.1 and up. - Remove the recommendation from composer.
5.summary: Replace xmlrpc extension in MNet by php library
description: This issue was originally , now converted in an Epic to control all the associated issues (like this, that is part of the Epic now). For more details about the evolution, please, read the information in the Epic. Basically, what we are doing here is to replace all the uses of the xmlrpc php extension by the phpxmlrpc library for all MNet functionalities (SSO, roam, mahara portfolio export).
6.summary: Considerations about webservice_xmlrpc ownership
description: As part of the epic, we are moving the webservice_xmlrpc from core to the plugins database. - Git repo: - Plugins Directory: This issue is about ownership of that plugin and how its maintained. Note that there maybe people using it out there (no matter its not the most popular WS nowadays). Decide about: - How to manage issues and prs. - CI testing @ GHA. - Team responsible to keep an eye on it... - ...
| 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: XMLRPC to be or not to be
description: . Current situation: There are a good list of xmlrpc related issues| in the tracker (35 at the time of writing this). PHP 8.0 has moved the xmlrpc extension out| from core, now available @ PECL (in "beta" status right now - RC2). We use XMLRPC in various places: Mnet: Both inter-server communication and authentication plugin. Webservices: As a supported protocol on its own. Portfolio (mahara). Exceptions here and there because we are using (incorrectly) stuff within webservice/xmlrpc plugin from other parts of Moodle. (See for example). ... . Possible paths (non unique, use by use): We continue using XMLRPC PECL one or PHP-only alternative 3rd party lib. We stop using XMLRPC Removing features or Changing features to another WS protocol. In any case, this requires to be analysed, use by use, and come with a clear outcome (can imagine this becoming an epic) for each. But current situation is really bad (all the points exposed), and we should aim to change that. Moodle 4.0 could be a good moment to break this nut! Ciao :-)
### Response:
1.summary: Warn where XMLRPC is currently in use
description: XMLRPC is in an unsupportable state and we will need to warn users of its impending doom. We can do so in a selection of places: admin/environment.xml Warn if xmlrpc webservice protocol is enabled Warn if any mnet features are enabled on the webservice protocols page on the various MNet configuration pages
2.summary: Remove webservice_xmlrpc from core
description: This is about to completely: (/) Remove webservice_xmlrpc from core (this exact issue). (/) Create a repository @ moodlehq with current version (for 4.1 and up). Keeping history (howto guide| But using this command to only extract master history, without tags and renaming to main: code git filter-repo --subdirectory webservice/xmlrpc --refs master && git branch -m master main code (/) Add own environment.xml file to require the xmlrpc extension. (/) Add basic license (gpl-3) and readme information. (/) Bump version, add release (1.0) and requires 4.1. (WiP) Perform some exploratory testing with the protocol installed as plugin. (/) Add it to the plugins database. (link| Look in docs to add information about its current status. Ensure that upgrade says it and to install it before upgrade to keep all the conf working. (/) (none found): Verify if there is any MDLQA that should be removed that is testing this ws protocol. Close any remaining xmlrpc-webservice issue in the MDL tracker, pointing there to this issue (issues list| (/) Once this is integrated, change the plugin GHA workflow to apply all the "TODOs" there (to point to upstream repo and branch).
3.summary: Review which parts of need to be reverted for 4.1
description: In a bunch of warns were added when uses of the xmlrpc extension are detected. With the replacement happening in , surely some of those warnings dont have sense anymore. Visit them and consider which ones are worth being kept.
4.summary: Remove the xmlrpc extension recommendation in environmental checks
description: With the replacement of the extension by php library happening @ and the removal of the webservice_xmlrpc, core doesnt need the xmlrpc extension anymore. - Remove the requirement from environment.xml (all supported branches) for 4.1 and up. - Remove the recommendation from composer.
5.summary: Replace xmlrpc extension in MNet by php library
description: This issue was originally , now converted in an Epic to control all the associated issues (like this, that is part of the Epic now). For more details about the evolution, please, read the information in the Epic. Basically, what we are doing here is to replace all the uses of the xmlrpc php extension by the phpxmlrpc library for all MNet functionalities (SSO, roam, mahara portfolio export).
6.summary: Considerations about webservice_xmlrpc ownership
description: As part of the epic, we are moving the webservice_xmlrpc from core to the plugins database. - Git repo: - Plugins Directory: This issue is about ownership of that plugin and how its maintained. Note that there maybe people using it out there (no matter its not the most popular WS nowadays). Decide about: - How to manage issues and prs. - CI testing @ GHA. - Team responsible to keep an eye on it... - ...
|
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 name field debugging issues
description: This epic is to catch all of the areas that now display debugging messages due to the inclusion of the alternate name fields ().
| Unsolvable | 1.summary: create a cache for retrieving users names in the fullname function.
description: The fullname function could benefit from storing users fullnames, for display around the site without having to do any processing, in a cache.
2.summary: Add an additional setting for a configurable private fullname display
description: A second option that allowed for teachers and admin to configure the students display name as it does for fullnamedisplay could be very useful.
3.summary: Code tidy up and improvement for alternate name fields.
description: As per Marinas suggestions: Add a 3rd parameter to the function get_all_user_name_fields() which specifies a prefix for the retrieved sql fields. adding a new function that does a reverse mapping, i.e. to substitute repeating pieces of code like code $allnames = get_all_user_name_fields(); foreach ($allnames as $allname) $tempname = creator . $allname; if (isset($question->$tempname)) $u->$allname = $question->$tempname; code or the same without prefix code $allnames = get_all_user_name_fields(); foreach ($allnames as $addname) $userinfo$reviewer->reviewerid->$addname = $reviewer->$addname; code
4.summary: Re-evaluate how names are displayed in moodle.
description: The introduction of the alternate name fields has highlighted how some of the pages display names. We think that there should be more consistency through out moodle. The following are some of the areas that should be considered: Places where name is not displayed accordingly to fullnamedisplay - You are logged in as ... - Breadcrumb -- Home My courses Miscellaneous Arkadia Participants Eric Cartman View profile -- Home Users Eric Cartman View profile -- Home Users Eric Cartman Courses Arkadia Activity reports Todays logs Activity reports Todays logs -- Home Profile settings for Eric Cartman Activity reports Grade - Navigation block under: -- Current course > Course name > Participants > Firstname Lastname -- Users > Firstname Lastname - Administration block: Profile settings for Eric Cartman - Recent activity block: "New forum posts: Admin User ..." - Blog post: by Admin User - Wednesday, 10 July 2013, 2:24 PM - In Home My profile settings Roles This users role assignments: Admin Users role assignments - In Home Site administration Users Accounts Browse list of users - In Home Site administration Users Accounts Bulk user actions Forum - Name on listing of topics (Started by column). (Home My courses Miscellaneous Arkadia General News forum) - In a topic itself: by Admin User - Wednesday, 10 July 2013, 2:42 PM - In a topic itself (after searching) Glossary - Browse by author Lesson - Reports > Overview Wiki - Comments on a Wiki page
5.summary: Additional names section not needed on the edit profile page
description: If additional names are filled in on the edit profile page, they are not displayed anywhere (not even on the profile page). Thus, it seems pointless to have an additional names section with fields. Additional name fields are included in the general section on the edit profile page if specified in the "Full name format" setting. This is surely enough, and so I suggest that the additional names section is removed.
6.summary: Update externallib webservice functions to return additional name fields.
description: core_enrol_get_enrolled_users and core_enrol_get_enrolled_users_with_capability only return first name, last name and fullname. It would be useful if these webservices returned the additional fields as well.
| 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 name field debugging issues
description: This epic is to catch all of the areas that now display debugging messages due to the inclusion of the alternate name fields ().
### Response:
1.summary: create a cache for retrieving users names in the fullname function.
description: The fullname function could benefit from storing users fullnames, for display around the site without having to do any processing, in a cache.
2.summary: Add an additional setting for a configurable private fullname display
description: A second option that allowed for teachers and admin to configure the students display name as it does for fullnamedisplay could be very useful.
3.summary: Code tidy up and improvement for alternate name fields.
description: As per Marinas suggestions: Add a 3rd parameter to the function get_all_user_name_fields() which specifies a prefix for the retrieved sql fields. adding a new function that does a reverse mapping, i.e. to substitute repeating pieces of code like code $allnames = get_all_user_name_fields(); foreach ($allnames as $allname) $tempname = creator . $allname; if (isset($question->$tempname)) $u->$allname = $question->$tempname; code or the same without prefix code $allnames = get_all_user_name_fields(); foreach ($allnames as $addname) $userinfo$reviewer->reviewerid->$addname = $reviewer->$addname; code
4.summary: Re-evaluate how names are displayed in moodle.
description: The introduction of the alternate name fields has highlighted how some of the pages display names. We think that there should be more consistency through out moodle. The following are some of the areas that should be considered: Places where name is not displayed accordingly to fullnamedisplay - You are logged in as ... - Breadcrumb -- Home My courses Miscellaneous Arkadia Participants Eric Cartman View profile -- Home Users Eric Cartman View profile -- Home Users Eric Cartman Courses Arkadia Activity reports Todays logs Activity reports Todays logs -- Home Profile settings for Eric Cartman Activity reports Grade - Navigation block under: -- Current course > Course name > Participants > Firstname Lastname -- Users > Firstname Lastname - Administration block: Profile settings for Eric Cartman - Recent activity block: "New forum posts: Admin User ..." - Blog post: by Admin User - Wednesday, 10 July 2013, 2:24 PM - In Home My profile settings Roles This users role assignments: Admin Users role assignments - In Home Site administration Users Accounts Browse list of users - In Home Site administration Users Accounts Bulk user actions Forum - Name on listing of topics (Started by column). (Home My courses Miscellaneous Arkadia General News forum) - In a topic itself: by Admin User - Wednesday, 10 July 2013, 2:42 PM - In a topic itself (after searching) Glossary - Browse by author Lesson - Reports > Overview Wiki - Comments on a Wiki page
5.summary: Additional names section not needed on the edit profile page
description: If additional names are filled in on the edit profile page, they are not displayed anywhere (not even on the profile page). Thus, it seems pointless to have an additional names section with fields. Additional name fields are included in the general section on the edit profile page if specified in the "Full name format" setting. This is surely enough, and so I suggest that the additional names section is removed.
6.summary: Update externallib webservice functions to return additional name fields.
description: core_enrol_get_enrolled_users and core_enrol_get_enrolled_users_with_capability only return first name, last name and fullname. It would be useful if these webservices returned the additional fields as well.
|
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: Replace the first page a user sees when logging in
description: For (alpha) testing, we had a home page which included some explanatory text. For the beta, we need a home page for users that includes: User inbox of activities Featured Communities Featured Collections
| Solvable | 1.summary: Add user inbox to home page
description: Users should be able to see their inbox timeline (e.g. a collection was added to a community theyre following) on the home page
2.summary: Add featured communities to user home page
description: Featured communities should be removed from the sidebar and added to the users home page.
3.summary: List of featured collections for v0.9
description: Heres a list of featured collections for v0.9. Note that these are just pre-federation placeholders to demonstrate functionality. Affinity Spaces: an introduction - Badge basics - Teaching with Europeana blog - Great education-related books - Assessment - Videos de Matem tica - Videos de ABP - Educators guides to 3D printing - Concepts for beginners - Project Gutenberg - We should show the following in the preview for the featured collection: Name of parent community Title Image Description Number of resources / followers / discussions Follow button !collection-preview.png|width=499,height=74! So we can re-use the existing collection preview, we just need to add the name of parent community.
4.summary: Add featured collections to user home page
description: Featured collections are currently accessible from the sidebar. They should be moved to the user home page.
5.summary: Update featured communities and collections for v0.9.2
description: Until we have algorithmic featured communities and collections, lets update them with each release. We should keep links to The Lounge and El Sal n, though. For v0.9.2 I suggest the following: Featured communities The Lounge: El Sal n: Teaching Mathematics online: Gamification: Moodle in Africa: Moodle in business / workplace: Community Building: Featured collections Journals and articles: mootieuk19: Berlin Documents: Hindi Text Simplification: Methods of evaluation: Learning about blockchain: Snap:
6.summary: Update featured communities and collections for v0.9.4
description: Featured communities: Featured collections:
| 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: Replace the first page a user sees when logging in
description: For (alpha) testing, we had a home page which included some explanatory text. For the beta, we need a home page for users that includes: User inbox of activities Featured Communities Featured Collections
### Response:
1.summary: Add user inbox to home page
description: Users should be able to see their inbox timeline (e.g. a collection was added to a community theyre following) on the home page
2.summary: Add featured communities to user home page
description: Featured communities should be removed from the sidebar and added to the users home page.
3.summary: List of featured collections for v0.9
description: Heres a list of featured collections for v0.9. Note that these are just pre-federation placeholders to demonstrate functionality. Affinity Spaces: an introduction - Badge basics - Teaching with Europeana blog - Great education-related books - Assessment - Videos de Matem tica - Videos de ABP - Educators guides to 3D printing - Concepts for beginners - Project Gutenberg - We should show the following in the preview for the featured collection: Name of parent community Title Image Description Number of resources / followers / discussions Follow button !collection-preview.png|width=499,height=74! So we can re-use the existing collection preview, we just need to add the name of parent community.
4.summary: Add featured collections to user home page
description: Featured collections are currently accessible from the sidebar. They should be moved to the user home page.
5.summary: Update featured communities and collections for v0.9.2
description: Until we have algorithmic featured communities and collections, lets update them with each release. We should keep links to The Lounge and El Sal n, though. For v0.9.2 I suggest the following: Featured communities The Lounge: El Sal n: Teaching Mathematics online: Gamification: Moodle in Africa: Moodle in business / workplace: Community Building: Featured collections Journals and articles: mootieuk19: Berlin Documents: Hindi Text Simplification: Methods of evaluation: Learning about blockchain: Snap:
6.summary: Update featured communities and collections for v0.9.4
description: Featured communities: Featured collections:
|
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 4.0 upgrade
description:
| Unsolvable | 1.summary: Upgrade moodle.org to 4.0
description: As well as upgrading the site, lets switch to using a custom Boost theme.
2.summary: Upgrade learn.moodle.org to 4.0
description:
3.summary: Upgrade school.moodledemo.net to 4.0
description:
4.summary: Upgrade sandbox.moodledemo.net to 4.0
description:
5.summary: Upgrade archive.moodle.net to 4.0
description:
6.summary: Upgrade stats.moodle.org to 4.0
description:
7.summary: Upgrade lang.moodle.org to 4.0
description:
8.summary: Upgrade moodleassociation.org to 4.0
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 4.0 upgrade
description:
### Response:
1.summary: Upgrade moodle.org to 4.0
description: As well as upgrading the site, lets switch to using a custom Boost theme.
2.summary: Upgrade learn.moodle.org to 4.0
description:
3.summary: Upgrade school.moodledemo.net to 4.0
description:
4.summary: Upgrade sandbox.moodledemo.net to 4.0
description:
5.summary: Upgrade archive.moodle.net to 4.0
description:
6.summary: Upgrade stats.moodle.org to 4.0
description:
7.summary: Upgrade lang.moodle.org to 4.0
description:
8.summary: Upgrade moodleassociation.org to 4.0
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: MoodleNet
summary: Do educators want to share content from their Moodle courses on MoodleNet, and/or import MoodleNet collections into Moodle Core?
description: Users can link their MoodleNet and Moodle Core credentials to import collections of resources
| Unsolvable | 1.summary: Record screencast of core integration prototype
description: .
2.summary: Outline plans for Moodle core integration (sharing Moodle course resources to MoodleNet, and searching/importing MoodleNet resource)
description: Mayel has drafted an updated outline at
3.summary: Investigate Moodle development school
description: Sander shared this link for us to get to grips with developing a Moodle Core plugin for MoodleNet:
| 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 educators want to share content from their Moodle courses on MoodleNet, and/or import MoodleNet collections into Moodle Core?
description: Users can link their MoodleNet and Moodle Core credentials to import collections of resources
### Response:
1.summary: Record screencast of core integration prototype
description: .
2.summary: Outline plans for Moodle core integration (sharing Moodle course resources to MoodleNet, and searching/importing MoodleNet resource)
description: Mayel has drafted an updated outline at
3.summary: Investigate Moodle development school
description: Sander shared this link for us to get to grips with developing a Moodle Core plugin for MoodleNet:
|
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 Report builder reports for 4.2
description: Collect together any new report sources and/or system reports for Moodle 4.2 See previous epic for 4.1 () - we have a lot of custom reports and entities that should make conversion of some existing reports to system reports very straight forward, heres a non-exhaustive list of entities: Badges Badges (Issued badges) Blogs Cohorts Cohort members Comments Courses Course categories Course completion Course enrolment Course last access Files Groups Group members Groupings Notes Tags Tag collections Tag instances Tasks Users Those entities can also be re-used in existing custom reports to give more indepth reports to users Its important that we continue converting existing system reports, and create more report sources for custom reporting to make better use of the tool. We (Workplace team) will flesh out this epic, and issues within it, to better define requirements
| Unsolvable | 1.summary: Add more filters/conditions fields in course_completion entity (reportbuilder)
description: Hi, this tracker is created to add missing filters/conditions fields: Time enrolled Time started reaggregated In the core_course\reportbuilder\local\entities\completion entity.
2.summary: Add comments to custom blog reporting
description: Enhance the blog custom report source () by joining the comment entity (), to allow for reporting on comments on each blog post
3.summary: Add files to custom blog reporting
description: Enhance the blog custom report source () by joining the file entity (), to allow for better reporting on files attached to each blog post Note we currently have an "attachments" column within the blog entity, but its quite inflexible in the data it allows to report on
4.summary: Add course overview files to custom course reporting
description: Itll be good to re-use the file entity in the current courses report source, so that we can report on course overview files (labelled _Course image_| in course settings form, although can be configured to accept any file types) Similar to
5.summary: Convert comments page to system report
description: All the entities already exist per , converting the existing comments report (accessed via _Reports > Comments_ from site administration) to a system report should be straight forward Note we do need an API for bulk actions first () in order to implement the bulk-deletion of comments
6.summary: Create "User badges" custom report source
description: This is similar to the "Badges" source from , except it will report on "User > Badges" (inverse of the original source which is "Badge > Users") This allows for reports on all site users, with linked badges regardless of whether they have actually received any badges
7.summary: Add group visibility data to the groups entity/report source
description: Pending the outcome of , we should add new columns/filters to the groups report source from to enable reporting on proposed "Group visibility" configuration
| 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 Report builder reports for 4.2
description: Collect together any new report sources and/or system reports for Moodle 4.2 See previous epic for 4.1 () - we have a lot of custom reports and entities that should make conversion of some existing reports to system reports very straight forward, heres a non-exhaustive list of entities: Badges Badges (Issued badges) Blogs Cohorts Cohort members Comments Courses Course categories Course completion Course enrolment Course last access Files Groups Group members Groupings Notes Tags Tag collections Tag instances Tasks Users Those entities can also be re-used in existing custom reports to give more indepth reports to users Its important that we continue converting existing system reports, and create more report sources for custom reporting to make better use of the tool. We (Workplace team) will flesh out this epic, and issues within it, to better define requirements
### Response:
1.summary: Add more filters/conditions fields in course_completion entity (reportbuilder)
description: Hi, this tracker is created to add missing filters/conditions fields: Time enrolled Time started reaggregated In the core_course\reportbuilder\local\entities\completion entity.
2.summary: Add comments to custom blog reporting
description: Enhance the blog custom report source () by joining the comment entity (), to allow for reporting on comments on each blog post
3.summary: Add files to custom blog reporting
description: Enhance the blog custom report source () by joining the file entity (), to allow for better reporting on files attached to each blog post Note we currently have an "attachments" column within the blog entity, but its quite inflexible in the data it allows to report on
4.summary: Add course overview files to custom course reporting
description: Itll be good to re-use the file entity in the current courses report source, so that we can report on course overview files (labelled _Course image_| in course settings form, although can be configured to accept any file types) Similar to
5.summary: Convert comments page to system report
description: All the entities already exist per , converting the existing comments report (accessed via _Reports > Comments_ from site administration) to a system report should be straight forward Note we do need an API for bulk actions first () in order to implement the bulk-deletion of comments
6.summary: Create "User badges" custom report source
description: This is similar to the "Badges" source from , except it will report on "User > Badges" (inverse of the original source which is "Badge > Users") This allows for reports on all site users, with linked badges regardless of whether they have actually received any badges
7.summary: Add group visibility data to the groups entity/report source
description: Pending the outcome of , we should add new columns/filters to the groups report source from to enable reporting on proposed "Group visibility" configuration
|
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: Publish Moodle Mobile as a web app accessible online
description: The REST web services service for Moodle 3.0 support CORS, this means that we can publish Moodle Mobile as a web app so users can use it as a online web app. In this Epic there are listed all the tasks to be done to make the app work in web
| Solvable | 1.summary: Upload the latest Moodle Mobile site to a prototype test site
description: We need first test if it works overall
2.summary: Fix the split view for Firefox
description: In the webapp version the splitview does not work for Firefox (IE should be checked too)
| 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: Publish Moodle Mobile as a web app accessible online
description: The REST web services service for Moodle 3.0 support CORS, this means that we can publish Moodle Mobile as a web app so users can use it as a online web app. In this Epic there are listed all the tasks to be done to make the app work in web
### Response:
1.summary: Upload the latest Moodle Mobile site to a prototype test site
description: We need first test if it works overall
2.summary: Fix the split view for Firefox
description: In the webapp version the splitview does not work for Firefox (IE should be checked too)
|
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: Allow users to crop/rotate images in atto
description: Moving this functionality from as it is trickier than anticipated.
| Solvable | 1.summary: Atto: Allow users to crop images in atto
description: Being able to crop images from within the editor.
2.summary: Atto: Allow users to rotate images in atto
description: Being able to rotate images in atto.
3.summary: Add htmlpurifier validate transform css rules
description: At the moment, css transform rules in the style attribute is gotten rid of when going through htmlpurifier. An extension _HTMLPurifier\_AttrDef_ class to handle css transform rules must be made.
4.summary: Ensure weblib.php does not filter out transform, position, left, top, right, and bottom css rules
description: Suppose we have the following markup: code code Save that markup via atto. If you have that markup and save it in your editor, the markup will not go through htmlpurifier and thus will be the same in database. But once it is loaded from db, it will go through htmlpurifier and what is left in the styles attribute is width/height, as these are the default in htmlpurifier. To solve this integrate and use those new rules to be able to validate and keep _transform_ css rules. For the rest do this in your purify_html function in weblib.php: code $cssdefinition = $config->getCSSDefinition(); $cssDefinition->infoposition = new HTMLPurifier_AttrDef_Enum( array( absolute, fixed, relative, static, inherit ), false ); $cssdefinition->infoleft = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->infotop = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->inforight = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->infobottom = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); code . Why these style rules? These style rules are needed by
5.summary: Atto: Allow image to be moved
description: Due to the image wrapping introduce by image resizing feature, moving is now not as straightforward. Moving the image must also move parent. To avoid disaster in which image is moved but the wrapper is left behind, image moving disabled all the time at the moment.
6.summary: Atto: Allow editor to reset to original state prior to editing.
description: Allow the editor to reset the image to its original state prior to image editing.
| 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: Allow users to crop/rotate images in atto
description: Moving this functionality from as it is trickier than anticipated.
### Response:
1.summary: Atto: Allow users to crop images in atto
description: Being able to crop images from within the editor.
2.summary: Atto: Allow users to rotate images in atto
description: Being able to rotate images in atto.
3.summary: Add htmlpurifier validate transform css rules
description: At the moment, css transform rules in the style attribute is gotten rid of when going through htmlpurifier. An extension _HTMLPurifier\_AttrDef_ class to handle css transform rules must be made.
4.summary: Ensure weblib.php does not filter out transform, position, left, top, right, and bottom css rules
description: Suppose we have the following markup: code code Save that markup via atto. If you have that markup and save it in your editor, the markup will not go through htmlpurifier and thus will be the same in database. But once it is loaded from db, it will go through htmlpurifier and what is left in the styles attribute is width/height, as these are the default in htmlpurifier. To solve this integrate and use those new rules to be able to validate and keep _transform_ css rules. For the rest do this in your purify_html function in weblib.php: code $cssdefinition = $config->getCSSDefinition(); $cssDefinition->infoposition = new HTMLPurifier_AttrDef_Enum( array( absolute, fixed, relative, static, inherit ), false ); $cssdefinition->infoleft = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->infotop = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->inforight = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); $cssdefinition->infobottom = new HTMLPurifier_AttrDef_CSS_Composite(array( new HTMLPurifier_AttrDef_CSS_Length() )); code . Why these style rules? These style rules are needed by
5.summary: Atto: Allow image to be moved
description: Due to the image wrapping introduce by image resizing feature, moving is now not as straightforward. Moving the image must also move parent. To avoid disaster in which image is moved but the wrapper is left behind, image moving disabled all the time at the moment.
6.summary: Atto: Allow editor to reset to original state prior to editing.
description: Allow the editor to reset the image to its original state prior to image editing.
|
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: Explore remote setup of external tool provider in Moodle
description: A discovery epic where the goal is to see whats possible via exploration. We d like to confirm: Which plugins in core support remote set up by a teacher (i.e. settings can be changed) when served via LTI. Assignment supports this but we need to confirm others. LTI 1.3 provider support - estimate this. How can a Moodle site set up an activity on the fly which is an LTI provider? What s required? Need to create an instance of the plugin in a course. This requires some information we don t have. Can we ask plugins for the list of fields they require? Using create_instance($stdClass) Sensible defaults? What do we need for this to be served via LTI? Need an enrolment method for each specific activity How much of the enrolment information in the enrolment method do we need to be able to set? E.g. start and end dates, etc Do we need to consider roles or is teacher/student enough? Defaults for grade sync, etc Can I control access to the remote activity via the client alone? How are we going to return the information like secret, etc which allows access to the tool (Assuming LTI1.1)? What information does the client need? Does the client need to automatically create the LTI instance which is configured to connect to the remote? Can the user create this? Extension to LTI? Another tool? How does the teacher on the client site configure the remote tool. I.e. How do they access the settings page of the remote tool to set up grades, etc. Right now, the teacher can access the entire remote site, but this is really ugly. Does LTI provide any means to return this config URL somehow? Can we lock down the provider site for teachers? Right now, it seems they get the entire remote site in an iframe. What would be the ideal situation? Can we use another role instead of teacher to block other changes to the remote site?
| Unsolvable | 1.summary: Investigate which core activities can be served via LTI whilst allowing remote setup as a teacher
description: Assignment does this by granting full site access via iframe, so a consumer sites teacher can fully configure the activity via its settings cog. We need to check all the other core activity types to confirm they behave the same way.
2.summary: Learn about client configuration challenges by creating a simple activity creation proof of concept in LTI 1.1
description: The goal here is to learn what might be required on the client (consumer) side in order to trigger the provisioning and consumption of a remotely provided activity. This issue focuses on the client/consumer side of the consumer/provider relationship, whereas deals with the server/provider side. At the end of this task, we should be able to crudely create and consume a remote activity via a consumer-designated site. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. We can learn about this by first exploring the workflow a teacher must currently use to consume a remotely provided activity, identifying problem areas and areas we might be able to improve. How does this process change when the teacher also wants to create the remote tool as part of the process? These are just some things wed like to explore in a little depth and to gain answers to: Does the client need to actively create the External tool instance? Can this be programmatically created? Currently, this is always how a client/consumer sets up their tool. If were asking the remote site to create an activity by type (e.g. Create a student quiz instance for me to use), then asking the teacher to set up an external tool might be a step we dont want/need. How will the teacher configure the activity once it has been created on the provider site? Also see which investigates settings cog access of activities provided via an LTI provider - that task does not need to be researched here. Does LTI provide any means to return something like a configuration link/url, which might allow us to get access to the settings page like this? What do the above questions mean in terms of a workflow to set up a remote activity like this? What work would be required to streamline the process and how would it help the end user experience?
3.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Activity creation
description: color:FF0000This issue deals with the activity creation problem only. Only those points marked in red. color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:FF0000How can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:FF0000Is there the possibility of creating the instance with defaults for these required fields? If so, how?color Are we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity? What does the client absolutely need to consume the provided tool? Secret, key, etc? How are we going to pass the required information back to the client, assuming creation of the provided activity was successful? What access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?
4.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Enrolment method creation
description: color:ff0000This issue deals with the enrolment method creation problem only. Only those points marked in red.color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:172b4dHow can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:172b4dIs there the possibility of creating the instance with defaults for these required fields? If so, how?color color:de350bAre we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity?color color:de350bWhat does the client absolutely need to consume the provided tool? Secret, key, etc?color How are we going to pass the required information back to the client, assuming creation of the provided activity was successful? What access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?
5.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Service considerations
description: color:ff0000This issue deals with the service considerations problem only. Only those points marked in red.color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:172b4dHow can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:172b4dIs there the possibility of creating the instance with defaults for these required fields? If so, how?color color:172b4dAre we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity?color color:172b4dWhat does the client absolutely need to consume the provided tool? Secret, key, etc?color color:de350bHow are we going to pass the required information back to the client, assuming creation of the provided activity was successful?color color:de350bWhat access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?color
| 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: Explore remote setup of external tool provider in Moodle
description: A discovery epic where the goal is to see whats possible via exploration. We d like to confirm: Which plugins in core support remote set up by a teacher (i.e. settings can be changed) when served via LTI. Assignment supports this but we need to confirm others. LTI 1.3 provider support - estimate this. How can a Moodle site set up an activity on the fly which is an LTI provider? What s required? Need to create an instance of the plugin in a course. This requires some information we don t have. Can we ask plugins for the list of fields they require? Using create_instance($stdClass) Sensible defaults? What do we need for this to be served via LTI? Need an enrolment method for each specific activity How much of the enrolment information in the enrolment method do we need to be able to set? E.g. start and end dates, etc Do we need to consider roles or is teacher/student enough? Defaults for grade sync, etc Can I control access to the remote activity via the client alone? How are we going to return the information like secret, etc which allows access to the tool (Assuming LTI1.1)? What information does the client need? Does the client need to automatically create the LTI instance which is configured to connect to the remote? Can the user create this? Extension to LTI? Another tool? How does the teacher on the client site configure the remote tool. I.e. How do they access the settings page of the remote tool to set up grades, etc. Right now, the teacher can access the entire remote site, but this is really ugly. Does LTI provide any means to return this config URL somehow? Can we lock down the provider site for teachers? Right now, it seems they get the entire remote site in an iframe. What would be the ideal situation? Can we use another role instead of teacher to block other changes to the remote site?
### Response:
1.summary: Investigate which core activities can be served via LTI whilst allowing remote setup as a teacher
description: Assignment does this by granting full site access via iframe, so a consumer sites teacher can fully configure the activity via its settings cog. We need to check all the other core activity types to confirm they behave the same way.
2.summary: Learn about client configuration challenges by creating a simple activity creation proof of concept in LTI 1.1
description: The goal here is to learn what might be required on the client (consumer) side in order to trigger the provisioning and consumption of a remotely provided activity. This issue focuses on the client/consumer side of the consumer/provider relationship, whereas deals with the server/provider side. At the end of this task, we should be able to crudely create and consume a remote activity via a consumer-designated site. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. We can learn about this by first exploring the workflow a teacher must currently use to consume a remotely provided activity, identifying problem areas and areas we might be able to improve. How does this process change when the teacher also wants to create the remote tool as part of the process? These are just some things wed like to explore in a little depth and to gain answers to: Does the client need to actively create the External tool instance? Can this be programmatically created? Currently, this is always how a client/consumer sets up their tool. If were asking the remote site to create an activity by type (e.g. Create a student quiz instance for me to use), then asking the teacher to set up an external tool might be a step we dont want/need. How will the teacher configure the activity once it has been created on the provider site? Also see which investigates settings cog access of activities provided via an LTI provider - that task does not need to be researched here. Does LTI provide any means to return something like a configuration link/url, which might allow us to get access to the settings page like this? What do the above questions mean in terms of a workflow to set up a remote activity like this? What work would be required to streamline the process and how would it help the end user experience?
3.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Activity creation
description: color:FF0000This issue deals with the activity creation problem only. Only those points marked in red. color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:FF0000How can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:FF0000Is there the possibility of creating the instance with defaults for these required fields? If so, how?color Are we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity? What does the client absolutely need to consume the provided tool? Secret, key, etc? How are we going to pass the required information back to the client, assuming creation of the provided activity was successful? What access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?
4.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Enrolment method creation
description: color:ff0000This issue deals with the enrolment method creation problem only. Only those points marked in red.color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:172b4dHow can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:172b4dIs there the possibility of creating the instance with defaults for these required fields? If so, how?color color:de350bAre we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity?color color:de350bWhat does the client absolutely need to consume the provided tool? Secret, key, etc?color How are we going to pass the required information back to the client, assuming creation of the provided activity was successful? What access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?
5.summary: Learn about remote configuration challenges by creating a simple, remote setup proof of concept using LTI 1.1: Service considerations
description: color:ff0000This issue deals with the service considerations problem only. Only those points marked in red.color We want to discover as must as we can about whats involved in programmatically setting up an activity, in a course, as an LTI provider, so that a consuming site may use this. The way this normally works when Moodle is acting as a provider (assuming human setup) is as follows: Admin enables LTI enrolment method Teacher creates an activity Teacher creates an LTI enrol enrolment instance, selecting the activity (there are several options when doing this, via the enrolment instance form) Programmatically creating this raises an array of questions, but wed like to attempt to do this in order to learn more about what might/might not be problematic. At the end of this task, we should be able to make a web request to create an instance of an activity and make that activity available via LTI enrolment, as a provider. We want to document all limitations, assumptions, etc that we face along the way. This will be critical in identifying viability of LTI for such a task. These are just some of the things well want to experiment with and document the answers to. There will surely be other facts learned along the way too, which should also be documented clearly. color:172b4dHow can we create an activity without knowing which fields are required by the activity (i.e. what fields would be mandatory if manually creating the instance)?color color:172b4dIs there the possibility of creating the instance with defaults for these required fields? If so, how?color color:172b4dAre we going to be able to support configuration of any of the enrolment method specific settings? These are things which normally be set up on the enrolment method, by the teacher setting up the method. Can we use sensible defaults here? If so, what does that mean for clients consuming the provided activity?color color:172b4dWhat does the client absolutely need to consume the provided tool? Secret, key, etc?color color:de350bHow are we going to pass the required information back to the client, assuming creation of the provided activity was successful?color color:de350bWhat access/permissions problems can we foresee? E.g. if a teacher in "Consumer Site" wants to create a provider activity in "Provider Site", how are they authenticating? Will they have an account in the provider site? Do they need any new capabilities to remotely create activities as providers like this?color
|
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 new "Natural weighting" interface
description: This feature is an improved way of setting and displaying weights for grades in a category. It is described in detail in the specification: This aggregation method will be able to combine many of the current aggregation methods into one. If that is so then we can potentially remove quite a lot of code from the gradebook, improving speed and readability. However, to be safe, we plan to implement this in stages: STAGE 1) Implement natural weighting as part of the Sum of Grades aggregation type, with admin settings that allow them to disable all other aggregations if they choose. (Moodle 2.8) STAGE 2) Once people have been using this for a while, explore the possibility of removing other aggregation code or making them into optional plugins. (Moodle 3.0 perhaps)
| Unsolvable | 1.summary: Add extra credit, drop-low/ keep-high, accurate weights and contribution column to User report
description: calculate up each container s (category or course items) adjusted weight percentage and grademax associated with the items adjusted (need this for weighting, so could be done here or after the next step) calculate points (must be first, you cannot calculate weights until you have the finalgrade and grademax for categories). For each gtree->levels starting with highest (items) to lowest (course) for both finalgrade and grademax include hidden only if hidetotalsifcontainhiddenitems is set to GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN ignore ungraded items if aggregateonlygraded is set, does not apply when calculating total points for Setup (Categories and items) screen include extra credit items in finalgrade calculations only, not grademax ignore items that have been dropped from drop low or keep high accumulate all other finalgrades and grademaxes into parent category finalgrade and grademaxes calculate weights (must be done before calculating contributions). For each gtree->levels starting with highest (items) to lowest (course) weight is always percentage grade weight... in this case PERCENTAGE:item grademax / (container grademax - adjusted grademax for the container from step 1) WEIGHT:(100 - adjusted weight for the container from step 1) Adjust weights in a container to always equal 100 calculate contributions (needed in order to accurately drop lowest, keep highest. Also needed to provide the most percentages). For each gtree->levels starting with highest (items) to lowest (course) contribution is always the item s percentage the item s weight the container s weight so (finalgrade / grademax) item weight container weight limit categories - drop lowest, keep highest (need to have contributions in order to accurately drop low and keep high) remove contribs remove finalgrades from parent finalgrade remove maxgrade from parent maxgrade
2.summary: Implement Natural aggregation
description: Include upgrade code to add new database columns May involve fixing some existing unit and behat tests. -Must have no errors or warnings in code checker-
3.summary: Add behat tests
description: Base these on the "Calculation examples" section in the spec| These should be written very early to prove the state of the code. Also the items under "Logic changes" should be covered| In particular "Sum of Grades aggregation must be fixed to exclude hidden items and to exclude non-graded items" and "Determination of range (in Grader and User report) and Max grade (in Setup screen) must be fixed to exclude extra credit items". Write new behat tests for the new UI.
4.summary: Get prototype onto prototype.moodle.net, promote and request feedback
description: Once the UMN prototype has been checked and possibly modified to meet Moodle coding standards, the prototype should be shared publicly, with an opportunity for feedback.
5.summary: Make Natural aggregation the (single) default aggregation method
description: Currently there are a number of aggregation methods. The new "Natural" aggregation method can cover most of the functionality of all existing aggregation methods. On new installs, this should be set as the default aggregation method. It is also possible to hide the other aggregation methods by setting it as the single selected aggregation method at the site level. Settings for both are defined at Site admin > Grades > Grade category settings. If there is only one aggregation method available, then aggregation controls should be hidden in the gradebook setup pages and wherever aggregations are named.
6.summary: Screen reader review & tweaking
description: Review usability on screen readers, then modify interface to make it intuitive to use. Ideally we would be improving our accessibility here or at least not going backwards.
7.summary: Add QA Tests
description: Add manual QA tests for anything that could not be created as a behat test in
8.summary: Ensure changes to categories and effects on grade items are recorded in Grade history
description: Changes made to and within categories in the Setup page should be recorded in the Grade history. These include changes to aggregation method, weight, max grade and other category settings. Where these changes affect grade items (through recalculation) these changes should also be recorded and shown in the Grade history report.
9.summary: Remove setting aggregateincludingsubcategories
description: This feature is 100 incompatible with natural weighting. This was never mentioned in the spec - it was assumed. Note - it can break things when set on a parent grade category if any of the sub categories is natural.
10.summary: Improve navigation menu in grader reports
description: List of things that were discussed: Move settings section to be 2nd under view Make nav tree order match the order in the drop down menu Move preferences into the "settings" section
| 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 new "Natural weighting" interface
description: This feature is an improved way of setting and displaying weights for grades in a category. It is described in detail in the specification: This aggregation method will be able to combine many of the current aggregation methods into one. If that is so then we can potentially remove quite a lot of code from the gradebook, improving speed and readability. However, to be safe, we plan to implement this in stages: STAGE 1) Implement natural weighting as part of the Sum of Grades aggregation type, with admin settings that allow them to disable all other aggregations if they choose. (Moodle 2.8) STAGE 2) Once people have been using this for a while, explore the possibility of removing other aggregation code or making them into optional plugins. (Moodle 3.0 perhaps)
### Response:
1.summary: Add extra credit, drop-low/ keep-high, accurate weights and contribution column to User report
description: calculate up each container s (category or course items) adjusted weight percentage and grademax associated with the items adjusted (need this for weighting, so could be done here or after the next step) calculate points (must be first, you cannot calculate weights until you have the finalgrade and grademax for categories). For each gtree->levels starting with highest (items) to lowest (course) for both finalgrade and grademax include hidden only if hidetotalsifcontainhiddenitems is set to GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN ignore ungraded items if aggregateonlygraded is set, does not apply when calculating total points for Setup (Categories and items) screen include extra credit items in finalgrade calculations only, not grademax ignore items that have been dropped from drop low or keep high accumulate all other finalgrades and grademaxes into parent category finalgrade and grademaxes calculate weights (must be done before calculating contributions). For each gtree->levels starting with highest (items) to lowest (course) weight is always percentage grade weight... in this case PERCENTAGE:item grademax / (container grademax - adjusted grademax for the container from step 1) WEIGHT:(100 - adjusted weight for the container from step 1) Adjust weights in a container to always equal 100 calculate contributions (needed in order to accurately drop lowest, keep highest. Also needed to provide the most percentages). For each gtree->levels starting with highest (items) to lowest (course) contribution is always the item s percentage the item s weight the container s weight so (finalgrade / grademax) item weight container weight limit categories - drop lowest, keep highest (need to have contributions in order to accurately drop low and keep high) remove contribs remove finalgrades from parent finalgrade remove maxgrade from parent maxgrade
2.summary: Implement Natural aggregation
description: Include upgrade code to add new database columns May involve fixing some existing unit and behat tests. -Must have no errors or warnings in code checker-
3.summary: Add behat tests
description: Base these on the "Calculation examples" section in the spec| These should be written very early to prove the state of the code. Also the items under "Logic changes" should be covered| In particular "Sum of Grades aggregation must be fixed to exclude hidden items and to exclude non-graded items" and "Determination of range (in Grader and User report) and Max grade (in Setup screen) must be fixed to exclude extra credit items". Write new behat tests for the new UI.
4.summary: Get prototype onto prototype.moodle.net, promote and request feedback
description: Once the UMN prototype has been checked and possibly modified to meet Moodle coding standards, the prototype should be shared publicly, with an opportunity for feedback.
5.summary: Make Natural aggregation the (single) default aggregation method
description: Currently there are a number of aggregation methods. The new "Natural" aggregation method can cover most of the functionality of all existing aggregation methods. On new installs, this should be set as the default aggregation method. It is also possible to hide the other aggregation methods by setting it as the single selected aggregation method at the site level. Settings for both are defined at Site admin > Grades > Grade category settings. If there is only one aggregation method available, then aggregation controls should be hidden in the gradebook setup pages and wherever aggregations are named.
6.summary: Screen reader review & tweaking
description: Review usability on screen readers, then modify interface to make it intuitive to use. Ideally we would be improving our accessibility here or at least not going backwards.
7.summary: Add QA Tests
description: Add manual QA tests for anything that could not be created as a behat test in
8.summary: Ensure changes to categories and effects on grade items are recorded in Grade history
description: Changes made to and within categories in the Setup page should be recorded in the Grade history. These include changes to aggregation method, weight, max grade and other category settings. Where these changes affect grade items (through recalculation) these changes should also be recorded and shown in the Grade history report.
9.summary: Remove setting aggregateincludingsubcategories
description: This feature is 100 incompatible with natural weighting. This was never mentioned in the spec - it was assumed. Note - it can break things when set on a parent grade category if any of the sub categories is natural.
10.summary: Improve navigation menu in grader reports
description: List of things that were discussed: Move settings section to be 2nd under view Make nav tree order match the order in the drop down menu Move preferences into the "settings" section
|
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 changes in Moodle that will assist in GDPR compliance
description: The EU Data protection laws take effect on May 25th 2018 after a 2 year transition period. We need a stable Moodle release with the necessary features for sites to comply with the legislation. There could be additional reports and features in Moodle to assist with GDPR compliance. E.g. Separation of site policy and privacy policy Generation of privacy policy from template Reports on acceptance of privacy policy Reports on third party integrations Features for deletion or anonymising of user data once it is past its useful period Obtaining parent/guardian consent for minors Re-obtaining consent for changes to privacy policies Enhanced log export
| Unsolvable | 1.summary: Create documentation for GDPR compliance for Moodle Administrators
description: Create and advisory document to help Moodle Administrators learn about their GDPR roles and responsibilities.
2.summary: Create specifications for new features in Moodle that can assist with GDPR compliance
description: There could be additional reports and features in Moodle to assist with GDPR compliance. E.g. Separation of site policy and privacy policy Generation of privacy policy from template Reports on acceptance of privacy policy Reports on third party integrations Features for deletion or anonymising of user data once it is past its useful period Obtaining parent/guardian consent for minors Re-obtaining consent for changes to privacy policies Enhanced log export
3.summary: Add a function to anonymise a users data
description: If a user requests their personal data is "erased" from Moodle we need a simple way for admins to act on this request without adversely affecting other users of the site. Anonymised users should not be able to log in, but any content they have created would remain. The identifiable information in their user profile would be replaced. We may need to log at the data in log records as well.
4.summary: Add a function to export users log data
description: We need a page that allows exporting all log records either by or affecting a user in Moodle. This is probably just a tweak to the admin logs page. ||User Stories||Acceptance Criteria|| |Any user should be able to request a record of their personal data that is stored and processed by the Moodle site in order to exercise their rights under the GDPR| A Moodle administrator should be able to export all the log records where a user is the userid or relateduserid A Moodle administrator can download the records as CSV|
5.summary: LTI GDPR information
description: Considering that in Moodle any teacher can add an LTI activity to a course without going through the site administrator, it makes it impossible for the site administrator to include all 3rd party tools in its privacy policy. Nonetheless, the GDPR law doesnt require for it to be in the privacy policy, it requires that the user is informed and has the ability to consent to the data sharing before the data is shared & the ability to withdraw that consent. As such, as part of the launch of an LTI activity in Moodle there should be the ability to have a prompt which would seek the consent from the student before they are directed to the lti tool which informs them of what data is going to be shared, how its going to be processed, etc. This could be added to the LTI activity settings with a toggle to enable, and a text field to provide the information. A Site level toggle should also be implemented to enforce the use of this if the site must comply with GDPR.
| 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 changes in Moodle that will assist in GDPR compliance
description: The EU Data protection laws take effect on May 25th 2018 after a 2 year transition period. We need a stable Moodle release with the necessary features for sites to comply with the legislation. There could be additional reports and features in Moodle to assist with GDPR compliance. E.g. Separation of site policy and privacy policy Generation of privacy policy from template Reports on acceptance of privacy policy Reports on third party integrations Features for deletion or anonymising of user data once it is past its useful period Obtaining parent/guardian consent for minors Re-obtaining consent for changes to privacy policies Enhanced log export
### Response:
1.summary: Create documentation for GDPR compliance for Moodle Administrators
description: Create and advisory document to help Moodle Administrators learn about their GDPR roles and responsibilities.
2.summary: Create specifications for new features in Moodle that can assist with GDPR compliance
description: There could be additional reports and features in Moodle to assist with GDPR compliance. E.g. Separation of site policy and privacy policy Generation of privacy policy from template Reports on acceptance of privacy policy Reports on third party integrations Features for deletion or anonymising of user data once it is past its useful period Obtaining parent/guardian consent for minors Re-obtaining consent for changes to privacy policies Enhanced log export
3.summary: Add a function to anonymise a users data
description: If a user requests their personal data is "erased" from Moodle we need a simple way for admins to act on this request without adversely affecting other users of the site. Anonymised users should not be able to log in, but any content they have created would remain. The identifiable information in their user profile would be replaced. We may need to log at the data in log records as well.
4.summary: Add a function to export users log data
description: We need a page that allows exporting all log records either by or affecting a user in Moodle. This is probably just a tweak to the admin logs page. ||User Stories||Acceptance Criteria|| |Any user should be able to request a record of their personal data that is stored and processed by the Moodle site in order to exercise their rights under the GDPR| A Moodle administrator should be able to export all the log records where a user is the userid or relateduserid A Moodle administrator can download the records as CSV|
5.summary: LTI GDPR information
description: Considering that in Moodle any teacher can add an LTI activity to a course without going through the site administrator, it makes it impossible for the site administrator to include all 3rd party tools in its privacy policy. Nonetheless, the GDPR law doesnt require for it to be in the privacy policy, it requires that the user is informed and has the ability to consent to the data sharing before the data is shared & the ability to withdraw that consent. As such, as part of the launch of an LTI activity in Moodle there should be the ability to have a prompt which would seek the consent from the student before they are directed to the lti tool which informs them of what data is going to be shared, how its going to be processed, etc. This could be added to the LTI activity settings with a toggle to enable, and a text field to provide the information. A Site level toggle should also be implemented to enforce the use of this if the site must comply with GDPR.
|
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 editing improvements
description: The proposed changes are summarised in I am about to make linked issues for each one.
| Unsolvable | 1.summary: The question bank should have a Duplicate action, rather than Save as new question in the edit form
description: Add a "Copy" button to the buttom of the question list (Inside the Question Bank) that enable the question creator to duplicate a question inside the same category or a different one. (next to the "Move" button) Questions data should be duplicated and not "linked" to, to enable teachers to change the copied question(s) without changing the original question inside the Quiz that was using the original questions.
2.summary: When editing questions, a way to save changes an continue editing
description: It would be a great help to add the "save but dont close" functionality to the question authoring interface. When creating questions of complex types like STACK, it is really useful to have the question preview open in one window for testing while you edit the question in another window.
3.summary: Improve the usability of the quiz editing page
description: There are various problems with the Edit quiz page. It is not really necessary to have two separate tabs, Order and paging and Edit quiz. There have been usability improvements for course editing that we can copy (drag-and-drop to re-order, the edit menus , ...) The way the question bank fits into the page is not great. You cannot change all question max marks at once. The code that produces this page is a mess. It should be generated by a renderer. At the same time as adding the other features in this epic, we should sort out this page.
4.summary: Improved user interface for building quizzes
description: A Quiz renderer already exists. As part of updating the quiz edit interface it must use a renderer For now I have broken down the stages of development as Course View Renderer DONE Begin with the basic course view renderer. It has the basic required design and gives us semantic html with rows, drag and drop and ajax built in. Just get this working and then repurpose for the quiz. Locate in Quiz DONE With the course renderer in place as quiz edit renderer migrate the relevant underlying code and files to quiz. Use Quiz Data Make renderer display quiz data and links instead of course data and links. Edit options Update edit options for quiz Add options Update edit options for quiz
5.summary: Add Page support to quiz edit renderer
description: Allow the list of questions to be organised according to pages
6.summary: Update Quiz data layer
description: To support the extra features the data layer supporting the quiz needs to change. Tim Hunt has provided an initial plan to the community. This needs to be implemented with related php and javascript classes created/adjusted to reflect the changes. Backup and restore must also be adjusted to support the new structure.
7.summary: Update edit question options in quiz edit page
description: Match the edit question options as defined in the mockup. The course view renderer we have used as a template for the quiz edit page gives us default edit options. The mockup Mahmoud designed provides a different UI. Match this.
8.summary: Update add question options in quiz edit renderer
description: match the add question options displayed in the mockup. Previously we used the question bank and a popup to choose the question type to create. What approach will we use with the new quiz edit interface. Andrew nicholls has some ideas e.g. .
9.summary: Quiz Edit Renderer: Manage section headings
description: Display and update the quiz sections headings in the new quiz edit renderer. Update the section heading in line. Updates made via ajax. No page reload or submission required.
10.summary: Rename columns of quiz_question_instances to match coding guidelines
description: We should rename quiz -> quizid question -> questionid grade -> maxmark (see
11.summary: Use new slots data layer in edit renderer
description: The database changes introduce slots in place of the questions field in the quiz object. Slots work like rows. Each slot contains a quiz question. Sections and pages can be linked to each slot to divide the quiz up as required. Provide methods to convert the existing questions array to a slots data structure with sections. Use this new structure to build the quiz edit renderer view.
12.summary: Unpick quiz.questions DB column
description: This is transform 2 of noformat TRANSFORM 2 - eliminate mdl_quiz.questions & rename question_instances -> slots mdl_quiz id SEQUENCE ... questionsperpage INT(10) navmethod CHAR(16) free or seq shufflequestions BOOL - ... mdl_quiz_slots id SEQUENCE quizid INT(10) FK + slot INT(10) Similar to question_attempt.slot + page INT(10) All slots on a page must have consecutive numbers. Page numbers must be increasing. questionid INT(10) FK maxmark NUMBER(12.7) noformat
| 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 editing improvements
description: The proposed changes are summarised in I am about to make linked issues for each one.
### Response:
1.summary: The question bank should have a Duplicate action, rather than Save as new question in the edit form
description: Add a "Copy" button to the buttom of the question list (Inside the Question Bank) that enable the question creator to duplicate a question inside the same category or a different one. (next to the "Move" button) Questions data should be duplicated and not "linked" to, to enable teachers to change the copied question(s) without changing the original question inside the Quiz that was using the original questions.
2.summary: When editing questions, a way to save changes an continue editing
description: It would be a great help to add the "save but dont close" functionality to the question authoring interface. When creating questions of complex types like STACK, it is really useful to have the question preview open in one window for testing while you edit the question in another window.
3.summary: Improve the usability of the quiz editing page
description: There are various problems with the Edit quiz page. It is not really necessary to have two separate tabs, Order and paging and Edit quiz. There have been usability improvements for course editing that we can copy (drag-and-drop to re-order, the edit menus , ...) The way the question bank fits into the page is not great. You cannot change all question max marks at once. The code that produces this page is a mess. It should be generated by a renderer. At the same time as adding the other features in this epic, we should sort out this page.
4.summary: Improved user interface for building quizzes
description: A Quiz renderer already exists. As part of updating the quiz edit interface it must use a renderer For now I have broken down the stages of development as Course View Renderer DONE Begin with the basic course view renderer. It has the basic required design and gives us semantic html with rows, drag and drop and ajax built in. Just get this working and then repurpose for the quiz. Locate in Quiz DONE With the course renderer in place as quiz edit renderer migrate the relevant underlying code and files to quiz. Use Quiz Data Make renderer display quiz data and links instead of course data and links. Edit options Update edit options for quiz Add options Update edit options for quiz
5.summary: Add Page support to quiz edit renderer
description: Allow the list of questions to be organised according to pages
6.summary: Update Quiz data layer
description: To support the extra features the data layer supporting the quiz needs to change. Tim Hunt has provided an initial plan to the community. This needs to be implemented with related php and javascript classes created/adjusted to reflect the changes. Backup and restore must also be adjusted to support the new structure.
7.summary: Update edit question options in quiz edit page
description: Match the edit question options as defined in the mockup. The course view renderer we have used as a template for the quiz edit page gives us default edit options. The mockup Mahmoud designed provides a different UI. Match this.
8.summary: Update add question options in quiz edit renderer
description: match the add question options displayed in the mockup. Previously we used the question bank and a popup to choose the question type to create. What approach will we use with the new quiz edit interface. Andrew nicholls has some ideas e.g. .
9.summary: Quiz Edit Renderer: Manage section headings
description: Display and update the quiz sections headings in the new quiz edit renderer. Update the section heading in line. Updates made via ajax. No page reload or submission required.
10.summary: Rename columns of quiz_question_instances to match coding guidelines
description: We should rename quiz -> quizid question -> questionid grade -> maxmark (see
11.summary: Use new slots data layer in edit renderer
description: The database changes introduce slots in place of the questions field in the quiz object. Slots work like rows. Each slot contains a quiz question. Sections and pages can be linked to each slot to divide the quiz up as required. Provide methods to convert the existing questions array to a slots data structure with sections. Use this new structure to build the quiz edit renderer view.
12.summary: Unpick quiz.questions DB column
description: This is transform 2 of noformat TRANSFORM 2 - eliminate mdl_quiz.questions & rename question_instances -> slots mdl_quiz id SEQUENCE ... questionsperpage INT(10) navmethod CHAR(16) free or seq shufflequestions BOOL - ... mdl_quiz_slots id SEQUENCE quizid INT(10) FK + slot INT(10) Similar to question_attempt.slot + page INT(10) All slots on a page must have consecutive numbers. Page numbers must be increasing. questionid INT(10) FK maxmark NUMBER(12.7) noformat
|
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.1
description: In Moodle 4.1 we can remove functionality that was deprecated in 3.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. 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 admin_setting_managelicenses
description: In , admin_setting_managelicenses class in lib/adminlib.php was deprecated. More things to consider here: Final deprecation for save() method in lib/licenselib.php.
2.summary: Final deprecation of cron_run_single_task() function
description: This function was deprecated in Moodle 3.9 and just needs to follow the final stages of deprecation.
3.summary: Final deprecation of participants unified filter
description: The following final deprecations need to be performed in relation to the old participants unified filter, which was replaced by the participants filter and table filtersets in Moodle 3.9 under . JavaScript The following can be removed: user/amd/src/unified_filter.js user/amd/src/unified_filter_datasource.js Mustache user/templates/unified_filter.mustache can be removed. Renderer user/classes/output/unified_filter.php should follow final deprecation procedures as per (ie be completely removed). Renderable In user/renderer.php, the _unified_filter()_ function only should follow final deprecation procedures (eg throw an exception). Other related deprecations performed in are already covered by other general 4.3 final deprecation issues (library functions in , string in ).
4.summary: Remove behat steps deprecated in 3.9
description: Go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.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.
5.summary: Remove strings deprecated in 3.9
description: Remove strings from language files under the heading "Deprecated in Moodle 3.9" and the respective lines in deprecated.txt files See also
6.summary: Deprecation of print_error()
description: In it was agreed to deprecate print_error() and switch to throw moodle_exception() instead. This issue is about to proceed with such deprecation in core. Should cover the following aspects: - Decide the target for the deprecation (3.11 or 4.0). - Comment about the outcome @ codechecker 137( , so the deprecation warning can be created then. - Apply the standard deprecation policy (debugging, move to deprecatedlib...). - Remove all uses from core. - Create the phase2 deprecation (final removal) issue, scheduled for the standard 2 years, but with a explicit call about to re-evaluate the situation in plugins when that time arrives. If there are many plugins still using print_error() we may need to delay the removal. - Also comment about the outcome @ codechecker 137( once the final removal happens (so the function is moved from the Deprecation Sniff to the Forbidden one). Ciao :-)
| 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.1
description: In Moodle 4.1 we can remove functionality that was deprecated in 3.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. 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 admin_setting_managelicenses
description: In , admin_setting_managelicenses class in lib/adminlib.php was deprecated. More things to consider here: Final deprecation for save() method in lib/licenselib.php.
2.summary: Final deprecation of cron_run_single_task() function
description: This function was deprecated in Moodle 3.9 and just needs to follow the final stages of deprecation.
3.summary: Final deprecation of participants unified filter
description: The following final deprecations need to be performed in relation to the old participants unified filter, which was replaced by the participants filter and table filtersets in Moodle 3.9 under . JavaScript The following can be removed: user/amd/src/unified_filter.js user/amd/src/unified_filter_datasource.js Mustache user/templates/unified_filter.mustache can be removed. Renderer user/classes/output/unified_filter.php should follow final deprecation procedures as per (ie be completely removed). Renderable In user/renderer.php, the _unified_filter()_ function only should follow final deprecation procedures (eg throw an exception). Other related deprecations performed in are already covered by other general 4.3 final deprecation issues (library functions in , string in ).
4.summary: Remove behat steps deprecated in 3.9
description: Go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.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.
5.summary: Remove strings deprecated in 3.9
description: Remove strings from language files under the heading "Deprecated in Moodle 3.9" and the respective lines in deprecated.txt files See also
6.summary: Deprecation of print_error()
description: In it was agreed to deprecate print_error() and switch to throw moodle_exception() instead. This issue is about to proceed with such deprecation in core. Should cover the following aspects: - Decide the target for the deprecation (3.11 or 4.0). - Comment about the outcome @ codechecker 137( , so the deprecation warning can be created then. - Apply the standard deprecation policy (debugging, move to deprecatedlib...). - Remove all uses from core. - Create the phase2 deprecation (final removal) issue, scheduled for the standard 2 years, but with a explicit call about to re-evaluate the situation in plugins when that time arrives. If there are many plugins still using print_error() we may need to delay the removal. - Also comment about the outcome @ codechecker 137( once the final removal happens (so the function is moved from the Deprecation Sniff to the Forbidden one). Ciao :-)
|
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: Mobile issues to resolve for Moodle 3.9
description: This is a list of issues the mobile app requires in Moodle 3.9 to support new functionality in the app.
| Unsolvable | 1.summary: Enable logging into the mobile app via QR code in the web user profile
description: It would be cool to simplify the way the users can login into a Moodle site via the app using a similar approach to what WhatsApp do with WhatsApp web. Overall idea would be: - If mobile services are enabled and this feature is not disabled (well add an option), in the user profile we generate a QR code for a URL that will auto-login the user in the app (the URL will have the user token) - Using the Moodle App (or a standard QR reader if the app is installed) the user will be able to scan the QR code to log-in Security questions: - Should the QR code should be valid only for a certain time? (maybe the user left his session open in a shared computer) - Should we encode (encryption is not possible) the token/private token that will be part of the URL used to generate the QR code?
2.summary: Add a new message provider for course completed
description: This would be especially useful for people using the Moodle app (they will be able to receive Push notifications when something important happens), for example: Course completed for one user For the future, we should evaluate: New content/activity available in a course (difficult, because this is calculated in real-time for the user before generating cache, there is not a task or background process) New visible grades for the user available. This has two potential issues, duplicated notifications (some modules already generate notifications) and also maybe some teachers/site admins dont want the students to receive a notification.
3.summary: Add new "activeusers" field containing last month active users in registration data
description: Right now we are storing only the number of users enrolled in the platform, but this is not providing any interesting insight. We should also send the number of active users (users that accessed during the last 30 days to the platform)
4.summary: Enable "Mobile Notifications" when a site is registered
description: Right now, for enabling "Mobile Push Notifications" a site administrator must register first their site and then retrieve an access key via the "Mobile notification" plugins settings. As part of the registration process, we should automatically generate an access key for the site once the registration process is completed.
5.summary: New system report indicating Mobile devices used to connect via the app and Notifications
description: We need to create a new system (Site Administration) report summarins the usage of mobile devices (mobile devices used to connect to the system) and also indicates the notifications processed (Airnotifier) by month
6.summary: Update Moodle app related language strings to reflect the new restrictions and Moodle apps plans
description: An initial list of language strings that needs to be updated to reflect/indicate admins that they may be affected by site restrictions. Remote CSS Disabled features, custom menu items, custom lang strings $stringrequestaccesskey = Request access key; $stringsitemustberegistered = In order to use the public Airnotifier instance, your site must be registered with Moodle.; $stringerrorretrievingkey = An error occurred while retrieving the access key. Your site must be registered to use this service. If your site is already registered, please try updating your registration.; $stringkeyretrievedsuccessfully = Key retrieved successfully; $stringmoodleapp = Moodle app; $stringmoodleapp_help = If you have an account on a Moodle site, you can access all your courses on your mobile devices with our free mobile app for Moodle. Get the Moodle app;
7.summary: Add a new "Mobile app subscription plan" section in the Moodle app settings
description: We need to let site admins know that there are some limits/restrictions that may apply to the app (if they have enabled it). The overall idea will be the following: In the site administration section "Mobile app" among the different options we will include a new one: "Your Moodle app subscription" In this new page, plan information for the current site will be retrieved from apps.moodle.com and displayed to the site admin: Current plan Different limits/restrictions applied Warning if some Moodle features are configured but are not supported by the current plan Warning if the site reached the maximum number of allower user devices receiving notifications Detailed information about Push notifications processed in the current month (or including previous months with graphs if the plan is a paid plan like pro or premium) Links to the Moodle Apps portal for registering / purchasing a paid plan. In order to do that well need to call a new WS that will be available in the Moodle Apps Portal (apps.moodle.com) passing as parameter the following information: - The current siteurl ($CFG->wwwroot) - Moodle app ids (Android and iOS) to detect custom/branded apps - A way to authenticate/validate the request (we will send the Airnotifier Access Key, the $CFG->siteidentifier and/or registration token) so the apps portal can choose how to validate that request comes from a valid site - Once the WS request is validated, all the necessary information for printing the page will be returned. If the site is not yet registered, we will display information about how to register for a free plan at least
8.summary: Update the tool_mobile_disabledfeatures setting with H5P and new blocks supported on the app
description: We need to allow site admins to disable the new things coming in 3.9, including H5P and the new "Activity results" block that now is displayed on the app. And also, text filtering app (performance problem)
| 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: Mobile issues to resolve for Moodle 3.9
description: This is a list of issues the mobile app requires in Moodle 3.9 to support new functionality in the app.
### Response:
1.summary: Enable logging into the mobile app via QR code in the web user profile
description: It would be cool to simplify the way the users can login into a Moodle site via the app using a similar approach to what WhatsApp do with WhatsApp web. Overall idea would be: - If mobile services are enabled and this feature is not disabled (well add an option), in the user profile we generate a QR code for a URL that will auto-login the user in the app (the URL will have the user token) - Using the Moodle App (or a standard QR reader if the app is installed) the user will be able to scan the QR code to log-in Security questions: - Should the QR code should be valid only for a certain time? (maybe the user left his session open in a shared computer) - Should we encode (encryption is not possible) the token/private token that will be part of the URL used to generate the QR code?
2.summary: Add a new message provider for course completed
description: This would be especially useful for people using the Moodle app (they will be able to receive Push notifications when something important happens), for example: Course completed for one user For the future, we should evaluate: New content/activity available in a course (difficult, because this is calculated in real-time for the user before generating cache, there is not a task or background process) New visible grades for the user available. This has two potential issues, duplicated notifications (some modules already generate notifications) and also maybe some teachers/site admins dont want the students to receive a notification.
3.summary: Add new "activeusers" field containing last month active users in registration data
description: Right now we are storing only the number of users enrolled in the platform, but this is not providing any interesting insight. We should also send the number of active users (users that accessed during the last 30 days to the platform)
4.summary: Enable "Mobile Notifications" when a site is registered
description: Right now, for enabling "Mobile Push Notifications" a site administrator must register first their site and then retrieve an access key via the "Mobile notification" plugins settings. As part of the registration process, we should automatically generate an access key for the site once the registration process is completed.
5.summary: New system report indicating Mobile devices used to connect via the app and Notifications
description: We need to create a new system (Site Administration) report summarins the usage of mobile devices (mobile devices used to connect to the system) and also indicates the notifications processed (Airnotifier) by month
6.summary: Update Moodle app related language strings to reflect the new restrictions and Moodle apps plans
description: An initial list of language strings that needs to be updated to reflect/indicate admins that they may be affected by site restrictions. Remote CSS Disabled features, custom menu items, custom lang strings $stringrequestaccesskey = Request access key; $stringsitemustberegistered = In order to use the public Airnotifier instance, your site must be registered with Moodle.; $stringerrorretrievingkey = An error occurred while retrieving the access key. Your site must be registered to use this service. If your site is already registered, please try updating your registration.; $stringkeyretrievedsuccessfully = Key retrieved successfully; $stringmoodleapp = Moodle app; $stringmoodleapp_help = If you have an account on a Moodle site, you can access all your courses on your mobile devices with our free mobile app for Moodle. Get the Moodle app;
7.summary: Add a new "Mobile app subscription plan" section in the Moodle app settings
description: We need to let site admins know that there are some limits/restrictions that may apply to the app (if they have enabled it). The overall idea will be the following: In the site administration section "Mobile app" among the different options we will include a new one: "Your Moodle app subscription" In this new page, plan information for the current site will be retrieved from apps.moodle.com and displayed to the site admin: Current plan Different limits/restrictions applied Warning if some Moodle features are configured but are not supported by the current plan Warning if the site reached the maximum number of allower user devices receiving notifications Detailed information about Push notifications processed in the current month (or including previous months with graphs if the plan is a paid plan like pro or premium) Links to the Moodle Apps portal for registering / purchasing a paid plan. In order to do that well need to call a new WS that will be available in the Moodle Apps Portal (apps.moodle.com) passing as parameter the following information: - The current siteurl ($CFG->wwwroot) - Moodle app ids (Android and iOS) to detect custom/branded apps - A way to authenticate/validate the request (we will send the Airnotifier Access Key, the $CFG->siteidentifier and/or registration token) so the apps portal can choose how to validate that request comes from a valid site - Once the WS request is validated, all the necessary information for printing the page will be returned. If the site is not yet registered, we will display information about how to register for a free plan at least
8.summary: Update the tool_mobile_disabledfeatures setting with H5P and new blocks supported on the app
description: We need to allow site admins to disable the new things coming in 3.9, including H5P and the new "Activity results" block that now is displayed on the app. And also, text filtering app (performance problem)
|
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: User Stories for Calendar Improvements
description: An epic to detail each of the User Stories for the Moodle User Association project to make improvements to the Moodle calendar.
| Unsolvable | 1.summary: As a logged in user I want to be able to quickly add a manual calendar event to my personal calendar so that I can keep track of all the things in my schedule
description: . As a logged in user I want to be able to quickly add a manual calendar event to my personal calendar so that I can keep track of all the things in my schedule Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I can only add events to my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never add events to another users personal calendar. A guest user should not see an option, or be able to add events
2.summary: As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a course calendar so I can communicate important dates to the course participants
description: . As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a course calendar so I can communicate important dates to the course participants Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a course calendar if I have the moodle/calendar:manageentries capability at the course context.
3.summary: As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a group calendar so I can communicate important dates to the members of the group
description: . As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a group calendar so I can communicate important dates to the members of the group Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
4.summary: As a user with a manager role in the front page course I should be able to quickly add a manual calendar event to a site calendar so I can communicate important dates to all users in the site
description: . As a user with a manager role in the front page course I should be able to quickly add a manual calendar event to a site calendar so I can communicate important dates to all users in the site Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
5.summary: As a user with an manager role in a course category I should be able to quickly add a manual calendar event to a category calendar so I can communicate important dates to all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly add a manual calendar event to a category calendar so I can communicate important dates to all users in all courses in the category Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a category calendar if I have the moodle/calendar:manageentries capability at the category context.
6.summary: As a logged in user I want to be able to quickly edit a manual calendar event in my personal calendar so that I can correct the things in my schedule
description: . As a logged in user I want to be able to quickly edit a manual calendar event in my personal calendar so that I can correct the things in my schedule Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I can only edit events in my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never edit events in another users personal calendar. A guest user should not see an option, or be able to edit events
7.summary: As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a course calendar so I can communicate important dates to the course participants
description: . As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a course calendar so I can communicate important dates to the course participants Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a course calendar if I have the moodle/calendar:manageentries capability at the course context.
8.summary: As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a group calendar so I can communicate important dates to the members of the group
description: . As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a group calendar so I can communicate important dates to the members of the group Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
9.summary: As a user with an manager role in the front page course I should be able to quickly edit a manual calendar event in a site calendar so I can communicate important dates to all users in the site
description: . As a user with an manager role in the front page course I should be able to quickly edit a manual calendar event in a site calendar so I can communicate important dates to all users in the site Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
10.summary: As a user with an manager role in a course category I should be able to quickly edit a manual calendar event in a category calendar so I can communicate important dates to all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly edit a manual calendar event in a category calendar so I can communicate important dates to all users in all courses in the category Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a category calendar if I have the moodle/calendar:manageentries capability at the category context.
11.summary: As a logged in user I want to be able to quickly delete a manual calendar event from my personal calendar so that I can correct the things in my schedule
description: . As a logged in user I want to be able to quickly delete a manual calendar event from my personal calendar so that I can correct the things in my schedule Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I can only delete events from my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never delete events in another users personal calendar. A guest user should not see an option, or be able to delete events
12.summary: As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a course calendar so I can correct important dates for the course participants
description: . As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a course calendar so I can correct important dates for the course participants Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a course calendar if I have the moodle/calendar:manageentries capability at the course context.
13.summary: As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a group calendar so I can correct important dates for the members of the group
description: . As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a group calendar so I can correct important dates for the members of the group Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
14.summary: As a user with an manager role in the front page course I should be able to quickly delete a manual calendar event from a site calendar so I can correct important dates for all users in the site
description: . As a user with an manager role in the front page course I should be able to quickly delete a manual calendar event from a site calendar so I can correct important dates for all users in the site Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
15.summary: As a user with an manager role in a course category I should be able to quickly delete a manual calendar event from a category calendar so I can correct important dates for all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly delete a manual calendar event from a category calendar so I can correct important dates for all users in all courses in the category Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a category calendar if I have the moodle/calendar:manageentries capability at the category context.
16.summary: As a user with access to lots of calendars I should be able to quickly and easily specify the calendar for new events
description: . As a user with access to lots of calendars I should be able to quickly and easily specify the calendar for new events Confirmations When creating a new event the default calendar for the new event should be The course category calendar if we are currently viewing a course category calendar The course calendar we are currently viewing a course calendar. My personal calendar I should be able to quickly find and select any other calendar I can create events in by searching.
17.summary: As a logged in user I want to change the date of a calendar event by dragging and dropping it to a different date in order to speed up my workflow
description: . As a logged in user I want to change the date of a calendar event by dragging and dropping it to a different date in order to speed up my workflow Confirmations If I can see a manual calendar event I can edit in the main calendar view, I should be able to click and drag it to a different date in the main calendar view. When I drop it on that date, the date of the event will change and the calendar will reflect the new date. If I drag a manual calendar event to the links for navigating to the next/previous month in the calendar view and hover for a short time (1 second) - the calendar should navigate to the next month and the drag action should continue. I should then be able to drop the event on a date from the next/previous month. If I drag a manual calendar event to the links for navigating to the next/previous month in the calendar view and hover for a short time (1 second) - the calendar should navigate to the next/previous month and the drag action should continue. If I drag the event over the new links for navigation to the next/previous month and hover again, the calendar should navigate to the next/previous month again and the drag action should continue. While dragging, dates should be highlighted to indicate something will happen if the event is dropped on them. I should not be able to drag events out of the main calendar region. An event with a start date and an end date can only be dragged by the start date. Both the start and end date will be adjusted so that the duration remains the same. The time of day will remain the same.
18.summary: As a user I should be able to view the main calendar page on my mobile device in order to see calendar information when I am not at a computer
description: . As a user I should be able to view the main calendar page on my mobile device in order to see calendar information when I am not at a computer Confirmations Columns and items should always be visible and tidy on all screens. UI controls should be easy to use with a touchscreen
19.summary: As a user viewing a the main calendar I should be able to navigate to different months or days without reloading the page in order to speed up my workflow
description: . As a user viewing a the main calendar I should be able to navigate to different months or days without reloading the page in order to speed up my workflow Confirmations When viewing the main calendar page, clicking on a next / previous month link will update the calendar without reloading the entire page. When navigating between days and months in the main calendar view, copy/pasting the url into a new tab should open the calendar to the same date/month.
20.summary: As a user viewing a the calendar block I should be able to navigate to different months or days without reloading the page in order to speed up my workflow
description: . As a user viewing a the calendar block I should be able to navigate to different months or days without reloading the page in order to speed up my workflow Confirmations When viewing the calendar block in a page, clicking on a next / previous month link will update the calendar block without reloading the entire page. Whenever a page is loaded with the calendar block - it will show the current month.
21.summary: As a user making changes to a manual calendar event in the calendar I should be able to see the changes immediately in order to prevent confusion
description: . As a user making changes to a manual calendar event in the calendar I should be able to see the changes immediately in order to prevent confusion Confirmations When a manual calendar event is created, updated or deleted the main calendar view should be updated immediately to reflect the change. When a manual calendar event is created, updated or deleted the calendar block should be updated immediately to reflect the change.
22.summary: As a user who can edit an activity I should be able to drag and drop an activity calendar event to a new date in order to quickly change the date settings for the activity (Optional)
description: . As a user who can edit an activity I should be able to drag and drop an activity calendar event to a new date in order to quickly change the date settings for the activity (Optional) Confirmations This should work for all core plugins, but if contributed plugins have not been updated to add this functionality then the event should not be draggable The setting for the activity that is modified will be the one that was displayed in the calendar The activity must validate that the new date is a valid setting. If is not an error should be displayed and no changes will be made to the activity. If the user does not have the required capability to manage the settings for the activity, the event should not be draggable If the event that is dragged corresponds to an override, it should not be draggable -The user should see a confirmation modal explaining exactly which setting will be modified and be asked to confirm the change.- The time of day will remain the same.
23.summary: As a developer I want to use a simple, but complete API to interact with the calendar
description: . As a developer I want to use a simple, but complete API to interact with the calendar Confirmations There should be a single set of simple functions for performing all actions on events in the calendar (create, read update and delete) The API functions should incorporate appropriate access checks to prevent users from modifying any data they do not have permission to change The same API should be available to webservices and the mobile app Each function in the API should be covered by unit tests
24.summary: As a user of non-Gregorian calendars I expect everything above to work with different calendar types in order to understand the dates and times using a calendar I am used to
description: . As a user of non-Gregorian calendars I expect everything above to work with different calendar types in order to understand the dates and times using a calendar I am used to Confirmations Hijri calendars display correctly. Japanese calendars display correctly Persian calendars display correctly.
| 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: User Stories for Calendar Improvements
description: An epic to detail each of the User Stories for the Moodle User Association project to make improvements to the Moodle calendar.
### Response:
1.summary: As a logged in user I want to be able to quickly add a manual calendar event to my personal calendar so that I can keep track of all the things in my schedule
description: . As a logged in user I want to be able to quickly add a manual calendar event to my personal calendar so that I can keep track of all the things in my schedule Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I can only add events to my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never add events to another users personal calendar. A guest user should not see an option, or be able to add events
2.summary: As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a course calendar so I can communicate important dates to the course participants
description: . As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a course calendar so I can communicate important dates to the course participants Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a course calendar if I have the moodle/calendar:manageentries capability at the course context.
3.summary: As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a group calendar so I can communicate important dates to the members of the group
description: . As a user with a teaching role in a course I should be able to quickly add a manual calendar event to a group calendar so I can communicate important dates to the members of the group Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
4.summary: As a user with a manager role in the front page course I should be able to quickly add a manual calendar event to a site calendar so I can communicate important dates to all users in the site
description: . As a user with a manager role in the front page course I should be able to quickly add a manual calendar event to a site calendar so I can communicate important dates to all users in the site Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
5.summary: As a user with an manager role in a course category I should be able to quickly add a manual calendar event to a category calendar so I can communicate important dates to all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly add a manual calendar event to a category calendar so I can communicate important dates to all users in all courses in the category Confirmations If I can see the date I want, I should be able to directly add a manual calendar event to it without leaving the page I should be able to provide a title, description, date and time for the event. I should be able to create a manual calendar event that repeats for a set number of weeks. I should be able to define a duration for the event, or an end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to add a manual calendar event to a category calendar if I have the moodle/calendar:manageentries capability at the category context.
6.summary: As a logged in user I want to be able to quickly edit a manual calendar event in my personal calendar so that I can correct the things in my schedule
description: . As a logged in user I want to be able to quickly edit a manual calendar event in my personal calendar so that I can correct the things in my schedule Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I can only edit events in my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never edit events in another users personal calendar. A guest user should not see an option, or be able to edit events
7.summary: As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a course calendar so I can communicate important dates to the course participants
description: . As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a course calendar so I can communicate important dates to the course participants Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a course calendar if I have the moodle/calendar:manageentries capability at the course context.
8.summary: As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a group calendar so I can communicate important dates to the members of the group
description: . As a user with a teaching role in a course I should be able to quickly edit a manual calendar event in a group calendar so I can communicate important dates to the members of the group Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
9.summary: As a user with an manager role in the front page course I should be able to quickly edit a manual calendar event in a site calendar so I can communicate important dates to all users in the site
description: . As a user with an manager role in the front page course I should be able to quickly edit a manual calendar event in a site calendar so I can communicate important dates to all users in the site Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
10.summary: As a user with an manager role in a course category I should be able to quickly edit a manual calendar event in a category calendar so I can communicate important dates to all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly edit a manual calendar event in a category calendar so I can communicate important dates to all users in all courses in the category Confirmations If I can see the event I want, I should be able to directly edit it without leaving the page I should be able to change the title, description, date and time for the event. If this event repeats I should be able to apply the changes to either this event only, or all events in the series. I should be able to change the duration for the event, or change the end date/time. I should be able to upload images or media files and use them in the description of the event. I should only be able to edit a manual calendar event in a category calendar if I have the moodle/calendar:manageentries capability at the category context.
11.summary: As a logged in user I want to be able to quickly delete a manual calendar event from my personal calendar so that I can correct the things in my schedule
description: . As a logged in user I want to be able to quickly delete a manual calendar event from my personal calendar so that I can correct the things in my schedule Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I can only delete events from my personal calendar if I have moodle/calendar:manageentries capability in my own user context. I can never delete events in another users personal calendar. A guest user should not see an option, or be able to delete events
12.summary: As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a course calendar so I can correct important dates for the course participants
description: . As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a course calendar so I can correct important dates for the course participants Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a course calendar if I have the moodle/calendar:manageentries capability at the course context.
13.summary: As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a group calendar so I can correct important dates for the members of the group
description: . As a user with a teaching role in a course I should be able to quickly delete a manual calendar event from a group calendar so I can correct important dates for the members of the group Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a group calendar if I have the moodle/calendar:managegroupentries capability at the course context.
14.summary: As a user with an manager role in the front page course I should be able to quickly delete a manual calendar event from a site calendar so I can correct important dates for all users in the site
description: . As a user with an manager role in the front page course I should be able to quickly delete a manual calendar event from a site calendar so I can correct important dates for all users in the site Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a site calendar if I have the moodle/calendar:manageentries capability at the front page course context.
15.summary: As a user with an manager role in a course category I should be able to quickly delete a manual calendar event from a category calendar so I can correct important dates for all users in all courses in the category
description: . As a user with an manager role in a course category I should be able to quickly delete a manual calendar event from a category calendar so I can correct important dates for all users in all courses in the category Confirmations If I can see the event I want, I should be able to directly delete it without leaving the page If this event is a repeating event I should be able to delete a single event, or all the events in the series I should be required to accept a confirmation before a manual calendar event is deleted. I should only be able to delete a manual calendar event from a category calendar if I have the moodle/calendar:manageentries capability at the category context.
16.summary: As a user with access to lots of calendars I should be able to quickly and easily specify the calendar for new events
description: . As a user with access to lots of calendars I should be able to quickly and easily specify the calendar for new events Confirmations When creating a new event the default calendar for the new event should be The course category calendar if we are currently viewing a course category calendar The course calendar we are currently viewing a course calendar. My personal calendar I should be able to quickly find and select any other calendar I can create events in by searching.
17.summary: As a logged in user I want to change the date of a calendar event by dragging and dropping it to a different date in order to speed up my workflow
description: . As a logged in user I want to change the date of a calendar event by dragging and dropping it to a different date in order to speed up my workflow Confirmations If I can see a manual calendar event I can edit in the main calendar view, I should be able to click and drag it to a different date in the main calendar view. When I drop it on that date, the date of the event will change and the calendar will reflect the new date. If I drag a manual calendar event to the links for navigating to the next/previous month in the calendar view and hover for a short time (1 second) - the calendar should navigate to the next month and the drag action should continue. I should then be able to drop the event on a date from the next/previous month. If I drag a manual calendar event to the links for navigating to the next/previous month in the calendar view and hover for a short time (1 second) - the calendar should navigate to the next/previous month and the drag action should continue. If I drag the event over the new links for navigation to the next/previous month and hover again, the calendar should navigate to the next/previous month again and the drag action should continue. While dragging, dates should be highlighted to indicate something will happen if the event is dropped on them. I should not be able to drag events out of the main calendar region. An event with a start date and an end date can only be dragged by the start date. Both the start and end date will be adjusted so that the duration remains the same. The time of day will remain the same.
18.summary: As a user I should be able to view the main calendar page on my mobile device in order to see calendar information when I am not at a computer
description: . As a user I should be able to view the main calendar page on my mobile device in order to see calendar information when I am not at a computer Confirmations Columns and items should always be visible and tidy on all screens. UI controls should be easy to use with a touchscreen
19.summary: As a user viewing a the main calendar I should be able to navigate to different months or days without reloading the page in order to speed up my workflow
description: . As a user viewing a the main calendar I should be able to navigate to different months or days without reloading the page in order to speed up my workflow Confirmations When viewing the main calendar page, clicking on a next / previous month link will update the calendar without reloading the entire page. When navigating between days and months in the main calendar view, copy/pasting the url into a new tab should open the calendar to the same date/month.
20.summary: As a user viewing a the calendar block I should be able to navigate to different months or days without reloading the page in order to speed up my workflow
description: . As a user viewing a the calendar block I should be able to navigate to different months or days without reloading the page in order to speed up my workflow Confirmations When viewing the calendar block in a page, clicking on a next / previous month link will update the calendar block without reloading the entire page. Whenever a page is loaded with the calendar block - it will show the current month.
21.summary: As a user making changes to a manual calendar event in the calendar I should be able to see the changes immediately in order to prevent confusion
description: . As a user making changes to a manual calendar event in the calendar I should be able to see the changes immediately in order to prevent confusion Confirmations When a manual calendar event is created, updated or deleted the main calendar view should be updated immediately to reflect the change. When a manual calendar event is created, updated or deleted the calendar block should be updated immediately to reflect the change.
22.summary: As a user who can edit an activity I should be able to drag and drop an activity calendar event to a new date in order to quickly change the date settings for the activity (Optional)
description: . As a user who can edit an activity I should be able to drag and drop an activity calendar event to a new date in order to quickly change the date settings for the activity (Optional) Confirmations This should work for all core plugins, but if contributed plugins have not been updated to add this functionality then the event should not be draggable The setting for the activity that is modified will be the one that was displayed in the calendar The activity must validate that the new date is a valid setting. If is not an error should be displayed and no changes will be made to the activity. If the user does not have the required capability to manage the settings for the activity, the event should not be draggable If the event that is dragged corresponds to an override, it should not be draggable -The user should see a confirmation modal explaining exactly which setting will be modified and be asked to confirm the change.- The time of day will remain the same.
23.summary: As a developer I want to use a simple, but complete API to interact with the calendar
description: . As a developer I want to use a simple, but complete API to interact with the calendar Confirmations There should be a single set of simple functions for performing all actions on events in the calendar (create, read update and delete) The API functions should incorporate appropriate access checks to prevent users from modifying any data they do not have permission to change The same API should be available to webservices and the mobile app Each function in the API should be covered by unit tests
24.summary: As a user of non-Gregorian calendars I expect everything above to work with different calendar types in order to understand the dates and times using a calendar I am used to
description: . As a user of non-Gregorian calendars I expect everything above to work with different calendar types in order to understand the dates and times using a calendar I am used to Confirmations Hijri calendars display correctly. Japanese calendars display correctly Persian calendars display correctly.
|
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: Redesign of 4.0 Activity cards
description: To address user feedback on 4.0 activity cards, we conducted research and usability testing with both Moodle community members and non-Moodle users. The goal is to redesign the activity cards in a way that solves community pain points and improves the user experience for both teachers/content creators and students. The following components will be included in the redesign: Activity icons, Availability, Restrictions, Group mode, Activity dates and Completion criteria. Teachers/Content creators - The use of vertical space has been minimized by using only whats necessary when needed. - Distinguishing functionality and behavior between Edit mode and View mode is crucial. - The teacher role view should exhibit pertinent information tailored to the individual teachers needs. - In Edit mode, teachers should be able to easily review the page and verify the accuracy of the settings, without needing to click any additional links or buttons to access the settings information. - The course overview page should enable effortless editing of the most commonly used settings. Students - Within the course page, the activity card provides students with clear and easily accessible information about course activities and content, while also displaying activity settings in a consistent and user-friendly manner. . Issue dependency tree Styling: - Redesign card CSS to make them smaller like the prototype - Reintroduce groupmode icon with no edit feature yet - TASK: investigate keyboard and hover navigation on hidden icons : replace CSS classes of the "+" icons between activities by generic CSS helpers - Modify the access restrictions description to match the prototype - regression with the activity icon and restriction access - Set show file extension default to true in mod_resource - display folder in course page error - improve action menu subpanels effect and styling (based on code) - Modify the choicelist and dropdowns/status style to match the prototype (based on code) - final review of the UI to match the prototype Migrate the old group mod edit webservice to the new course format: - Create the groupmode state actions (webservice) - Create groupmode reactive mutation to course format - TASK Investigate the feasibility of the new advanced dropdown UI component required for the course editor icons - Create new details dropdown component (the "thing" we need to display when user click on completion badge) - Add details dropdown to completion criteria badge (to show the criteria when click) - Modify the completion criteria for students to display format to match the prototype - Add radio dropdown interaction to availability badge (to select option on click) - Add radio dropdown interaction to groupmode icon (to select option on click) (depends on and ) - improve the dropdown accessibility and keyboard navigation Activity icons: - New activity icons design - Reintroduce activity mime file type icons (meaning each file has its extension icon) - Implement activity card information badge integration - Move the current activity information at the bottom of the activity card ? - Move the file extension integration in mod_resource to the new badge integration (if UX wants separate from file size) - TASK: investigate the viability of using direct links to quickform sections (base for quickform buttons in completion, restrictions and due dates) - Add completion quickform direct link button to completion details dropdown (depends on ) - Add access restriction quickform direct link button to restrictions details dropdown (depends on ) - TASK: investigate how to open subpanels from the actions menu (like the one proposed for groupmode and availability form the activity action menu) - create generics submenu classes - Add availability option to action menu to open a subpanel instead of showing a modal (depends on ) - Add group mode option to activity actions dropdown menu (depends on and ) ---- Research report| MVP designs Prototype instructions| Teacher flow prototype| Student flow prototype|
| Unsolvable | 1.summary: Modify the availability activity action menu to open in a subpanel
description: Modify the availability click event in the activity action menu to open a subpanel instead of showing a modal. !Screenshot_062.png|thumbnail! This will replace the previous "show", "hide" and "stealth" options. This issue depends on for the submenu implementation and for the availability status content.
2.summary: Create a generic submenu for status selection
description: The new course editing UX uses submenus to group status options like availability (visible, hidden, stealth) and group mode (no groups, separate, visible). This issue will implement all the generic classes to implement one level submenus inside the standard action_menu. Example of the availability submenu: !Screenshot_102.png|thumbnail! Example of the group mode !Screenshot_103.png|thumbnail! . Technical shaping Currently, the action_menu class has a method "add" which accepts: action_menu_link: depending on some inner attribute the link will be rendered as a secondary or primary action item pix_icon: will be used a a primary action item Any other renderable: will be used a secondary item and rendered freely inside the menu. A new class core\output\local\action_menu\subpanel will appear to render menu items with a subpanel. The class will be similar to a regular action_menu_link but accepting a renderable for the panel content. When a subpanel is passed to "action_menu::add": Set the element as a secondary element To render the action menu item, the class will export a pre-rendered version to the panel to the template data. It will use a standard render like any other output component to render the submenu content. This issue will also provide a fixture page to test the component.
3.summary: Add radio dropdown interaction to availability badge in the new activity cards design
description: The new activity card design for 4.3 uses a new select dropdown component to present the availability options of an activity form the course page. The UI will be based on the component created in . The content will present all the availability options (visible, hidden and stealth) the activity can have. Each option will also display the same description used in the bulk editing availability modal. The current bulk editing availability modal: !Screenshot_028.png|thumbnail!
4.summary: Add radio dropdown interaction to groupmode icon to the new activity card design
description: The new activity card design for 4.3 uses a new select dropdown component to edit the group mode options of an activity form the course page. The UI will be based on the component created in . The content will present all the group mode options (none, visible, separate) the activity can have. Each option will display the description of the group mode. Example: !Screenshot_054.png|thumbnail!
5.summary: Modify choicelist and dropdown/status templates to match the prototypes
description: The addition of activity cards includes a new output choice list object that displays user choices on the user interface. This output can be rendered independently or used as a parameter for other output classes, such as the dropdowns/status. After a UX review, some UI changes are required to meet the current prototype: The complete list of required changes are: Swap the position of the check/circle icons and the options icon. The "radio" alike element should always be in the icons left in RLT. The selected choice is now displayed in cursive and grey colour. This is confusing as it looks like a disabled link. It should be bold only. The selected choice background is grey. However, this is confusing because it is used in disabled elements. The colour should be a light primary, like the background of the activity card on hover. Check if we can better align the checkbox icon and the choice one. This is related to the fact that one is a font awesome, and the other is a svg. The choices should not be displayed in the same style as a regular link. The selected option should be primary without decoration and the others black without decoration. This is the prototype proposal: !Screenshot_118.png|thumbnail!
6.summary: Improve section and activity settings form to load access restrictions
description: When editing section or activity settings, the Access restrictions field shows a JSON object in a textarea input that is "rendered" as a form using YUI code. This was not a problem because Restrict access settings group is collapsed by default, so usually the YUI code is executed before the user sees it. But after changes done in the issue is more obvious. We decided to hide the textarea while rendering the information in an understandable way for the user in , but this should be improved. This issue is about adding a loading option while the Access restrictions field is totally ready to be shown to the user. Link to the Figma design|
7.summary: Refactor activity_information output class
description: The output class course/classes/output/activity_information| handles both activity completion and activity dates together. It should be deprecated and split into two different output classes (activity_completion and activity_dates) so each of them will be responsible for its own data. By doing this we could avoid some cases like core_course\task\content_notification_task| where activity_information is created, but only activity dates are needed. It is referenced in: core_course\taskcontent_notification_task core_course_renderer (Deprecation needed too) core_courseformat\output\local\content\cm renderer_base (Probably deprecation needed, as it is only used in mod_wiki_renderer::wiki_info() that is a deprecated function)
8.summary: Improve action menu subpanel aesthetics and effects
description: In , a new action menu subpanel was introduced. The new component adds subpanels associated with action menu items displayed on hover, focus or click. After a UX review, the current visualizations of the subpanels should have some improvements to make them more consistent and noticeable. The complete list of the proposed improvements are: The menu item shows a chevron pointing to the position where the sub panel will open. However, when the menu item has an icon, the item is displaced to the right and not correctly aligned. This is not correct. It is considered a UX standard that when a menu item has a subpanel, the chevron always points to the right (or left in RTL), no matter where the subpanel opens. There is no effect when the subpanels open. and it is noticeable enough. Showing a sub-panel should have some effect. The panel is floating over the content, but it should have a shadow.
9.summary: Investigate the feasibility of the new advanced dropdown UI component required for the course editor icons
description: The new activity card proposed for 4.3 uses new interactable icons to replace the previous togglers. For example, in Moodle 3.9 clicking the group icon toggles the activity group mode without providing any description of the available options and without warning the user that the action will change the behaviour of the activity. That kinds of icons were removed in 4.0 due the UX problems. However, one of the conclusions of the last UX research about activity cards proves those icons are needed but with a different usability approach. The new approach defines that clicking on the icon will open a sub panel with the available options and that each option must also display a small description. This task is about investigating the technical solutions for this reusable UI component. . Technical shaping One possible approach is to use the HTML "dialogue" tag. This tag is quite new but implements many of the accessibility issues needed for that kind of panel.
10.summary: Add the group mode indicator to the activity card
description: Add the group mode indicator to the activity card. The icon has a different logic than the one used in 3.9- versions: No groups: the icon is not displayed Separate groups and Visible groups: the icon is visible For now, the icon wont be clickable. The next issues will incorporate a dropdown panel with the available options and all the webservices to integrate the group mode with the course editor. !Screenshot_043.png|thumbnail! The icon would be shown for users with moodle/site:accessallgroups capability at activity level only in both Edit and View mode.
11.summary: Set show file extension default to true in mod_resource
description: During the last user testings, the UX team identifies that most users prefer the file extension to be shown in the course page by default and only hide when the teacher really wants to. This issue is to change the default value of this setting.
12.summary: Create the groupmode state actions
description: The new groupmode icon introduced in will be interactable soon as the 3,9- one. However, the new icon will not use the old webservices because they are not integrated with the new course editor created in 4.0. In this issue, the new state actions and mutations needed to change the group activity mode from the icon will be implemented. This issue is about creating the state actions and mutations only, the UI to call to these functions will be implemented in
13.summary: Create groupmode reactive mutation to course format
description: In 4.3 a new group mode will be added to the activity action menu. This option will allow the user to select the group mode directly from the course page. This issue will implement all the state mutations required to handle the option click. This implies calling the proper state action (created in ) and applying the returning result to the course state.
14.summary: Add "show more" / "show less" options for access restrictions on course page
description: The new activity cards proposed for 4.3 represent activity access restrictions more compactly. This issue is about implementing it. Edit mode !Edit mode.png|thumbnail! View mode !View mode.png|thumbnail!
15.summary: Add access restriction quickform direct link button to restrictions details dropdown
description: This issue depends on the results of task. In the new activity card design, the availability restrictions (in edit mode) have direct links to edit restrictions on the activity settings page. !image-2023-07-03-17-44-30-477.png! Link to the prototype|
16.summary: TASK: investigate how to open subpanels from the activity actions menu
description: The new activity card design for 4.3 proposes a new way to display options in the actual action menu items. The idea is to open a submenu, and then the used focus or clicks on the element. For example, focussing on availability will open a submenu with the traditional show/hide/steath options. Plus, the new submenu should be able to display icons and descriptions for each option. !Screenshot_059.png|thumbnail! The current language selector is somehow inspired by the new submenu in the profile menu. However, the new design is intended to be more visual as the original dropdown menu will keep open while the user selects. !Screenshot_061.png|thumbnail! This task evaluates the feasibility of that new submenu, especially regarding the accessibility aspect of the same and the keyboard navigation. Not a task for fearful devs indeed. There are some examples out there of subpanels in bootstrap menus, they are not the complete solution but they can help:
17.summary: Improve the student completion criteria display format
description: In the new activity card design, the completion criteria for students display the different states in a new way using the dropdown implemented in . The different automatic completion options: !image-2023-07-07-11-56-21-293.png|thumbnail! The manual completion: !Screenshot_057.png|thumbnail!
18.summary: Implement activity card information badge integration
description: Activities can add extra HTML to the activity card using the afterlink feature. This integration allows things like: In mod_forum, this HTML is a bootstrap pill with unread messages. In mod_resource is plain text with the file details. The new activity card design proposed for 4.3 differentiates badge information from other HTML content. The badge will appear just after the activity name and any other content will appear on the lower part of the card. This issue is to implement the new "badge" integration allowing plugins to: Decide if they want to display a badge near the activity name Return the plain text (not HTML) badge content Optionally, set the badge style (notice, alert, warning...). Important note: it should be a "badge-none" class to display the badge as a transparent background and without a border (needed in some cases when the badge is secondary information like the file extension) An optional URL to direct the user when the badge is clicked An optional ID to add the element in case the module wants to add some JS to the badge events. Optionally, any other extra HTML attributes to the badge element (for example, data attributes). To test the integration, this issue also includes moving the current mod_forum unread messages pill from the generic information to the pill one. . Technical shaping The current afterlink is the typical integration that allows anarchy because they dont limit the content plugins can add to the course page. In this case, the badge should only allow plain text and some specifications like the badge style. To limit the excess of creativity of the plugins, the best approach is to allow plugins to implement a specific class. For example, mod_PLUGINNAME\output\courseformat\activitybadge that extends from an original core_courseformat\output\activitybadge. The core_courseformat\output\activitybadge will delegate most data attributes to protected methods. Using this approach, we can guarantee activities will only override some methods. Finally, the activity badge can be rendered using the existing course/format/templates/local/content/cm/badges mustache or creating a new one.
19.summary: Investigate keyboard and hover navigation on hidden icons
description: The new activity card proposed for 4.3 include several icons that only appear when the value is not the default one: Group mode icon: only appear when the activity is in separate or visible groups, but it is hidden in now groups. Availability: only appear is hidden and stealth activities, but not in visible ones. This is a good solution because it reduces the visual load of the course and allows the teacher to differentiate activities settings easily. The new design also incorporates direct manipulation of those icons. In the new design, clicking the icon will prompt the user to all the available options and allow them to change the settings directly from the course page. Again, this is a good improvement from the UX perspective as it provides a more intuitive way to craft the course. However, combining those two characteristics produces an undesired situation when the user changes the setting to the default value. When the user clicks the default value option, the icon disappears, and, inconsequence: To undo the action, the user should open the activity action menu because no icon is available anymore. The activity is refreshed when the option is clicked, and the focus should go somewhere. The common behaviour is to return to the previously clicked element, which was the icon, but the icon is no longer visible and cannot be focused. This issue is about defining what to do in this scenario. . Technical shaping One possible option is to detect the active activity card (via hover or has(focused)) and keep the default icons visible and accessible via the keyboard. Another option is to keep the default icon visible until it loses focus.
20.summary: Investigate viability of using direct links to quickform sections
description: Some of the new activity card elements proposed for 4.3 require direct links to quick-form sections. However, this is not something we have in Moodle right now. Some of the scenarios in the course page 4.3 design are: Restrictions access has an "Edit settings" link directly to the access restrictions settings. The completion criteria have a link to the activity completion criteria section. !Screenshot_047.png|thumbnail! !Screenshot_048.png|thumbnail! Of course, in an ideal world, those links will open a modal with the settings in it so the user can edit them from the course page. However, this is out of scope for 4.3. . Technical shaping All quickform elements have a unique id, so it should be possible to focus directly on a specific element. The only problem is when the field is inside a collapsed form section. This could be done in pure JS but can result in a glitchy effect. It will be better if PHP considers the anchor when rendering the form. Another point to consider is that it will be super useful if, instead of an anchor, the param could be a filter that hides the rest of the fields except the submitted ones and the related sections. I know what you are thinking, this requires tweaking the ancient quickform classes and I am not Indiana Jones. But, hey, this is why we have a feasibility task and not a direct implementation one ;).
21.summary: Move the current activity plugin activity card information integration to the bottom of the card.
description: Activity plugins can implement their own afterlink feature to render arbitrary HTML into the activity card on the course page. This information is currently renderer just after the activity name. However, The new activity card design proposed for 4.3 moves that information below the general activity information. This gives more space for the activity name and the course format icons and separates that arbitrary content from the activity card title. Furthermore, this allows plugins to return complex HTML structures without fearing breaking the activity card structure. This issue is about moving the information at the bottom of the activity card to match the prototype. !Screenshot_046.png|thumbnail! Extra information: a new badge integration will be implemented in to allow plugins to add text after the activity name. Limiting the content to basic text.
22.summary: Create new details select dropdowns component needed for the new activity cards
description: This issue is conditioned to the result of the task. The new activity card proposed for 4.3 uses new interactable icons to replace the previous togglers. For example, in Moodle 3.9 clicking the group icon toggles the activity group mode without providing any description of the available options and without warning the user that the action will change the behaviour of the activity. The new component will be used to convert some of those icons into a dropdown like element. However, instead of a regular action menu, the new dropdown will be able to display custom icons and descriptions for the available potions. This issue is ab out creating this generic component in core. !Screenshot_054.png|thumbnail!
23.summary: Create new details dropdown components for the new activity cards design
description: This issue is conditioned to the result of the task. The new activity card proposed for 4.3 uses two new interactable components to display information inside a dropdown. Those two components are: Dropdown dialog: a new generic component will be create to display a dropdown like element that could present rich text HTML inside. This component will be used to display the completion conditions inside a dropdown. !Screenshot_055.png|thumbnail! Dropdown status: an extension of the previous one but providing a list of status to choose from. Those will let the user select the activity availability (visible, hidden, stealth) and the group mode (no groups, separate and visible groups). !Screenshot_054.png|thumbnail! In this issue, both generic components will be created. . Technical shaping The dropdown status component will be used to convert some of those icons into a dropdown-like element. However, instead of a regular action menu, the new dropdown must be able to display custom icons and descriptions for the available potions. This feature is similar to the modal used in bulk editing and related to . We dont have any output class to define this user interaction. For example, when we change a dropdown menu to a navigation dropdown, both represent the same interaction but use different construct parameters (we lose maintainability). To avoid this problem, part of this issue will create a generic output user choice class that can be used as an interaction definition object. In the future, the same class could instantiate for modals or any other user choice needed.
24.summary: Add details dropdown to completion criteria badge
description: The new activity card design for 4.3 uses a new dropdown component to present the completion criteria of an activity. The UI will be based on the component created in . The content will present the completion conditions, the manual completion if available, and, in future issues, a link to edit the completion criteria (if the teacher is in edit mode). Example of a teacher in edit mode: !Screenshot_055.png|thumbnail! Note: depending on the implementation, this issue can include .
25.summary: Improve activity card styling including rounded corners, background colour, less padding, activity name tooltip for teachers
description: Implement the new proposed activity cards styles to match the prototype. This include the smaller padding, the background color, the radius of the card and any possible border color. !Captura de pantalla 2023-05-18 a las 10.07.59.png|thumbnail! This issue does not include the availability dropdown (with chevron) and the group mode icon because they will be done in a separate issue. Ui style +Card border+ Color: Secondary/Gray-300 (Default) Content/Primary (Hover, Selected) Stroke: 1px Rounded borders: 16px +Card fill+ Color: Secondary/White (Default) Secondary/Gray-100 (Hidden, Stealth) Content/Primary-light (Hover, Selected) +Card margins+ 16px (Left, right, top and bottom margins) +Card height+ 64px (Min-height) +Text+ Activity title: Content/Copy File extension: Secondary/Gray-700 Dates: Secondary/Gray-700 Description: Content/Copy File info: Secondary/Gray-700 +Availability badge+ Text: Content/Copy Badge background: Secondary/Gray-300 +Restrictions+ Text: Content/Copy (Icon and Restrictions text), Content/Primary (Show more/less button) Container background: Secondary/Gray-200 Container rounded borders: 16px
26.summary: Replace the add activity between activities adhoc CSS classes by generic helpers
description: Starting from version 4.1, an additional "+" icon is displayed between activities, but only when the activity card is currently in focus. That was the first time a vanishing element is implemented on the course page and it was done using ad-hoc CSS rules (.content .section .activity:focus-within div.divider button). However, in 4.3, new elements like the group icon () will have the same logic and replicating CSS rules per each element is not an option anymore. The task concludes the best technical approach for a generic CSS rule is to create a set of 2 generic CSS rules: focus-control: for the parent element that needs to be focused. v-parent-focus: for the vanishing element that needs to be hidden unless the focus-control parent has a focus within In this issue, the current "+" icon CSS classes will be replaced by the generic helpers and the ad-hoc CSS will be removed.
27.summary: Add completion quickform direct link button to completion details dropdown
description: This issue depends on the results of task. In the new activity card design the completion badge has a direct link to edit the completion settings of an activity inside the dropdown added in . !image-2023-08-01-13-11-25-552.png!
28.summary: Review the UI and CSS of the activity project prototype
description: This is issue is about reviewing the UI and CSS of the implemented activity card project changes to match the prototype| Fix paddings/margin on restrictions block when displaying "Edit settings" button Fix activity action menu size to 32x32 Re-style the "+" button in "Add activity or resource" to rounded to match the prototype Add "Completion"/"To do" button hover styling Fix action menu and groupmode hover styling (bgcolor and radius) Fix inplaceeditable icon and activity badge position to show them inline with the activity name Fix section availability styles to be consistent with activity availability Fix "Add section" spacing and styles, adding "+" icon too
29.summary: Add group mode option to activity actions submenu
description: incorporate group mode editing from the course page. In the past, the group icon was a group-mode toggler. However, this behaviour has many UX problems as it is unexpected for many users. This issue will add a new "group mode" link to the activity action menu. This issue depends on the results of . If the submenu is technically possible, clicking the group mode will open the submenu with all available options. Otherwise, clicking the group mode will open a radio modal (using the component created in ). This is the aspect of the submenu if this option is feasible: !Screenshot_059.png|thumbnail! This issue depends on for the submenu classes and for the group mode status select output.
30.summary: Define Completion dropdown component in the course page for empty conditions
description: Reviewing we realized there are some activities (e.g. Database activity) that allow the teacher to set Completion tracking to Show activity as complete when conditions are met but dont mark any of the requirements, so the completion conditions are empty. This would be probably fixed in . But even fixing that bug and not allowing teachers to do it never again, some existing activities could face this problem, so we should decide from UX and PX perspective what to show to teachers and students in empty completion criteria use cases. !image-2023-07-06-13-24-29-704.png|width=477,height=224!!image-2023-07-06-13-24-58-496.png|width=271,height=89! ---- Designs +Teachers+ !Teachers.png|thumbnail! +Students+ !Students.png|thumbnail!
31.summary: Improve accessiblity of keyboard control for the generic dropdowns
description: During the review f , some accessiiblity improvement has been detected for the generic dropdown components created in . I quote the original text: Id like to note the following accessibility issues that I noticed related to the interactive dropdown component: Id expect the dropdown menu items to follow the menu pattern| especially in terms of keyboard interaction. Or perhaps at least for the choices to follow the Radio group pattern| The menu buttons focus indicator uses the browsers default focus indicator. This means that the focus indicator will look different across browsers and we may fail the WCAG Level AA Success Criterion 2.4.7 (Focus Visible)| if the browsers default focus indicator does not meet this requirement. The menu items are also using the browsers default focus indicator. This issue is a bout fixing those points.
| 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: Redesign of 4.0 Activity cards
description: To address user feedback on 4.0 activity cards, we conducted research and usability testing with both Moodle community members and non-Moodle users. The goal is to redesign the activity cards in a way that solves community pain points and improves the user experience for both teachers/content creators and students. The following components will be included in the redesign: Activity icons, Availability, Restrictions, Group mode, Activity dates and Completion criteria. Teachers/Content creators - The use of vertical space has been minimized by using only whats necessary when needed. - Distinguishing functionality and behavior between Edit mode and View mode is crucial. - The teacher role view should exhibit pertinent information tailored to the individual teachers needs. - In Edit mode, teachers should be able to easily review the page and verify the accuracy of the settings, without needing to click any additional links or buttons to access the settings information. - The course overview page should enable effortless editing of the most commonly used settings. Students - Within the course page, the activity card provides students with clear and easily accessible information about course activities and content, while also displaying activity settings in a consistent and user-friendly manner. . Issue dependency tree Styling: - Redesign card CSS to make them smaller like the prototype - Reintroduce groupmode icon with no edit feature yet - TASK: investigate keyboard and hover navigation on hidden icons : replace CSS classes of the "+" icons between activities by generic CSS helpers - Modify the access restrictions description to match the prototype - regression with the activity icon and restriction access - Set show file extension default to true in mod_resource - display folder in course page error - improve action menu subpanels effect and styling (based on code) - Modify the choicelist and dropdowns/status style to match the prototype (based on code) - final review of the UI to match the prototype Migrate the old group mod edit webservice to the new course format: - Create the groupmode state actions (webservice) - Create groupmode reactive mutation to course format - TASK Investigate the feasibility of the new advanced dropdown UI component required for the course editor icons - Create new details dropdown component (the "thing" we need to display when user click on completion badge) - Add details dropdown to completion criteria badge (to show the criteria when click) - Modify the completion criteria for students to display format to match the prototype - Add radio dropdown interaction to availability badge (to select option on click) - Add radio dropdown interaction to groupmode icon (to select option on click) (depends on and ) - improve the dropdown accessibility and keyboard navigation Activity icons: - New activity icons design - Reintroduce activity mime file type icons (meaning each file has its extension icon) - Implement activity card information badge integration - Move the current activity information at the bottom of the activity card ? - Move the file extension integration in mod_resource to the new badge integration (if UX wants separate from file size) - TASK: investigate the viability of using direct links to quickform sections (base for quickform buttons in completion, restrictions and due dates) - Add completion quickform direct link button to completion details dropdown (depends on ) - Add access restriction quickform direct link button to restrictions details dropdown (depends on ) - TASK: investigate how to open subpanels from the actions menu (like the one proposed for groupmode and availability form the activity action menu) - create generics submenu classes - Add availability option to action menu to open a subpanel instead of showing a modal (depends on ) - Add group mode option to activity actions dropdown menu (depends on and ) ---- Research report| MVP designs Prototype instructions| Teacher flow prototype| Student flow prototype|
### Response:
1.summary: Modify the availability activity action menu to open in a subpanel
description: Modify the availability click event in the activity action menu to open a subpanel instead of showing a modal. !Screenshot_062.png|thumbnail! This will replace the previous "show", "hide" and "stealth" options. This issue depends on for the submenu implementation and for the availability status content.
2.summary: Create a generic submenu for status selection
description: The new course editing UX uses submenus to group status options like availability (visible, hidden, stealth) and group mode (no groups, separate, visible). This issue will implement all the generic classes to implement one level submenus inside the standard action_menu. Example of the availability submenu: !Screenshot_102.png|thumbnail! Example of the group mode !Screenshot_103.png|thumbnail! . Technical shaping Currently, the action_menu class has a method "add" which accepts: action_menu_link: depending on some inner attribute the link will be rendered as a secondary or primary action item pix_icon: will be used a a primary action item Any other renderable: will be used a secondary item and rendered freely inside the menu. A new class core\output\local\action_menu\subpanel will appear to render menu items with a subpanel. The class will be similar to a regular action_menu_link but accepting a renderable for the panel content. When a subpanel is passed to "action_menu::add": Set the element as a secondary element To render the action menu item, the class will export a pre-rendered version to the panel to the template data. It will use a standard render like any other output component to render the submenu content. This issue will also provide a fixture page to test the component.
3.summary: Add radio dropdown interaction to availability badge in the new activity cards design
description: The new activity card design for 4.3 uses a new select dropdown component to present the availability options of an activity form the course page. The UI will be based on the component created in . The content will present all the availability options (visible, hidden and stealth) the activity can have. Each option will also display the same description used in the bulk editing availability modal. The current bulk editing availability modal: !Screenshot_028.png|thumbnail!
4.summary: Add radio dropdown interaction to groupmode icon to the new activity card design
description: The new activity card design for 4.3 uses a new select dropdown component to edit the group mode options of an activity form the course page. The UI will be based on the component created in . The content will present all the group mode options (none, visible, separate) the activity can have. Each option will display the description of the group mode. Example: !Screenshot_054.png|thumbnail!
5.summary: Modify choicelist and dropdown/status templates to match the prototypes
description: The addition of activity cards includes a new output choice list object that displays user choices on the user interface. This output can be rendered independently or used as a parameter for other output classes, such as the dropdowns/status. After a UX review, some UI changes are required to meet the current prototype: The complete list of required changes are: Swap the position of the check/circle icons and the options icon. The "radio" alike element should always be in the icons left in RLT. The selected choice is now displayed in cursive and grey colour. This is confusing as it looks like a disabled link. It should be bold only. The selected choice background is grey. However, this is confusing because it is used in disabled elements. The colour should be a light primary, like the background of the activity card on hover. Check if we can better align the checkbox icon and the choice one. This is related to the fact that one is a font awesome, and the other is a svg. The choices should not be displayed in the same style as a regular link. The selected option should be primary without decoration and the others black without decoration. This is the prototype proposal: !Screenshot_118.png|thumbnail!
6.summary: Improve section and activity settings form to load access restrictions
description: When editing section or activity settings, the Access restrictions field shows a JSON object in a textarea input that is "rendered" as a form using YUI code. This was not a problem because Restrict access settings group is collapsed by default, so usually the YUI code is executed before the user sees it. But after changes done in the issue is more obvious. We decided to hide the textarea while rendering the information in an understandable way for the user in , but this should be improved. This issue is about adding a loading option while the Access restrictions field is totally ready to be shown to the user. Link to the Figma design|
7.summary: Refactor activity_information output class
description: The output class course/classes/output/activity_information| handles both activity completion and activity dates together. It should be deprecated and split into two different output classes (activity_completion and activity_dates) so each of them will be responsible for its own data. By doing this we could avoid some cases like core_course\task\content_notification_task| where activity_information is created, but only activity dates are needed. It is referenced in: core_course\taskcontent_notification_task core_course_renderer (Deprecation needed too) core_courseformat\output\local\content\cm renderer_base (Probably deprecation needed, as it is only used in mod_wiki_renderer::wiki_info() that is a deprecated function)
8.summary: Improve action menu subpanel aesthetics and effects
description: In , a new action menu subpanel was introduced. The new component adds subpanels associated with action menu items displayed on hover, focus or click. After a UX review, the current visualizations of the subpanels should have some improvements to make them more consistent and noticeable. The complete list of the proposed improvements are: The menu item shows a chevron pointing to the position where the sub panel will open. However, when the menu item has an icon, the item is displaced to the right and not correctly aligned. This is not correct. It is considered a UX standard that when a menu item has a subpanel, the chevron always points to the right (or left in RTL), no matter where the subpanel opens. There is no effect when the subpanels open. and it is noticeable enough. Showing a sub-panel should have some effect. The panel is floating over the content, but it should have a shadow.
9.summary: Investigate the feasibility of the new advanced dropdown UI component required for the course editor icons
description: The new activity card proposed for 4.3 uses new interactable icons to replace the previous togglers. For example, in Moodle 3.9 clicking the group icon toggles the activity group mode without providing any description of the available options and without warning the user that the action will change the behaviour of the activity. That kinds of icons were removed in 4.0 due the UX problems. However, one of the conclusions of the last UX research about activity cards proves those icons are needed but with a different usability approach. The new approach defines that clicking on the icon will open a sub panel with the available options and that each option must also display a small description. This task is about investigating the technical solutions for this reusable UI component. . Technical shaping One possible approach is to use the HTML "dialogue" tag. This tag is quite new but implements many of the accessibility issues needed for that kind of panel.
10.summary: Add the group mode indicator to the activity card
description: Add the group mode indicator to the activity card. The icon has a different logic than the one used in 3.9- versions: No groups: the icon is not displayed Separate groups and Visible groups: the icon is visible For now, the icon wont be clickable. The next issues will incorporate a dropdown panel with the available options and all the webservices to integrate the group mode with the course editor. !Screenshot_043.png|thumbnail! The icon would be shown for users with moodle/site:accessallgroups capability at activity level only in both Edit and View mode.
11.summary: Set show file extension default to true in mod_resource
description: During the last user testings, the UX team identifies that most users prefer the file extension to be shown in the course page by default and only hide when the teacher really wants to. This issue is to change the default value of this setting.
12.summary: Create the groupmode state actions
description: The new groupmode icon introduced in will be interactable soon as the 3,9- one. However, the new icon will not use the old webservices because they are not integrated with the new course editor created in 4.0. In this issue, the new state actions and mutations needed to change the group activity mode from the icon will be implemented. This issue is about creating the state actions and mutations only, the UI to call to these functions will be implemented in
13.summary: Create groupmode reactive mutation to course format
description: In 4.3 a new group mode will be added to the activity action menu. This option will allow the user to select the group mode directly from the course page. This issue will implement all the state mutations required to handle the option click. This implies calling the proper state action (created in ) and applying the returning result to the course state.
14.summary: Add "show more" / "show less" options for access restrictions on course page
description: The new activity cards proposed for 4.3 represent activity access restrictions more compactly. This issue is about implementing it. Edit mode !Edit mode.png|thumbnail! View mode !View mode.png|thumbnail!
15.summary: Add access restriction quickform direct link button to restrictions details dropdown
description: This issue depends on the results of task. In the new activity card design, the availability restrictions (in edit mode) have direct links to edit restrictions on the activity settings page. !image-2023-07-03-17-44-30-477.png! Link to the prototype|
16.summary: TASK: investigate how to open subpanels from the activity actions menu
description: The new activity card design for 4.3 proposes a new way to display options in the actual action menu items. The idea is to open a submenu, and then the used focus or clicks on the element. For example, focussing on availability will open a submenu with the traditional show/hide/steath options. Plus, the new submenu should be able to display icons and descriptions for each option. !Screenshot_059.png|thumbnail! The current language selector is somehow inspired by the new submenu in the profile menu. However, the new design is intended to be more visual as the original dropdown menu will keep open while the user selects. !Screenshot_061.png|thumbnail! This task evaluates the feasibility of that new submenu, especially regarding the accessibility aspect of the same and the keyboard navigation. Not a task for fearful devs indeed. There are some examples out there of subpanels in bootstrap menus, they are not the complete solution but they can help:
17.summary: Improve the student completion criteria display format
description: In the new activity card design, the completion criteria for students display the different states in a new way using the dropdown implemented in . The different automatic completion options: !image-2023-07-07-11-56-21-293.png|thumbnail! The manual completion: !Screenshot_057.png|thumbnail!
18.summary: Implement activity card information badge integration
description: Activities can add extra HTML to the activity card using the afterlink feature. This integration allows things like: In mod_forum, this HTML is a bootstrap pill with unread messages. In mod_resource is plain text with the file details. The new activity card design proposed for 4.3 differentiates badge information from other HTML content. The badge will appear just after the activity name and any other content will appear on the lower part of the card. This issue is to implement the new "badge" integration allowing plugins to: Decide if they want to display a badge near the activity name Return the plain text (not HTML) badge content Optionally, set the badge style (notice, alert, warning...). Important note: it should be a "badge-none" class to display the badge as a transparent background and without a border (needed in some cases when the badge is secondary information like the file extension) An optional URL to direct the user when the badge is clicked An optional ID to add the element in case the module wants to add some JS to the badge events. Optionally, any other extra HTML attributes to the badge element (for example, data attributes). To test the integration, this issue also includes moving the current mod_forum unread messages pill from the generic information to the pill one. . Technical shaping The current afterlink is the typical integration that allows anarchy because they dont limit the content plugins can add to the course page. In this case, the badge should only allow plain text and some specifications like the badge style. To limit the excess of creativity of the plugins, the best approach is to allow plugins to implement a specific class. For example, mod_PLUGINNAME\output\courseformat\activitybadge that extends from an original core_courseformat\output\activitybadge. The core_courseformat\output\activitybadge will delegate most data attributes to protected methods. Using this approach, we can guarantee activities will only override some methods. Finally, the activity badge can be rendered using the existing course/format/templates/local/content/cm/badges mustache or creating a new one.
19.summary: Investigate keyboard and hover navigation on hidden icons
description: The new activity card proposed for 4.3 include several icons that only appear when the value is not the default one: Group mode icon: only appear when the activity is in separate or visible groups, but it is hidden in now groups. Availability: only appear is hidden and stealth activities, but not in visible ones. This is a good solution because it reduces the visual load of the course and allows the teacher to differentiate activities settings easily. The new design also incorporates direct manipulation of those icons. In the new design, clicking the icon will prompt the user to all the available options and allow them to change the settings directly from the course page. Again, this is a good improvement from the UX perspective as it provides a more intuitive way to craft the course. However, combining those two characteristics produces an undesired situation when the user changes the setting to the default value. When the user clicks the default value option, the icon disappears, and, inconsequence: To undo the action, the user should open the activity action menu because no icon is available anymore. The activity is refreshed when the option is clicked, and the focus should go somewhere. The common behaviour is to return to the previously clicked element, which was the icon, but the icon is no longer visible and cannot be focused. This issue is about defining what to do in this scenario. . Technical shaping One possible option is to detect the active activity card (via hover or has(focused)) and keep the default icons visible and accessible via the keyboard. Another option is to keep the default icon visible until it loses focus.
20.summary: Investigate viability of using direct links to quickform sections
description: Some of the new activity card elements proposed for 4.3 require direct links to quick-form sections. However, this is not something we have in Moodle right now. Some of the scenarios in the course page 4.3 design are: Restrictions access has an "Edit settings" link directly to the access restrictions settings. The completion criteria have a link to the activity completion criteria section. !Screenshot_047.png|thumbnail! !Screenshot_048.png|thumbnail! Of course, in an ideal world, those links will open a modal with the settings in it so the user can edit them from the course page. However, this is out of scope for 4.3. . Technical shaping All quickform elements have a unique id, so it should be possible to focus directly on a specific element. The only problem is when the field is inside a collapsed form section. This could be done in pure JS but can result in a glitchy effect. It will be better if PHP considers the anchor when rendering the form. Another point to consider is that it will be super useful if, instead of an anchor, the param could be a filter that hides the rest of the fields except the submitted ones and the related sections. I know what you are thinking, this requires tweaking the ancient quickform classes and I am not Indiana Jones. But, hey, this is why we have a feasibility task and not a direct implementation one ;).
21.summary: Move the current activity plugin activity card information integration to the bottom of the card.
description: Activity plugins can implement their own afterlink feature to render arbitrary HTML into the activity card on the course page. This information is currently renderer just after the activity name. However, The new activity card design proposed for 4.3 moves that information below the general activity information. This gives more space for the activity name and the course format icons and separates that arbitrary content from the activity card title. Furthermore, this allows plugins to return complex HTML structures without fearing breaking the activity card structure. This issue is about moving the information at the bottom of the activity card to match the prototype. !Screenshot_046.png|thumbnail! Extra information: a new badge integration will be implemented in to allow plugins to add text after the activity name. Limiting the content to basic text.
22.summary: Create new details select dropdowns component needed for the new activity cards
description: This issue is conditioned to the result of the task. The new activity card proposed for 4.3 uses new interactable icons to replace the previous togglers. For example, in Moodle 3.9 clicking the group icon toggles the activity group mode without providing any description of the available options and without warning the user that the action will change the behaviour of the activity. The new component will be used to convert some of those icons into a dropdown like element. However, instead of a regular action menu, the new dropdown will be able to display custom icons and descriptions for the available potions. This issue is ab out creating this generic component in core. !Screenshot_054.png|thumbnail!
23.summary: Create new details dropdown components for the new activity cards design
description: This issue is conditioned to the result of the task. The new activity card proposed for 4.3 uses two new interactable components to display information inside a dropdown. Those two components are: Dropdown dialog: a new generic component will be create to display a dropdown like element that could present rich text HTML inside. This component will be used to display the completion conditions inside a dropdown. !Screenshot_055.png|thumbnail! Dropdown status: an extension of the previous one but providing a list of status to choose from. Those will let the user select the activity availability (visible, hidden, stealth) and the group mode (no groups, separate and visible groups). !Screenshot_054.png|thumbnail! In this issue, both generic components will be created. . Technical shaping The dropdown status component will be used to convert some of those icons into a dropdown-like element. However, instead of a regular action menu, the new dropdown must be able to display custom icons and descriptions for the available potions. This feature is similar to the modal used in bulk editing and related to . We dont have any output class to define this user interaction. For example, when we change a dropdown menu to a navigation dropdown, both represent the same interaction but use different construct parameters (we lose maintainability). To avoid this problem, part of this issue will create a generic output user choice class that can be used as an interaction definition object. In the future, the same class could instantiate for modals or any other user choice needed.
24.summary: Add details dropdown to completion criteria badge
description: The new activity card design for 4.3 uses a new dropdown component to present the completion criteria of an activity. The UI will be based on the component created in . The content will present the completion conditions, the manual completion if available, and, in future issues, a link to edit the completion criteria (if the teacher is in edit mode). Example of a teacher in edit mode: !Screenshot_055.png|thumbnail! Note: depending on the implementation, this issue can include .
25.summary: Improve activity card styling including rounded corners, background colour, less padding, activity name tooltip for teachers
description: Implement the new proposed activity cards styles to match the prototype. This include the smaller padding, the background color, the radius of the card and any possible border color. !Captura de pantalla 2023-05-18 a las 10.07.59.png|thumbnail! This issue does not include the availability dropdown (with chevron) and the group mode icon because they will be done in a separate issue. Ui style +Card border+ Color: Secondary/Gray-300 (Default) Content/Primary (Hover, Selected) Stroke: 1px Rounded borders: 16px +Card fill+ Color: Secondary/White (Default) Secondary/Gray-100 (Hidden, Stealth) Content/Primary-light (Hover, Selected) +Card margins+ 16px (Left, right, top and bottom margins) +Card height+ 64px (Min-height) +Text+ Activity title: Content/Copy File extension: Secondary/Gray-700 Dates: Secondary/Gray-700 Description: Content/Copy File info: Secondary/Gray-700 +Availability badge+ Text: Content/Copy Badge background: Secondary/Gray-300 +Restrictions+ Text: Content/Copy (Icon and Restrictions text), Content/Primary (Show more/less button) Container background: Secondary/Gray-200 Container rounded borders: 16px
26.summary: Replace the add activity between activities adhoc CSS classes by generic helpers
description: Starting from version 4.1, an additional "+" icon is displayed between activities, but only when the activity card is currently in focus. That was the first time a vanishing element is implemented on the course page and it was done using ad-hoc CSS rules (.content .section .activity:focus-within div.divider button). However, in 4.3, new elements like the group icon () will have the same logic and replicating CSS rules per each element is not an option anymore. The task concludes the best technical approach for a generic CSS rule is to create a set of 2 generic CSS rules: focus-control: for the parent element that needs to be focused. v-parent-focus: for the vanishing element that needs to be hidden unless the focus-control parent has a focus within In this issue, the current "+" icon CSS classes will be replaced by the generic helpers and the ad-hoc CSS will be removed.
27.summary: Add completion quickform direct link button to completion details dropdown
description: This issue depends on the results of task. In the new activity card design the completion badge has a direct link to edit the completion settings of an activity inside the dropdown added in . !image-2023-08-01-13-11-25-552.png!
28.summary: Review the UI and CSS of the activity project prototype
description: This is issue is about reviewing the UI and CSS of the implemented activity card project changes to match the prototype| Fix paddings/margin on restrictions block when displaying "Edit settings" button Fix activity action menu size to 32x32 Re-style the "+" button in "Add activity or resource" to rounded to match the prototype Add "Completion"/"To do" button hover styling Fix action menu and groupmode hover styling (bgcolor and radius) Fix inplaceeditable icon and activity badge position to show them inline with the activity name Fix section availability styles to be consistent with activity availability Fix "Add section" spacing and styles, adding "+" icon too
29.summary: Add group mode option to activity actions submenu
description: incorporate group mode editing from the course page. In the past, the group icon was a group-mode toggler. However, this behaviour has many UX problems as it is unexpected for many users. This issue will add a new "group mode" link to the activity action menu. This issue depends on the results of . If the submenu is technically possible, clicking the group mode will open the submenu with all available options. Otherwise, clicking the group mode will open a radio modal (using the component created in ). This is the aspect of the submenu if this option is feasible: !Screenshot_059.png|thumbnail! This issue depends on for the submenu classes and for the group mode status select output.
30.summary: Define Completion dropdown component in the course page for empty conditions
description: Reviewing we realized there are some activities (e.g. Database activity) that allow the teacher to set Completion tracking to Show activity as complete when conditions are met but dont mark any of the requirements, so the completion conditions are empty. This would be probably fixed in . But even fixing that bug and not allowing teachers to do it never again, some existing activities could face this problem, so we should decide from UX and PX perspective what to show to teachers and students in empty completion criteria use cases. !image-2023-07-06-13-24-29-704.png|width=477,height=224!!image-2023-07-06-13-24-58-496.png|width=271,height=89! ---- Designs +Teachers+ !Teachers.png|thumbnail! +Students+ !Students.png|thumbnail!
31.summary: Improve accessiblity of keyboard control for the generic dropdowns
description: During the review f , some accessiiblity improvement has been detected for the generic dropdown components created in . I quote the original text: Id like to note the following accessibility issues that I noticed related to the interactive dropdown component: Id expect the dropdown menu items to follow the menu pattern| especially in terms of keyboard interaction. Or perhaps at least for the choices to follow the Radio group pattern| The menu buttons focus indicator uses the browsers default focus indicator. This means that the focus indicator will look different across browsers and we may fail the WCAG Level AA Success Criterion 2.4.7 (Focus Visible)| if the browsers default focus indicator does not meet this requirement. The menu items are also using the browsers default focus indicator. This issue is a bout fixing those points.
|
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.0 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. 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: Typo3 library removal
description: At the moment we use Typo3 version 4.7.19 on core, mostly for charset and encoding stuff, see lib/classes/text.php. However that version is out of support and would be expensive move our code to use the latest version. The Typo jumped from 4.7.20 version to 6.X version and there were lots of structural changes and lots of legacy code of the 4.X version that got refactored. The goal of this issue is to verify the possibility of replace our Typo3 library by PHP iconv functions. A bit of history about this Typo 4.7 to 6.0 version jump:
2.summary: Move from deprecated babel/polyfill to new corejs/stable and regenerator-runtime
description: Commented @ : quote Im just a bit concerned about whether we should still be using when its already been deprecated in favour of directly including "core-js/stable" and "regenerator-runtime/runtime". quote Source: As far as that may involve changes about how stuff is included... and its out from the update issue linked above, this issue has been created to decide if we should follow the move.
3.summary: Use Bootstrap icons as the default icon map
description: Since FontAwesome has updated it licenses after version 4.7.6 to a commercial license it can not be updated in Moodle anymore. The Bootstrap icons provide a good MIT licensed alternative
4.summary: Upgrade lib\minify to latest version
description: MatthiasMullie\Minify (/lib/minify/matthiasmullie-minify/) 1.3.63 --> 1.3.66 :
5.summary: Upgrade JQuery and JQuery UI to latest version
description: jQuery (/lib/jquery/) 3.5.1 --> 3.6.0 jQuery UI (/lib/jquery/ui-X.YY.Z) 1.12.1 --> 1.13.0
6.summary: Upgrade SCSSPHP to latest version
description: scssphp (/lib/scssphp/) 1.4.1 --> 1.10.0 :
7.summary: Upgrade Box::Spout to latest version
description: Spout (/lib/spout/) 3.1.0 --> 3.3.0:
8.summary: Upgrade MaxMind DB reader to latest version
description: MaxMind DB Reader API (/lib/maxmind/MaxMind/) 11.9.0 --> 1.10.1 :
9.summary: Upgrade WebRTC to latest version
description: WebRTC adapter (/lib/amd/src/adapter.js) 7.4.0 --> 8.0.0:
10.summary: Upgrade Geopattern-PHP to latest version
description: Generate tiling SVG patterns from a string (/lib/geopattern-php/) 1.1.1 --> 1.1.2 :
11.summary: Upgrade VideoJS to latest version
description: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.10.0 --> 7.11.8 : VideoJS support files (/media/player/videojs/videojs/) 7.10.0 --> 7.11.8 : In , it was upgraded to 7.10.0 because there were some issues from 7.10.1 with MPEG-DASH. So this is something to check when upgrading it to the latest (to see if these problems have been fixed)
12.summary: Upgrade boost to use Bootstrap latest version
description: Twitter Bootstrap (/theme/boost/scss/bootstrap/) & friends 4.6.0 --> 5.0.1:
13.summary: Upgrade FPDI to 2.3.6
description: FPDI (/mod/assign/feedback/editpdf/fpdi/) 2.3.5 --> 2.3.6 :
14.summary: Upgrade CodeMirror to latest version
description: codemirror (/lib/editor/atto/plugins/html/yui/src/codemirror/) 5.59.4 --> 5.65.0 :
15.summary: Upgrade jsbeautify to latest version
description: jsbeautify (/lib/editor/atto/plugins/html/yui/src/beautify/) 1.13.0 --> 1.14.0 :
16.summary: Upgrade PHPSpreadsheet to latest version
description: PhpSpreadsheet (/lib/phpspreadsheet/) 1.16.0 --> 1.21.0 :
17.summary: Upgrade emoji-data to latest version
description: emoji-data (/lib/emoji-data) 6.0.0 --> 7.0.2 :
18.summary: Upgrade php-enum to 1.8.3
description: php-enum (/lib/php-enum) 1.7.7 --> 1.8.3 :
19.summary: Upgrade axe-core to latest version
description: axe-core (lib/behat/axe) 3.5.5 --> 4.3.5 :
20.summary: Add Flexitour to thirdpartylibs.xml
description: While reviewing the libraries to upgrade for 4.0 I realised Flexitour appears as a third-party library on the docs page ( ) but it hasnt any reference in thirdpartylibs.xml. We should remove it from the docs page or add it to the thirdpartylibs.xml.
21.summary: Upgrade XHProf to 2.3.5
description: XHProf (/lib/xhprof/) 2.2.3 --> 2.3.5 :
22.summary: Upgrade phpCAS to latest version
description: CAS (/auth/cas/CAS/) 1.3.8 --> 1.4.0 :
23.summary: Upgrade ADODB to latest version (5.21.4)
description: AdoDB (/lib/adodb/) 5.21.0 --> 5.21.4:
24.summary: Upgrade PHP-JWT to latest version
description: A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519 (/lib/php-jwt/) 5.2.0 --> 6.0.0 :
25.summary: Normalize readme_moodle.txt flavours
description: Right now there are various readme_moodle.txt variants in codebase: code $ find . -iname readme_moodle. -or -iname moodle_readme. ./repository/s3/README_MOODLE.txt ./cache/stores/mongodb/readme_moodle.txt ./auth/cas/CAS/moodle_readme.txt ./admin/tool/componentlibrary/moodle_readme.txt ./admin/tool/policy/readme_moodle.txt ./enrol/lti/ims-blti/moodle_readme.txt ./theme/boost/scss/fontawesome/readme_moodle.txt ./theme/boost/readme_moodle.txt ./lib/minify/readme_moodle.txt ./lib/plist/readme_moodle.txt ./lib/tcpdf/readme_moodle.txt ./lib/tcpdf/fonts/readme_moodle.txt ./lib/spout/readme_moodle.txt ./lib/pear/README_MOODLE.txt ./lib/phpspreadsheet/readme_moodle.txt ./lib/evalmath/readme_moodle.txt ./lib/geopattern-php/moodle_readme.txt ./lib/phpmailer/README_MOODLE.txt ./lib/adodb/readme_moodle.txt ./lib/mlbackend/php/phpml/readme_moodle.txt ./lib/xhprof/readme_moodle.txt ./lib/simplepie/readme_moodle.txt ./lib/emoji-data/readme_moodle.txt ./lib/yuilib/readme_moodle.txt ./lib/php-jwt/readme_moodle.txt ./lib/html2text/readme_moodle.txt ./lib/markdown/readme_moodle.txt ./lib/google/readme_moodle.txt ./lib/jquery/readme_moodle.txt ./lib/horde/readme_moodle.txt ./lib/php-enum/readme_moodle.txt ./lib/requirejs/readme_moodle.txt ./lib/maxmind/readme_moodle.txt ./lib/bennu/readme_moodle.txt ./lib/behat/extension/readme_moodle.txt ./lib/mustache/readme_moodle.txt ./lib/ ./lib/rtlcss/moodle_readme.txt ./lib/scssphp/moodle_readme.txt ./lib/htmlpurifier/readme_moodle.txt ./lib/polyfills/readme_moodle.txt ./lib/ltiprovider/readme_moodle.txt ./lib/editor/tinymce/plugins/pdw/readme_moodle.txt ./lib/editor/tinymce/plugins/spellchecker/readme_moodle.txt ./lib/editor/tinymce/readme_moodle.txt ./lib/editor/atto/plugins/html/yui/src/codemirror/readme_moodle.txt ./lib/editor/atto/plugins/html/yui/src/beautify/readme_moodle.txt ./lib/editor/atto/readme_moodle.txt ./lib/php-css-parser/moodle_readme.txt ./lib/zipstream/readme_moodle.txt ./filter/tex/readme_moodle.txt ./filter/mathjaxloader/readme_moodle.txt ./p/plib/v124/joubel/core/readme_moodle.txt ./p/plib/v124/joubel/editor/readme_moodle.txt ./mod/scorm/tests/packages/readme_moodle.txt ./mod/assign/feedback/editpdf/fpdi/readme_moodle.txt ./media/player/videojs/ogvjs/readme_moodle.txt ./media/player/videojs/readme_moodle.txt code This issue is about to: - Normalize all them to lowercase readme_moodle.txt - Fix any occurrence of moodle_readme.txt also @ Pretty simple issue, lets kill all the alternative ones (moodle_readme.txt, README_MOODLE.txt...). Ciao :-)
26.summary: Upgrade PHP-ML to 0.9.0
description: PHP-ML (/lib/mlbackend/php/phpml/) 0.8.0 --> 0.9.0 :
| 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.0 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. 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: Typo3 library removal
description: At the moment we use Typo3 version 4.7.19 on core, mostly for charset and encoding stuff, see lib/classes/text.php. However that version is out of support and would be expensive move our code to use the latest version. The Typo jumped from 4.7.20 version to 6.X version and there were lots of structural changes and lots of legacy code of the 4.X version that got refactored. The goal of this issue is to verify the possibility of replace our Typo3 library by PHP iconv functions. A bit of history about this Typo 4.7 to 6.0 version jump:
2.summary: Move from deprecated babel/polyfill to new corejs/stable and regenerator-runtime
description: Commented @ : quote Im just a bit concerned about whether we should still be using when its already been deprecated in favour of directly including "core-js/stable" and "regenerator-runtime/runtime". quote Source: As far as that may involve changes about how stuff is included... and its out from the update issue linked above, this issue has been created to decide if we should follow the move.
3.summary: Use Bootstrap icons as the default icon map
description: Since FontAwesome has updated it licenses after version 4.7.6 to a commercial license it can not be updated in Moodle anymore. The Bootstrap icons provide a good MIT licensed alternative
4.summary: Upgrade lib\minify to latest version
description: MatthiasMullie\Minify (/lib/minify/matthiasmullie-minify/) 1.3.63 --> 1.3.66 :
5.summary: Upgrade JQuery and JQuery UI to latest version
description: jQuery (/lib/jquery/) 3.5.1 --> 3.6.0 jQuery UI (/lib/jquery/ui-X.YY.Z) 1.12.1 --> 1.13.0
6.summary: Upgrade SCSSPHP to latest version
description: scssphp (/lib/scssphp/) 1.4.1 --> 1.10.0 :
7.summary: Upgrade Box::Spout to latest version
description: Spout (/lib/spout/) 3.1.0 --> 3.3.0:
8.summary: Upgrade MaxMind DB reader to latest version
description: MaxMind DB Reader API (/lib/maxmind/MaxMind/) 11.9.0 --> 1.10.1 :
9.summary: Upgrade WebRTC to latest version
description: WebRTC adapter (/lib/amd/src/adapter.js) 7.4.0 --> 8.0.0:
10.summary: Upgrade Geopattern-PHP to latest version
description: Generate tiling SVG patterns from a string (/lib/geopattern-php/) 1.1.1 --> 1.1.2 :
11.summary: Upgrade VideoJS to latest version
description: VideoJS (/media/player/videojs/amd/src/video-lazy.js) 7.10.0 --> 7.11.8 : VideoJS support files (/media/player/videojs/videojs/) 7.10.0 --> 7.11.8 : In , it was upgraded to 7.10.0 because there were some issues from 7.10.1 with MPEG-DASH. So this is something to check when upgrading it to the latest (to see if these problems have been fixed)
12.summary: Upgrade boost to use Bootstrap latest version
description: Twitter Bootstrap (/theme/boost/scss/bootstrap/) & friends 4.6.0 --> 5.0.1:
13.summary: Upgrade FPDI to 2.3.6
description: FPDI (/mod/assign/feedback/editpdf/fpdi/) 2.3.5 --> 2.3.6 :
14.summary: Upgrade CodeMirror to latest version
description: codemirror (/lib/editor/atto/plugins/html/yui/src/codemirror/) 5.59.4 --> 5.65.0 :
15.summary: Upgrade jsbeautify to latest version
description: jsbeautify (/lib/editor/atto/plugins/html/yui/src/beautify/) 1.13.0 --> 1.14.0 :
16.summary: Upgrade PHPSpreadsheet to latest version
description: PhpSpreadsheet (/lib/phpspreadsheet/) 1.16.0 --> 1.21.0 :
17.summary: Upgrade emoji-data to latest version
description: emoji-data (/lib/emoji-data) 6.0.0 --> 7.0.2 :
18.summary: Upgrade php-enum to 1.8.3
description: php-enum (/lib/php-enum) 1.7.7 --> 1.8.3 :
19.summary: Upgrade axe-core to latest version
description: axe-core (lib/behat/axe) 3.5.5 --> 4.3.5 :
20.summary: Add Flexitour to thirdpartylibs.xml
description: While reviewing the libraries to upgrade for 4.0 I realised Flexitour appears as a third-party library on the docs page ( ) but it hasnt any reference in thirdpartylibs.xml. We should remove it from the docs page or add it to the thirdpartylibs.xml.
21.summary: Upgrade XHProf to 2.3.5
description: XHProf (/lib/xhprof/) 2.2.3 --> 2.3.5 :
22.summary: Upgrade phpCAS to latest version
description: CAS (/auth/cas/CAS/) 1.3.8 --> 1.4.0 :
23.summary: Upgrade ADODB to latest version (5.21.4)
description: AdoDB (/lib/adodb/) 5.21.0 --> 5.21.4:
24.summary: Upgrade PHP-JWT to latest version
description: A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519 (/lib/php-jwt/) 5.2.0 --> 6.0.0 :
25.summary: Normalize readme_moodle.txt flavours
description: Right now there are various readme_moodle.txt variants in codebase: code $ find . -iname readme_moodle. -or -iname moodle_readme. ./repository/s3/README_MOODLE.txt ./cache/stores/mongodb/readme_moodle.txt ./auth/cas/CAS/moodle_readme.txt ./admin/tool/componentlibrary/moodle_readme.txt ./admin/tool/policy/readme_moodle.txt ./enrol/lti/ims-blti/moodle_readme.txt ./theme/boost/scss/fontawesome/readme_moodle.txt ./theme/boost/readme_moodle.txt ./lib/minify/readme_moodle.txt ./lib/plist/readme_moodle.txt ./lib/tcpdf/readme_moodle.txt ./lib/tcpdf/fonts/readme_moodle.txt ./lib/spout/readme_moodle.txt ./lib/pear/README_MOODLE.txt ./lib/phpspreadsheet/readme_moodle.txt ./lib/evalmath/readme_moodle.txt ./lib/geopattern-php/moodle_readme.txt ./lib/phpmailer/README_MOODLE.txt ./lib/adodb/readme_moodle.txt ./lib/mlbackend/php/phpml/readme_moodle.txt ./lib/xhprof/readme_moodle.txt ./lib/simplepie/readme_moodle.txt ./lib/emoji-data/readme_moodle.txt ./lib/yuilib/readme_moodle.txt ./lib/php-jwt/readme_moodle.txt ./lib/html2text/readme_moodle.txt ./lib/markdown/readme_moodle.txt ./lib/google/readme_moodle.txt ./lib/jquery/readme_moodle.txt ./lib/horde/readme_moodle.txt ./lib/php-enum/readme_moodle.txt ./lib/requirejs/readme_moodle.txt ./lib/maxmind/readme_moodle.txt ./lib/bennu/readme_moodle.txt ./lib/behat/extension/readme_moodle.txt ./lib/mustache/readme_moodle.txt ./lib/ ./lib/rtlcss/moodle_readme.txt ./lib/scssphp/moodle_readme.txt ./lib/htmlpurifier/readme_moodle.txt ./lib/polyfills/readme_moodle.txt ./lib/ltiprovider/readme_moodle.txt ./lib/editor/tinymce/plugins/pdw/readme_moodle.txt ./lib/editor/tinymce/plugins/spellchecker/readme_moodle.txt ./lib/editor/tinymce/readme_moodle.txt ./lib/editor/atto/plugins/html/yui/src/codemirror/readme_moodle.txt ./lib/editor/atto/plugins/html/yui/src/beautify/readme_moodle.txt ./lib/editor/atto/readme_moodle.txt ./lib/php-css-parser/moodle_readme.txt ./lib/zipstream/readme_moodle.txt ./filter/tex/readme_moodle.txt ./filter/mathjaxloader/readme_moodle.txt ./p/plib/v124/joubel/core/readme_moodle.txt ./p/plib/v124/joubel/editor/readme_moodle.txt ./mod/scorm/tests/packages/readme_moodle.txt ./mod/assign/feedback/editpdf/fpdi/readme_moodle.txt ./media/player/videojs/ogvjs/readme_moodle.txt ./media/player/videojs/readme_moodle.txt code This issue is about to: - Normalize all them to lowercase readme_moodle.txt - Fix any occurrence of moodle_readme.txt also @ Pretty simple issue, lets kill all the alternative ones (moodle_readme.txt, README_MOODLE.txt...). Ciao :-)
26.summary: Upgrade PHP-ML to 0.9.0
description: PHP-ML (/lib/mlbackend/php/phpml/) 0.8.0 --> 0.9.0 :
|
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: Accessibility accreditation 4.x
description: WCAG 2.1 AA accreditation for version 4.x
| Unsolvable | 1.summary: Accessibility improvements 4.2.0
description: Elements that are not downloadable in the "Course downloads" page should include an aria-label indicating that are "Not downloadable". In the text editor, we should change the accessible names of the heading buttons to include the level (H3, H4, etc.). In the text editor, we should provide some keyboard shortcuts to trigger special formatting (bold, italic, etc.).
2.summary: Accessibility improvements 4.1.0
description: Moodle App 4.0 accessibility review related tasks Fields in consideration: Level A Criteria: Pointer Cancellation: Ensure interactive elements are trigged on the up-event when the trigger of a pointer is released. 7 issues Keyboard: Provide keyboard only access to all areas. 6 issues Info and relationships: Headings should be programmatically defined. 3 issues Alternative text: Add descriptive alt text for informative images and apply null alt text to decorative images so they can be ignored by screen reader users Ensure all UI elements and icons have names. 2 issues Focus Order: Reorder focus order so it is logical and meaningful. 1 issue Label in Name: Ensure the words and characters in the visible label of a control match or are contained within the accessible name. 1 issue Level AA Criteria Resize Text: Amend text cut off, overflow when zoomed to 200. 13 issues iOS does not provide a correct zoom support. (iOSs Dynamic Type). When zoom is high: Collapsible header overflows and overlaps other content (See One approach to digital literacy screenshot). Contrast (Minimum): Amend text colours to meet contrast requirements. 4 issues Focus visible: Amend focus state so that it is visible for mouse and keyboard. 2 issues Orientation: Ensure the website or application supports both orientations by not restricting the orientation. 1 issue: The find site / enter URL on iOS is fixed and does not rotate.
| 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: Accessibility accreditation 4.x
description: WCAG 2.1 AA accreditation for version 4.x
### Response:
1.summary: Accessibility improvements 4.2.0
description: Elements that are not downloadable in the "Course downloads" page should include an aria-label indicating that are "Not downloadable". In the text editor, we should change the accessible names of the heading buttons to include the level (H3, H4, etc.). In the text editor, we should provide some keyboard shortcuts to trigger special formatting (bold, italic, etc.).
2.summary: Accessibility improvements 4.1.0
description: Moodle App 4.0 accessibility review related tasks Fields in consideration: Level A Criteria: Pointer Cancellation: Ensure interactive elements are trigged on the up-event when the trigger of a pointer is released. 7 issues Keyboard: Provide keyboard only access to all areas. 6 issues Info and relationships: Headings should be programmatically defined. 3 issues Alternative text: Add descriptive alt text for informative images and apply null alt text to decorative images so they can be ignored by screen reader users Ensure all UI elements and icons have names. 2 issues Focus Order: Reorder focus order so it is logical and meaningful. 1 issue Label in Name: Ensure the words and characters in the visible label of a control match or are contained within the accessible name. 1 issue Level AA Criteria Resize Text: Amend text cut off, overflow when zoomed to 200. 13 issues iOS does not provide a correct zoom support. (iOSs Dynamic Type). When zoom is high: Collapsible header overflows and overlaps other content (See One approach to digital literacy screenshot). Contrast (Minimum): Amend text colours to meet contrast requirements. 4 issues Focus visible: Amend focus state so that it is visible for mouse and keyboard. 2 issues Orientation: Ensure the website or application supports both orientations by not restricting the orientation. 1 issue: The find site / enter URL on iOS is fixed and does not rotate.
|
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 new feature requests for the Event monitor system
description: Please report new feature requests/improvements as separate issues and link with this epic
| Unsolvable | 1.summary: Event monitor: Implement a notification sent history report
description: Write a page to display a report of notifications sent
2.summary: Create an event for when a page is updated
description: As a teacher sharing a course with colleagues it would be nice to be notified when pages are updated. It is currently impossible with Event Monitor because course_module_update is a course-level event and subscribing to it on the module-level is impossible
3.summary: Event monitoring rules: missing aspects from teacher view
description: Event monitoring rules are a great tool with lots of perspectives for future improvements. Here are some aspects teacher would like: Monitoring is based on absolute numbers of events during a time frame. Messages are send if the number has been reached. A teacher may be interested to get a notification if nobody or only a few of students did an activity. This is mostly a sign for inactivity and a teacher has to be active I.e. Less than 5 students did a quiz during last two days. Make it easier to define time frames. Add hours and days for defining tresholds. I.e. more than 10 assignment submissions during 1 day. There are small and huge courses in Moodle systems. The absolute number of events is significant only in relation of the number of students often. Idea: Less than 20 of students/More than 70 of enrolled students did something during last three days..
4.summary: Event monitor: Allow to filter by relateduser=currentuser
description: Allow to restrict sending notifications only if relateduser is the currentuser Example of the request:
| 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 new feature requests for the Event monitor system
description: Please report new feature requests/improvements as separate issues and link with this epic
### Response:
1.summary: Event monitor: Implement a notification sent history report
description: Write a page to display a report of notifications sent
2.summary: Create an event for when a page is updated
description: As a teacher sharing a course with colleagues it would be nice to be notified when pages are updated. It is currently impossible with Event Monitor because course_module_update is a course-level event and subscribing to it on the module-level is impossible
3.summary: Event monitoring rules: missing aspects from teacher view
description: Event monitoring rules are a great tool with lots of perspectives for future improvements. Here are some aspects teacher would like: Monitoring is based on absolute numbers of events during a time frame. Messages are send if the number has been reached. A teacher may be interested to get a notification if nobody or only a few of students did an activity. This is mostly a sign for inactivity and a teacher has to be active I.e. Less than 5 students did a quiz during last two days. Make it easier to define time frames. Add hours and days for defining tresholds. I.e. more than 10 assignment submissions during 1 day. There are small and huge courses in Moodle systems. The absolute number of events is significant only in relation of the number of students often. Idea: Less than 20 of students/More than 70 of enrolled students did something during last three days..
4.summary: Event monitor: Allow to filter by relateduser=currentuser
description: Allow to restrict sending notifications only if relateduser is the currentuser Example of the request:
|
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 csslint with stylelint and better control
description: is a modern CSS linter which shared a lot of commonality with eslint. Its got a growing community with Wordpress| Facebook| Wikimedia| and GitHub| adopting it. Nice overview of stylelint and why you would want to do it: This issue is about defining rules and linting from grunt. We can do this for plain css and less now, but it is flexible to support scss or whatever comes next too.
| Unsolvable | 1.summary: Incorrect indentation in less files
description: As part of Ive discovered a number of less files which are incorrectly indented in places. This should be make consistent: code Running "postcss:bootstrapbase" (postcss) task >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:29:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:31:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:30:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:68:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:89:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:93:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:292:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:293:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1211:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1213:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1212:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1214:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1216:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1215:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1305:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1306:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1823:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2431:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2432:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2456:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2457:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2460:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:100:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:101:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:107:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:112:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:108:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:109:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:110:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:111:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:114:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:117:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:115:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:116:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:861:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:862:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:944:14: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1095:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1124:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1250:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1295:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1324:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1325:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1326:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:78:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:79:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:80:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:81:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:82:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:83:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:84:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:87:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:88:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:89:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:90:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:91:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:92:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:93:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:94:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:95:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:96:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:97:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:98:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:78:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1237:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1245:12: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1259:17: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/forms.less:383:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/forms.less:486:1: Expected no more than 2 empty line(s) (max-empty-lines) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/grade.less:454:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/message.less:277:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:137:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:294:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:302:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:303:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:82:2: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:296:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:297:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:298:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:313:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:317:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:321:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:138:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:211:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:217:11: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:260:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:242:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:249:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:243:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:244:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:245:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:246:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:247:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:248:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:250:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:345:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:347:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:346:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:348:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:350:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:349:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:353:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:355:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:354:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:359:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:362:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:363:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:364:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:365:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:366:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:383:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:392:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:393:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:439:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:666:1: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:667:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:668:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:673:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:675:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:676:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:677:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:678:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:681:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:689:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:690:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:691:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:692:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:694:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:693:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:695:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:696:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:698:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:697:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:699:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:702:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:700:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:701:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:703:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:704:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:706:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:705:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:707:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:708:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:715:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:709:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:710:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:711:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:712:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:713:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:714:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:729:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:732:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:730:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:731:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:733:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:735:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:734:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:736:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:738:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:737:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:827:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:829:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:828:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:5:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:6:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:21:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:7:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:20:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:8:7: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:19:7: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:9:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:15:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:10:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:11:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:13:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:16:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:18:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:17:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:26:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:30:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:31:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:33:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:32:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:37:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:38:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:42:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:43:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:47:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:48:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:12:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:13:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:14:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:15:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:16:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:17:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:18:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:19:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:20:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:23:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:24:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:59:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:60:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:75:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:76:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:82:3: Expected indentation of 4 spaces (indentation) >> 28 stylesheets processed, no files written. code
2.summary: Remove the browser hacks from our .less
description: code >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:40:5: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:40:5: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1032:9: Unexpected duplicate "display" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1375:13: Unexpected shorthand "margin" after "margin-left" (declaration-block-no-shorthand-property-overrides) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:81:5: Unexpected duplicate "max-height" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:85:5: Unexpected duplicate "max-height" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:222:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:777:13: Unexpected duplicate "margin-left" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:222:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:777:13: Unexpected property hack "margin-left" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:21: Unexpected duplicate "margin-left" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:21: Unexpected duplicate "margin-right" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:21: Unexpected property hack "margin-left" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:21: Unexpected property hack "margin-right" (no-browser-hacks) code
3.summary: Fix lint errors in less which actually change css. (part 2)
description: Over in the changes made to less files have been purely cosmetic, not making a difference to the generated css. In this issue we will fix the errors and test them.
4.summary: Add stylelint config and make less compliant with CS (part 1)
description: Stage one of adding stylelint, is getting the basics in place and keeping our less files linted Add stylelint config matching css coding style Add stylelint checking to grunt Ensure less files pass lint before building Fix all the stylistic lint errors in less (which dont impact on actual built css, the ones which affect the css will be fixed in )
5.summary: Lint all plain CSS, match coding style and be lint-free
description: We can sort out the plain .css files and have them linted (at least for errors)
6.summary: extremely qualified selectors in assignment css
description: Our CSS guidelines say that selectors should not be overqualified Apply this patch: code diff --git a/mod/assign/styles.css b/mod/assign/styles.css index cdbadb2..d37cb93 100644 --- a/mod/assign/styles.css +++ b/mod/assign/styles.css -1,5 +1,3 -/ stylelint-disable max-line-length / -/ FIXME: : remove this stylelint disable / .path-mod-assign div.gradingnavigation div float: left; code Run grunt css code >> mod/assign/styles.css >> 692:74 Expected line length to be no more than 132 characters max-line-length >> 888:86 Expected line length to be no more than 132 characters max-line-length >> 899:82 Expected line length to be no more than 132 characters max-line-length >> 936:77 Expected line length to be no more than 132 characters max-line-length >> 937:76 Expected line length to be no more than 132 characters max-line-length >> Linted 956 files without errors code Look at the CSS: code .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_ftext .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_f .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_feditor .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_fgrading .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_ffilemanager .felement padding: 6px 10px 10px; box-sizing: border-box; code code .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.popout .felement .gradingform_rubric overflow: visible; code And it becomes clear weve might be a little overqualified there
7.summary: Remove csslint config
description: stylelint is the modern alternative:
| 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 csslint with stylelint and better control
description: is a modern CSS linter which shared a lot of commonality with eslint. Its got a growing community with Wordpress| Facebook| Wikimedia| and GitHub| adopting it. Nice overview of stylelint and why you would want to do it: This issue is about defining rules and linting from grunt. We can do this for plain css and less now, but it is flexible to support scss or whatever comes next too.
### Response:
1.summary: Incorrect indentation in less files
description: As part of Ive discovered a number of less files which are incorrectly indented in places. This should be make consistent: code Running "postcss:bootstrapbase" (postcss) task >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:29:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:31:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:30:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:68:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:89:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:93:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:292:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:293:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1211:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1213:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1212:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1214:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1216:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1215:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1305:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1306:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:1823:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2431:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2432:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2456:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2457:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/core.less:2460:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:100:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:101:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:107:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:112:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:108:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:109:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:110:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:111:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:114:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:117:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:115:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:116:9: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:861:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:862:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:944:14: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1095:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1124:15: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1250:19: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1295:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1324:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1325:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1326:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:78:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:79:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:80:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:81:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:82:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:83:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:84:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:87:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:88:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:89:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:90:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:91:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:92:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:93:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:94:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:95:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:96:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:97:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/expendable.less:98:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:78:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1237:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1245:12: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/filemanager.less:1259:17: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/forms.less:383:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/forms.less:486:1: Expected no more than 2 empty line(s) (max-empty-lines) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/grade.less:454:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/message.less:277:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:137:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:294:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:302:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/modules.less:303:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:82:2: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:296:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:297:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:298:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:313:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:317:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:321:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:138:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:211:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:217:11: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:260:2: Expected indentation of 0 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:242:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:249:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:243:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:244:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:245:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:246:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:247:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:248:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:250:6: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:345:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:347:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:346:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:348:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:350:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:349:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:353:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:355:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:354:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:359:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:362:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:363:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:364:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:365:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:366:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:383:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:392:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:393:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:439:10: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:666:1: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:667:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:668:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:673:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:675:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:676:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:677:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:678:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:681:11: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:689:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:690:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:691:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:692:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:694:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:693:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:695:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:696:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:698:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:697:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:699:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:702:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:700:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:701:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:703:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:704:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:706:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:705:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:707:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:708:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:715:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:709:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:710:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:711:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:712:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:713:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:714:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:729:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:732:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:730:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:731:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:733:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:735:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:734:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:736:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:738:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:737:7: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:827:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:829:4: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:828:8: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:5:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:6:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:21:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:7:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:20:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:8:7: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:19:7: Expected indentation of 12 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:9:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:15:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:10:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:11:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:13:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:16:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:18:9: Expected indentation of 16 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:17:11: Expected indentation of 20 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:26:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:30:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:31:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:33:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:32:5: Expected indentation of 8 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:37:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:38:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:42:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:43:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:47:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:48:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:12:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:13:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:14:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:15:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:16:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:17:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:18:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:19:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:20:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:23:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:24:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:59:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:60:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:75:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:76:3: Expected indentation of 4 spaces (indentation) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/undo.less:82:3: Expected indentation of 4 spaces (indentation) >> 28 stylesheets processed, no files written. code
2.summary: Remove the browser hacks from our .less
description: code >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:40:5: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/bootstrapoverride.less:40:5: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1032:9: Unexpected duplicate "display" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/course.less:1375:13: Unexpected shorthand "margin" after "margin-left" (declaration-block-no-shorthand-property-overrides) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:81:5: Unexpected duplicate "max-height" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/question.less:85:5: Unexpected duplicate "max-height" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:222:9: Unexpected duplicate "width" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:777:13: Unexpected duplicate "margin-left" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:137:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:210:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:222:9: Unexpected property hack "width" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/responsive.less:777:13: Unexpected property hack "margin-left" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:21: Unexpected duplicate "margin-left" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:21: Unexpected duplicate "margin-right" (declaration-block-no-duplicate-properties) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:12:21: Unexpected property hack "margin-left" (no-browser-hacks) >> stylelint: /Users/danp/moodles/pm/moodle/theme/bootstrapbase/less/moodle/templates.less:14:21: Unexpected property hack "margin-right" (no-browser-hacks) code
3.summary: Fix lint errors in less which actually change css. (part 2)
description: Over in the changes made to less files have been purely cosmetic, not making a difference to the generated css. In this issue we will fix the errors and test them.
4.summary: Add stylelint config and make less compliant with CS (part 1)
description: Stage one of adding stylelint, is getting the basics in place and keeping our less files linted Add stylelint config matching css coding style Add stylelint checking to grunt Ensure less files pass lint before building Fix all the stylistic lint errors in less (which dont impact on actual built css, the ones which affect the css will be fixed in )
5.summary: Lint all plain CSS, match coding style and be lint-free
description: We can sort out the plain .css files and have them linted (at least for errors)
6.summary: extremely qualified selectors in assignment css
description: Our CSS guidelines say that selectors should not be overqualified Apply this patch: code diff --git a/mod/assign/styles.css b/mod/assign/styles.css index cdbadb2..d37cb93 100644 --- a/mod/assign/styles.css +++ b/mod/assign/styles.css -1,5 +1,3 -/ stylelint-disable max-line-length / -/ FIXME: : remove this stylelint disable / .path-mod-assign div.gradingnavigation div float: left; code Run grunt css code >> mod/assign/styles.css >> 692:74 Expected line length to be no more than 132 characters max-line-length >> 888:86 Expected line length to be no more than 132 characters max-line-length >> 899:82 Expected line length to be no more than 132 characters max-line-length >> 936:77 Expected line length to be no more than 132 characters max-line-length >> 937:76 Expected line length to be no more than 132 characters max-line-length >> Linted 956 files without errors code Look at the CSS: code .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_ftext .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_f .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_feditor .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_fgrading .felement, .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.fitem_ffilemanager .felement padding: 6px 10px 10px; box-sizing: border-box; code code .path-mod-assign page-content data-region="grade-panel" .mform:not(.unresponsive) .fcontainer .fitem.popout .felement .gradingform_rubric overflow: visible; code And it becomes clear weve might be a little overqualified there
7.summary: Remove csslint config
description: stylelint is the modern alternative:
|
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 course activity editing for Moodle 4.2
description: This epic contains all the related issues for implementing the bulk course activity editing. All of the issues belongs to the following groups: Ux designs for the future bulk activity editing Clean up the technical debts from the <3.11 course editor (which is not bulk editing compatible) Implement the bulk activity editing in the 4.0+ course editor. MVP Prototype| Project documentation|
| Unsolvable | 1.summary: Bulk edit activities in course view page
description: Introduce the possibility for a multiple selection of course activities at the course view page for trainers/course creators. If any activities are selected the user is able to hide/show duplicate delete move (to somewhere else in the course) the selected elements at once. Linked issue:
2.summary: Course editor: Migrate highlight/unhighlight topics to new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Highlight section This feature is used only in the topics format. Since Moodle 3.11 this feature was half implemented in the core and half in the topics format creating some inconsistencies. When this issue is integrated, all the highlight logic will be moved to the topics format plugin. Only the most internal methods will remain in the code implementation. This change has the extra benefit of having a good example of how to extend the current course editor features within a plugin. Theres a proof of concept of the highlight option migrated entirely to the topics format:
3.summary: Course editor: Migrate duplicate activity course tools to the new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with the new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Duplicate activity
4.summary: Course editor: Migrate delete activity course tools to the new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with the new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Delete activity
5.summary: Course editor: migrate Drag and drop files into the course/course-index to the new editor
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content However, the file drag and drop is handled by the ancient course/dndupload.js which does not follow the current coding style and it is not even minimized. In this issue, a new drag and drop library will be implemented if the course format is compatible with components. The new library will be compatible part of the current reactive library so it can be reused in the future in other parts of the system. Another important part of the new drag and drop will be the implementation of a reactive upload monitor which will provide a visualization of the uploading process. Theres a proof of concept of the code in this commit:
6.summary: Design the bulk edit activities in the course page
description: Introduce the possibility for a multiple selection of course activities at the course view page for trainers/course creators. If any activities are selected the user is able to hide/show duplicate delete move (to somewhere else in the course) the selected elements at once. . color:172b4dLinked issuecolor
7.summary: Course editor: replace activity and section refresh webservices for fragment methods
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). One of the major dependencies of the new reactive library is that it still rely on the old actions to refresh an activity or a section. This issue will implement proper fragment methods to get both activity and section HTML and JS without using the old YUI methods. Theres a proof of concept of the highlight option migrated entirely to the topics format:
8.summary: Course bulk edit: The basic bulk section and activity selection UI, no actions yet
description: Adapt the current course editor UI to allow bulk section and activity selection. All bulk actions will be implemented in future issues. However, this issue will cover the following: Enable/disable bulk editing (showing checkboxes in the activities and sections) The activity and section checkbox logic: when bulk editing is enabled, all checkboxes are enabled, however, when a user selects an element (section or activity) they can only select the same type. The sticky footer appears when bulk editing is enabled and disappears when bulk editing is disabled. The sticky footer will also: Have a counter of the selected elements A button to unselect everything selected A button to close the bulk editing (yet to confirm) If necessary, this issue may implement one simple action to test what happens when an action is performed. the current bulk edition designs may vary once the prototype is finished. However, the general flow will remain almost the same as described below: 1) A new "bulk edition" will appear on the course header: !MDL-76783_001.png|thumbnail! 2) A sticky footer and select checkboxes will appear once the user clicks the bulk editing. Closing that sticky footer will disable the bulk editing. !MDL-76783_002.png|thumbnail! 3) Once the user selects some kind of element (activity or section), only the same elements checkboxes will be visible. The available actions will be different depending on the type of element selected. !MDL-76783_003.png|thumbnail! 4) If an action is clicked, all elements will be unselected, and the user can select either sections or activities again.
9.summary: Course bulk edit: add bulk delete action
description: As part of the course, bulk editing teachers should be able to delete both sections and activities in batches. The workflow is similar to the individual deletion: The teacher activate bulk edition Select some activities or sections click on the delete button in the bulk toolbar for activities or sections with content, the action will prompt a confirmation modal (UX writing is still pending) The sections or activities are deleted.
10.summary: Course bulk edit: add bulk section move
description: As part of the course bulk editing, users should be able to select multiple sections and open a model for moving them into a different course position. This issue will require to adapt the current move section modal to work with bulk selection.
11.summary: Course bulk edit: add bulk duplicate activity action
description: As part of the bulk course edit project, teachers should be able to duplicate activities in batches. The bulk duplicate will work exactly as the standard bulk, creating a new activity just below the original one.
12.summary: Course bulk edit: add bulk availability edit action
description: As part of the bulk course editing, teachers should be able to set sections and activities availability. The current options for sections are: Visible/Available: the section is displayed in the course. Hidden/not available: the section is not displayed in the course The current options for activities are: Visible/available: the activity is ready for students and displayed in the course Stealth/available but hidden: the activity is ready for students but it is not displayed in the course (but students can access if they have the direct URL) Hidden/not available: the activity is not ready for students, meaning they are not displayed in the course and the student cannot access them even if they have the direct URL. Those are the currently proposed modals (UX writing is still pending): !MDL-76783_008.png|thumbnail! !MDL-76783_007.png|thumbnail!
13.summary: Course bulk edit: add bulk activity move action
description: One of the actions required for bulk editing is the move activity. This issue will require adapting the current move modal to work with the bulk edition.
14.summary: Course bulk edit: match the visual style with the prototype
description: Since was implemented before the final prototype was published some visual elements do not match the current prototype aesthetics. However, the UX and workflow implemented in is consistent with the prototype so this issue is mainly about tweaking the visual elements. Prototype instructions: Figma prototype: Some detected differences: With long course names, the bulk editing button line breaks. The bulk button buttons have some cibot complains about the HTML structure. Review strings bulkeditoff and bulkcancel (they look like duplicates) Disabled sticky footer buttons should not be focusable Section availability bulk action title should depend on the format section label (weeks, topics) Even if English does not require a plural string for the selected items count. The string should be different when more than one element is selected.
15.summary: Course bulk edit: add fast selections to the bulk editing
description: Even if covers all the basic section and activities selections. There are some advanced features that can improve the selection UX by adding more advanced ways to select. Some of the proposed improvements are: Save the last selected item so doing shif+click on another section/activity can select all in-between elements also. This is quite common in many list selections UIs Shift+Alt+click on a section/cm switches to the sections selection and vice-versa. This will be a quick way to switch between activities and section selection. Alt+click on an activity can select or unselect all activities in that section with a single click. Alt+click on a section selects or unselect all sections
| 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 course activity editing for Moodle 4.2
description: This epic contains all the related issues for implementing the bulk course activity editing. All of the issues belongs to the following groups: Ux designs for the future bulk activity editing Clean up the technical debts from the <3.11 course editor (which is not bulk editing compatible) Implement the bulk activity editing in the 4.0+ course editor. MVP Prototype| Project documentation|
### Response:
1.summary: Bulk edit activities in course view page
description: Introduce the possibility for a multiple selection of course activities at the course view page for trainers/course creators. If any activities are selected the user is able to hide/show duplicate delete move (to somewhere else in the course) the selected elements at once. Linked issue:
2.summary: Course editor: Migrate highlight/unhighlight topics to new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Highlight section This feature is used only in the topics format. Since Moodle 3.11 this feature was half implemented in the core and half in the topics format creating some inconsistencies. When this issue is integrated, all the highlight logic will be moved to the topics format plugin. Only the most internal methods will remain in the code implementation. This change has the extra benefit of having a good example of how to extend the current course editor features within a plugin. Theres a proof of concept of the highlight option migrated entirely to the topics format:
3.summary: Course editor: Migrate duplicate activity course tools to the new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with the new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Duplicate activity
4.summary: Course editor: Migrate delete activity course tools to the new reactive actions.
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with the new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). In this issue the visibility tools will be migrated to the new module: Delete activity
5.summary: Course editor: migrate Drag and drop files into the course/course-index to the new editor
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content However, the file drag and drop is handled by the ancient course/dndupload.js which does not follow the current coding style and it is not even minimized. In this issue, a new drag and drop library will be implemented if the course format is compatible with components. The new library will be compatible part of the current reactive library so it can be reused in the future in other parts of the system. Another important part of the new drag and drop will be the implementation of a reactive upload monitor which will provide a visualization of the uploading process. Theres a proof of concept of the code in this commit:
6.summary: Design the bulk edit activities in the course page
description: Introduce the possibility for a multiple selection of course activities at the course view page for trainers/course creators. If any activities are selected the user is able to hide/show duplicate delete move (to somewhere else in the course) the selected elements at once. . color:172b4dLinked issuecolor
7.summary: Course editor: replace activity and section refresh webservices for fragment methods
description: Since Moodle 4.0 the course editor frontend part uses two main modules to handle the edition tools: core_course/actions: responsible for handling all non-reactive tools and the legacy formats core_courseformat/courseeditor: the new reactive library that updates the course index and the course content Since the reactive implementation starts, the final goal is to replace all legacy actions with new ones as soon as possible. The most complex ones like moving elements, deleting, and creating sections are already migrated and others like indent are just deprecated (or leave it to third-party plugins). One of the major dependencies of the new reactive library is that it still rely on the old actions to refresh an activity or a section. This issue will implement proper fragment methods to get both activity and section HTML and JS without using the old YUI methods. Theres a proof of concept of the highlight option migrated entirely to the topics format:
8.summary: Course bulk edit: The basic bulk section and activity selection UI, no actions yet
description: Adapt the current course editor UI to allow bulk section and activity selection. All bulk actions will be implemented in future issues. However, this issue will cover the following: Enable/disable bulk editing (showing checkboxes in the activities and sections) The activity and section checkbox logic: when bulk editing is enabled, all checkboxes are enabled, however, when a user selects an element (section or activity) they can only select the same type. The sticky footer appears when bulk editing is enabled and disappears when bulk editing is disabled. The sticky footer will also: Have a counter of the selected elements A button to unselect everything selected A button to close the bulk editing (yet to confirm) If necessary, this issue may implement one simple action to test what happens when an action is performed. the current bulk edition designs may vary once the prototype is finished. However, the general flow will remain almost the same as described below: 1) A new "bulk edition" will appear on the course header: !MDL-76783_001.png|thumbnail! 2) A sticky footer and select checkboxes will appear once the user clicks the bulk editing. Closing that sticky footer will disable the bulk editing. !MDL-76783_002.png|thumbnail! 3) Once the user selects some kind of element (activity or section), only the same elements checkboxes will be visible. The available actions will be different depending on the type of element selected. !MDL-76783_003.png|thumbnail! 4) If an action is clicked, all elements will be unselected, and the user can select either sections or activities again.
9.summary: Course bulk edit: add bulk delete action
description: As part of the course, bulk editing teachers should be able to delete both sections and activities in batches. The workflow is similar to the individual deletion: The teacher activate bulk edition Select some activities or sections click on the delete button in the bulk toolbar for activities or sections with content, the action will prompt a confirmation modal (UX writing is still pending) The sections or activities are deleted.
10.summary: Course bulk edit: add bulk section move
description: As part of the course bulk editing, users should be able to select multiple sections and open a model for moving them into a different course position. This issue will require to adapt the current move section modal to work with bulk selection.
11.summary: Course bulk edit: add bulk duplicate activity action
description: As part of the bulk course edit project, teachers should be able to duplicate activities in batches. The bulk duplicate will work exactly as the standard bulk, creating a new activity just below the original one.
12.summary: Course bulk edit: add bulk availability edit action
description: As part of the bulk course editing, teachers should be able to set sections and activities availability. The current options for sections are: Visible/Available: the section is displayed in the course. Hidden/not available: the section is not displayed in the course The current options for activities are: Visible/available: the activity is ready for students and displayed in the course Stealth/available but hidden: the activity is ready for students but it is not displayed in the course (but students can access if they have the direct URL) Hidden/not available: the activity is not ready for students, meaning they are not displayed in the course and the student cannot access them even if they have the direct URL. Those are the currently proposed modals (UX writing is still pending): !MDL-76783_008.png|thumbnail! !MDL-76783_007.png|thumbnail!
13.summary: Course bulk edit: add bulk activity move action
description: One of the actions required for bulk editing is the move activity. This issue will require adapting the current move modal to work with the bulk edition.
14.summary: Course bulk edit: match the visual style with the prototype
description: Since was implemented before the final prototype was published some visual elements do not match the current prototype aesthetics. However, the UX and workflow implemented in is consistent with the prototype so this issue is mainly about tweaking the visual elements. Prototype instructions: Figma prototype: Some detected differences: With long course names, the bulk editing button line breaks. The bulk button buttons have some cibot complains about the HTML structure. Review strings bulkeditoff and bulkcancel (they look like duplicates) Disabled sticky footer buttons should not be focusable Section availability bulk action title should depend on the format section label (weeks, topics) Even if English does not require a plural string for the selected items count. The string should be different when more than one element is selected.
15.summary: Course bulk edit: add fast selections to the bulk editing
description: Even if covers all the basic section and activities selections. There are some advanced features that can improve the selection UX by adding more advanced ways to select. Some of the proposed improvements are: Save the last selected item so doing shif+click on another section/activity can select all in-between elements also. This is quite common in many list selections UIs Shift+Alt+click on a section/cm switches to the sections selection and vice-versa. This will be a quick way to switch between activities and section selection. Alt+click on an activity can select or unselect all activities in that section with a single click. Alt+click on a section selects or unselect all sections
|
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: Improved Safe Exam Browser integration
description: This issue is here to track project "Improved Safe Exam Browser integration" mentioned in the roadmap: User stories are to be found here: SEB Specs for config keys
| Unsolvable | 1.summary: Add Safe Exam Browser integration to the standard Moodle package (moodle-quizaccess_seb)
description: Integration work for Safe Exam Browser plugin ( ) to Moodle core
2.summary: Revise QA issues if/when SEB Win client is updated
description: This is an issue relating to quizaccess_seb only. Currently, there are two MDLQA tests ( and ) which either have to be completed on the Mac client (14121), or have aspects which must be completed on the mac client (14123). The use of the Mac client here is a little bit of a workaround because the windows client doesnt support certain features yet. Version 2.4 did apparently, but since we now require 3.0.0Beta, we cant test in Windows. Whats not supported at the time of writing this is: - disable quitting SEB. No matter what we set in Moodle, users can quit SEB. - show/hide the reload icon in SEB. I cant see a reload icon, even when the "Browser toolbar" is enabled via SEB config tool first and saved as a client setting. If and when the Win client supports these features, this issue is about retesting the Mac portion of these 2 QAs and updating accordingly to say which parts of them can be completed with which client. Ideally, this would work with either client.
| 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: Improved Safe Exam Browser integration
description: This issue is here to track project "Improved Safe Exam Browser integration" mentioned in the roadmap: User stories are to be found here: SEB Specs for config keys
### Response:
1.summary: Add Safe Exam Browser integration to the standard Moodle package (moodle-quizaccess_seb)
description: Integration work for Safe Exam Browser plugin ( ) to Moodle core
2.summary: Revise QA issues if/when SEB Win client is updated
description: This is an issue relating to quizaccess_seb only. Currently, there are two MDLQA tests ( and ) which either have to be completed on the Mac client (14121), or have aspects which must be completed on the mac client (14123). The use of the Mac client here is a little bit of a workaround because the windows client doesnt support certain features yet. Version 2.4 did apparently, but since we now require 3.0.0Beta, we cant test in Windows. Whats not supported at the time of writing this is: - disable quitting SEB. No matter what we set in Moodle, users can quit SEB. - show/hide the reload icon in SEB. I cant see a reload icon, even when the "Browser toolbar" is enabled via SEB config tool first and saved as a client setting. If and when the Win client supports these features, this issue is about retesting the Mac portion of these 2 QAs and updating accordingly to say which parts of them can be completed with which client. Ideally, this would work with either client.
|
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 2015
description:
| Unsolvable | 1.summary: Upgrade learn.moodle.net to 2.8.x
description: Even though this site is archived.. the justification for doing this would be: We can re-examine any core hacks and make sure they are all upstreamed The site is ready for if we decide to run another Learn Moodle MOOC
2.summary: Update Learn Moodle front page content
description: Text on the front page of can currently be updated via the language customisation feature, editing strings in theme_learnmoodle.php. The text in the hero banner can be changed by editing text-tagline-head and text-tagline-text. I dont think it is necessary to switch between a 4-column and a 3-column layout - lets just stick with 3 columns, that we have now. Thus the text in the 3 columns plus text above can be changed by editing text-mooc2013intro. The text in the orange button can be changed by editing text-gotocourse. 2 months prior to the MOOC, the orange button should be removed.
3.summary: Delete all previous sandbox courses
description: All courses in
4.summary: Course requests should be automatically approved
description: Standard Moodle behaviour is that course requests require approval (by a user with the moodle/site:approvecourse capability). Based on previous experience, we think that it will be OK for course requests to be automatically approved.
5.summary: Make the user menu show on learn.moodle.net
description: We should try and keep learn.moodle.net fairly standard-looking, thus it would be good to have a user menu as on sites using the default clean theme.
6.summary: Set up Learn Moodle Participant and Completer 2015 badges
description:
7.summary: Make block_partners work properly without local_moodleorg
description: For the time being, ive hacked it so it doesnt have the depdency. My basic plan is the block to work without the requiring the other plugin being installed: Webservice in local_moodleorg that remote sites can query periodically to get adverts Remove use of local_moodleorg table use, only use plugin things
8.summary: Blocks should be dockable with the Learn Moodle theme
description: Im asking the question, rather than making a specific request. I suppose it depends on how difficult a hack it is to make the blocks dockable in the short time we have. When we first ran the MOOC, the Clean theme did not allow for blocks to be docked - now it does and its the norm and other responsive themes follow suit. However, it is something that could be explained (by me in the MOOC) if we decide to leave the theme as it is, so Im happy for this to be closed if felt appropriate. Asking poltawski since he knows everything about everything.
9.summary: Amend Learn Moodle social media links
description: Social media links on the front page of should be: (currently goes to Moodle) (no change) (no change) (currently points to HQ) (to be added, image as on moodle.org) i.e. the same as in the moodle.org footer with the exception of Twitter.
10.summary: Fix hard coded http links in Learn Moodle theme
description: Learn Moodle is now thanks to Matt :-) However, as reported by Matt: bq. error messages show that there are some hard linked fonts referring to http instead of
11.summary: Sharing on social image needs to be found and changed
description: As reported by Sam: bq. When I share the link in Facebook/Linkedin/Google, an image automatically appears. This same image would appear for anyone sharing the link. Barbara suggested that it was something that Apu and XY worked on together, so wasnt able to help in this instance. Do you know where that image is in the site? In wordpress this is called the Feature Image and can be easily changed. The image (as shown in attached screenshots) includes the dates of the previous MOOC, so it needs to be changed for an image not showing any dates.
12.summary: Review learn.moodle.net for mobile access
description:
13.summary: Learn Moodle theme doesnt display new gradebook as expected
description: The horizontal and vertical scrolling on the gradebook with the original Learn Moodle theme do not appear to be present. I would imagine we would wish to highlight the cool features of the 2.8 gradebook. I know there have been some tracker issues relating to this absence of scrolling in other themes so perhaps its not too difficult a fix? Pinging andyjdavis and poltawski for wise advice
14.summary: How best to offer videos for Learn Moodle MOOC?
description: Currently the Learn Moodle site has 33 short videos on youtube embedded into Moodle books. Weve considered alternative provision for mobile devices here - but this issue concerns whether we should offer all the videos for download as well, since in some countries, YouTube is banned. My question is: if we offer the videos for download, what is the best way for desktop and mobile access? And the best file type and size for download? (Currently they are .mp4 and varied sizes)
15.summary: Learn Moodle font set needs changing
description: As reported by mudrd8mz: learn.moodle.net seems to contain the old font set that does not contain non-English chars. We fixed it for moodle.org. see the "Log in" button in fallback font here on moodle.org, we use Adding that to additionalhtmlhead might fix the issue but it would change the overall font a bit, too.
16.summary: Sync the Learn Moodle production site with next
description:
17.summary: Update the front page banner title
description: It currently says "Our next course begins on 11th January 2015." Well - its started now..
| 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 2015
description:
### Response:
1.summary: Upgrade learn.moodle.net to 2.8.x
description: Even though this site is archived.. the justification for doing this would be: We can re-examine any core hacks and make sure they are all upstreamed The site is ready for if we decide to run another Learn Moodle MOOC
2.summary: Update Learn Moodle front page content
description: Text on the front page of can currently be updated via the language customisation feature, editing strings in theme_learnmoodle.php. The text in the hero banner can be changed by editing text-tagline-head and text-tagline-text. I dont think it is necessary to switch between a 4-column and a 3-column layout - lets just stick with 3 columns, that we have now. Thus the text in the 3 columns plus text above can be changed by editing text-mooc2013intro. The text in the orange button can be changed by editing text-gotocourse. 2 months prior to the MOOC, the orange button should be removed.
3.summary: Delete all previous sandbox courses
description: All courses in
4.summary: Course requests should be automatically approved
description: Standard Moodle behaviour is that course requests require approval (by a user with the moodle/site:approvecourse capability). Based on previous experience, we think that it will be OK for course requests to be automatically approved.
5.summary: Make the user menu show on learn.moodle.net
description: We should try and keep learn.moodle.net fairly standard-looking, thus it would be good to have a user menu as on sites using the default clean theme.
6.summary: Set up Learn Moodle Participant and Completer 2015 badges
description:
7.summary: Make block_partners work properly without local_moodleorg
description: For the time being, ive hacked it so it doesnt have the depdency. My basic plan is the block to work without the requiring the other plugin being installed: Webservice in local_moodleorg that remote sites can query periodically to get adverts Remove use of local_moodleorg table use, only use plugin things
8.summary: Blocks should be dockable with the Learn Moodle theme
description: Im asking the question, rather than making a specific request. I suppose it depends on how difficult a hack it is to make the blocks dockable in the short time we have. When we first ran the MOOC, the Clean theme did not allow for blocks to be docked - now it does and its the norm and other responsive themes follow suit. However, it is something that could be explained (by me in the MOOC) if we decide to leave the theme as it is, so Im happy for this to be closed if felt appropriate. Asking poltawski since he knows everything about everything.
9.summary: Amend Learn Moodle social media links
description: Social media links on the front page of should be: (currently goes to Moodle) (no change) (no change) (currently points to HQ) (to be added, image as on moodle.org) i.e. the same as in the moodle.org footer with the exception of Twitter.
10.summary: Fix hard coded http links in Learn Moodle theme
description: Learn Moodle is now thanks to Matt :-) However, as reported by Matt: bq. error messages show that there are some hard linked fonts referring to http instead of
11.summary: Sharing on social image needs to be found and changed
description: As reported by Sam: bq. When I share the link in Facebook/Linkedin/Google, an image automatically appears. This same image would appear for anyone sharing the link. Barbara suggested that it was something that Apu and XY worked on together, so wasnt able to help in this instance. Do you know where that image is in the site? In wordpress this is called the Feature Image and can be easily changed. The image (as shown in attached screenshots) includes the dates of the previous MOOC, so it needs to be changed for an image not showing any dates.
12.summary: Review learn.moodle.net for mobile access
description:
13.summary: Learn Moodle theme doesnt display new gradebook as expected
description: The horizontal and vertical scrolling on the gradebook with the original Learn Moodle theme do not appear to be present. I would imagine we would wish to highlight the cool features of the 2.8 gradebook. I know there have been some tracker issues relating to this absence of scrolling in other themes so perhaps its not too difficult a fix? Pinging andyjdavis and poltawski for wise advice
14.summary: How best to offer videos for Learn Moodle MOOC?
description: Currently the Learn Moodle site has 33 short videos on youtube embedded into Moodle books. Weve considered alternative provision for mobile devices here - but this issue concerns whether we should offer all the videos for download as well, since in some countries, YouTube is banned. My question is: if we offer the videos for download, what is the best way for desktop and mobile access? And the best file type and size for download? (Currently they are .mp4 and varied sizes)
15.summary: Learn Moodle font set needs changing
description: As reported by mudrd8mz: learn.moodle.net seems to contain the old font set that does not contain non-English chars. We fixed it for moodle.org. see the "Log in" button in fallback font here on moodle.org, we use Adding that to additionalhtmlhead might fix the issue but it would change the overall font a bit, too.
16.summary: Sync the Learn Moodle production site with next
description:
17.summary: Update the front page banner title
description: It currently says "Our next course begins on 11th January 2015." Well - its started now..
|
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: Demo sites reboot
description: Create demo sites index page Add black sites bar to school and sandbox sites Fix any urgent demo sites issues
| Unsolvable | 1.summary: Create demo sites index page
description: Create a page demo.moodle.org listing the 3 demo sites with brief descriptions. demo.moodle.net school.demo.moodle.net qa.moodle.net
2.summary: Add black sites bar to demo sites
description: Black sites bar should have thin grey line underneath. uses Clean theme uses Arialist theme but this could be changed if necessary is awaiting fix
3.summary: Sandbox site to have new URL
description: The URL for the sandbox site should be changed to to match then demo.moodle.net can be used for the demo sites index page.
4.summary: Use a little custom css to change the appearance of the school demo site
description: Currently all the demo sites use the clean theme. It would be good to make the school demo site look a bit different (as a school might do) by adding some custom css via the UI (Administration > Site administration > Appearance > Themes > Clean). The custom css should be small and simple e.g. changing colours as it will only be for a short time, since hopefully more clean customization settings are coming in Moodle 2.7 ().
5.summary: Prepare fresh install of QA testing site
description: As mentioned in bq. Prepare a fresh installation of the QA site based on the beta code to make sure the site is not affected by incremental upgrade steps during the development cycle. Procedure: Disable both the hourly and daily syncs Set up qamaster directly Reassign issue to marycooch to add courses and other content Mary to reassign issue when done, then both sync scripts can be re-enabled
6.summary: Demo sites index page should mention reset
description: Although each site mentions the hourly reset, the text may have been removed and other content inserted. Thus it would good for it to be mentioned on together with a disclaimer. Suggested text to be added: quoteEach demo site is reset to its blank state every hour, on the hour. Other people may be using the demo site at the same time as you; this can result in unexpected things happening. We cannot be held responsible for any content added to a demo site by other site users.quote
| 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: Demo sites reboot
description: Create demo sites index page Add black sites bar to school and sandbox sites Fix any urgent demo sites issues
### Response:
1.summary: Create demo sites index page
description: Create a page demo.moodle.org listing the 3 demo sites with brief descriptions. demo.moodle.net school.demo.moodle.net qa.moodle.net
2.summary: Add black sites bar to demo sites
description: Black sites bar should have thin grey line underneath. uses Clean theme uses Arialist theme but this could be changed if necessary is awaiting fix
3.summary: Sandbox site to have new URL
description: The URL for the sandbox site should be changed to to match then demo.moodle.net can be used for the demo sites index page.
4.summary: Use a little custom css to change the appearance of the school demo site
description: Currently all the demo sites use the clean theme. It would be good to make the school demo site look a bit different (as a school might do) by adding some custom css via the UI (Administration > Site administration > Appearance > Themes > Clean). The custom css should be small and simple e.g. changing colours as it will only be for a short time, since hopefully more clean customization settings are coming in Moodle 2.7 ().
5.summary: Prepare fresh install of QA testing site
description: As mentioned in bq. Prepare a fresh installation of the QA site based on the beta code to make sure the site is not affected by incremental upgrade steps during the development cycle. Procedure: Disable both the hourly and daily syncs Set up qamaster directly Reassign issue to marycooch to add courses and other content Mary to reassign issue when done, then both sync scripts can be re-enabled
6.summary: Demo sites index page should mention reset
description: Although each site mentions the hourly reset, the text may have been removed and other content inserted. Thus it would good for it to be mentioned on together with a disclaimer. Suggested text to be added: quoteEach demo site is reset to its blank state every hour, on the hour. Other people may be using the demo site at the same time as you; this can result in unexpected things happening. We cannot be held responsible for any content added to a demo site by other site users.quote
|
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 the ability to message a group of users
description: Having the ability to message multiple people at once in a group (not separate messages to all) is essential for a modern day messaging app.
| Unsolvable | 1.summary: Messaging: Audit message API to confirm level of support for group conversations
description: Background: Currently, message_send (in messagelib.php) and send_message (in lib/classes/message/manager.php) support 1:1 messaging. See: userto and userfrom used there. The table structure was re-worked to support group conversations (more than 2 users in a conversation - nothing to do with course groups here), but Im not sure if the APIs all support sending messages in conversations like this. Certainly the unit tests seem to only test 1:1 conversations. Im also not sure whether the conversation creation code supports groups of more than 2 members, or whether we can create a conversation without an initial message being sent (which well perhaps need so we can fetch conversation details for the initial UI load - depending how we end up doing that bit) Scope: Investigate message_send and send_message and check whether its possible to send messages to a conversation using existing APIs. Check also any other conversation creation code If the above is missing/incomplete: we will either need to update, or create new API allowing us to send a message to all members of a conversation. We may be better off creating a new API allowing us to do this by conversation as with groups of 3+ were not sending a message to a single user any more - needs investigation anyway. We should provide APIs to create conversations (collections of members), WITHOUT the need to send an initial message. We should add unit tests to message/tests/api_test.php to cover conversations with more than just 2 users to make sure everything works as expected. Create conversation (can we create a conversation without an initial message - this is important!) Send messages to conversaton Unread counts for all users in the conversation (message_unread table from memory)
2.summary: Make conversations favouritable
description: We should allow users to favourite their conversations so they are listed at the top.
3.summary: Use bootstrap classes to style the messaging interface
description: The messaging interface css, templates and js can be update to use more Bootstrap classes. This reduces the amount of css needed and allows the messaging interface to be styled using bootswatches.
4.summary: Make message contacts a two-way approval process
description: Currently you can add anyone as a contact. We should really have this a two-way process. This would really help as well with the issue where you cant message people who have the setting Prevent non-contacts from messaging me enabled. This would allow you to add the person as a contact and let them know you want to message them, they can of course approve/disapprove.
5.summary: Messaging: Add admin setting for toggling site-wide messaging
description: Add a new setting ($CFG->messagingallusers) to the existing message settings in advanced features. For new installations it should default to false; for existing instances, it will have the same value as $CFG.>messaging. This new privacy option will allow the users configure who can contact them. When $CFG->messagingallusers is enabled, a new option Anyone on this site will appear; otherwise, users will be able to decide only between Only my contacts or My contacts and anyone who shares a course with me.
6.summary: Add new messaging preferences per users allowing them to filter who can message them
description: Scope: We should allow users to choose who can message them, with a growing circle of contactability, if you will, with options for: my contacts only my contacts and anyone who shares a course with me anyone on the site (conditional) see blocker issue. This issue will also need to update any associated back end apis and webservices relating to message creation.
7.summary: Messaging: Add mark_all_conversation_messages_as_read support for group conversations
description: In has been identified that the mark_all_messages_as_read external function should be adapted to support group conversation (instead of just 1:1 personal messaging).
8.summary: Messaging: Update the message APIs allowing teachers to send 1:1 messages to students, regardless of their messaging prefs.
description: Scope: There should be a capability, given by default to the Teacher and Manager roles on install/upgrade, allowing them to bypass user privacy preferences for messaging Check message/classes/api.php for can_post_message() - should respect this cap Check lib/messagelib.php for message_send() - should respect this cap Other places?
9.summary: Messaging: Add get_conversation_members support for group conversations
description: In has been identified that the data_for_messagearea_get_profile external function should be adapted to support group conversation (instead of just 1:1 personal messaging). We should create a new get_conversation_members function for getting the participants lists of a given conversation. This function should also return, for each user, information like if is online or blocked by the current user.
10.summary: Messaging: Add delete_conversation/message support for group conversations
description: In has been identified that the delete_conversation external function should be adapted to support group conversation (instead of just 1:1 personal messaging).
11.summary: Messaging: Add/remove/count members to conversations
description: During the audit in , there have been identified some new functions to add, for supporting conversations between 3 or more users: add_members_to_conversation(userids, convid) remove_members_from_conversation(userids. convid) count_conversation_members(convid) We need to create these methods in the messaging API and add some phpunit tests for checking them. We also should add some extra testing scenarios for the existing methods create_conversation_between_users and get_conversation_between_users for covering conversations with 3 or more members.
12.summary: Messaging: Add get_messages support for group conversations
description: In Has been identified that some of the get_messages functions should be adapted to support group conversation (instead just 1:1 personal messaging).
13.summary: Messaging: Create web service and api for sending messages
description: This needs to be done.
14.summary: Extend member info with additional fields
description: We need 2 additional fields for the new UI: $member->canmessage $member->requirescontact Id suggest we add these to the output of the \core_message\helper::get_member_info() function, if theyre cheap enough, and adjust the get_conversation_member_structure() method in externallib.php to reflect this. Heres some code that Ryan was using to mock this data in the UI at present (for reference of the logic only, we dont want to add more DB hits or method calls if we can avoid it.) code:java $privacysetting = self::get_user_privacy_messaging_preference($otheruserid); $blocknoncontacts = $privacysetting = self::MESSAGE_PRIVACY_ONLYCONTACTS; $data->isblocked = self::is_blocked($userid, $otheruserid); $data->iscontact = self::is_contact($userid, $otheruserid); $data->canmessage = ($data->iscontact || !$blocknoncontacts) && !self::is_blocked($otheruserid, $userid); $data->contactrequests = $contactrequests; $data->requirescontact = $blocknoncontacts;code
15.summary: Create web service to get an individual conversation between users
description: Basically, we need a way to get the individual conversation between 2 users, so that when a users profile is clicked (from within a group conversation member listing, for example), we can call this to determine whether we have a conversation with that user or not. We already have the internal API, but we should expose this externally too.
16.summary: Messaging: Disable message outputs for group conversations
description: This sends one email per message - and needs work to switch over to generating summary emails, so for now, lets make sure this is disabled for group conversations with > 2 members. These email notifications should remain functional for the 1:1 conversations.
17.summary: Messaging: Updates to the search API
description: Scope: -This issue assumes the work in is complete so we have conversations linked to course groups (the ability to do so).- This issue can proceed without the group-linking work. Update the backend APIs for messaging search as follows (We ONLY want to update search_ functions - so things like search_contacts and search_messages. The get_ functions are different and should have been handled in ): Results should reflect the site-wide messaging admin setting . If site-wide is disabled, results restricted to only those users sharing courses with the current user. If site-wide is enabled, results show any users FOLLOW UP MDL: Limit users returned based on user visibility in the site/course. Users included, regardless of personal messaging privacy settings - this only comes into play when we want to initiate a conversation (or contact request) with someone - so we dont need to factor it in to search criteria, thankfully. Should be able to search for: Users who I dont have a conversation with (match users first / last name / any existing fields we match on already), returning user Names of users who I do have a conversation with (match users first / last name), returning messages the user sent Contents of messages in conversations Im a part of, returning messages When returning users, inclusion of relevant information about the person whether a contact or not (may already be present - need to check) When returning messages, Inclusion of relevant information relating to the message conversation details: course name (if applicable) - depending on how has been implemented, there may be a generic way to get relevant details of what a conversation has been linked to - check there first!! group name (if applicable) - depending on how has been implemented, there may be a generic way to get relevant details of what a conversation has been linked to - check there first!! -Is the conversation a favourite? (Blocked by for now)- We dont need to show this. Name of the user who created the message Message time -We need to allow filtering by conversation, to facilitate searching for messages within a conversation.- See for conversation searching. -We also need to create a new web service aggregating the above search methods into a single call which can be made by the front end.- Lets focus on getting the required information in the existing service first, before we worry about this. The current prototype UI works with the existing services, but just needs some additional information. Web service implementation should make considerations for lazy loading / batching. Deprecation of old search search APIs and web services, where no longer applicable. This issue has a wide scope, so may be better split into several smaller issues.
18.summary: Messaging: UI: Base version of new UI for 3.6
description: Scope: We should try to get this in with a basic set of features, allowing other feature-add MDLs to be based on this. If we can roughly cover most of the functionality we already have in messaging, then it will make it easier to land this one cleanly, replacing the existing messaging page at the same time, and hopefully leaving us with only a few follow ups to address missing functionality. Suggested in scopes (to keep this as simple as we can): On the main pane (after clicking the messaging icon in the page header) we should be able to view the following only: My contacts accordion Messages accordion (this lists 1:1 messages only) Search for users and messages from the main pane Initiate/participate in 1:1 conversations for users where their privacy settings allow this. Link to contact request page in order to make a contact request (for now. This feature will be added - see out of scopes below) Settings icon on main pane should just link to the existing messaging preferences page for now. Suggested out of scopes (meaning another MDL will add this feature): View group conversations accordion () View favourites accordion / favourite a conversation () Searching within a conversation () Message settings pane () Ability to block a user () Contact requests send/approve panes () Any other features.. UI Prototype:
19.summary: Messaging: Create get_conversations based on data_for_messagearea_conversations
description: In has been identified that the data_for_messagearea_conversations external function should be adapted to probably return the the message/classes/output/messagearea/conversation.php class instead of the current message/classes/output/messagearea/contacts.php. Probably the conversation class should also be reviewed to add the needed information to display in the UI (i.e. the mobile team would appreciate ).
20.summary: Messaging: UI: Add settings pane to new UI
description: Scope: Add the settings pane, but only the privacy controls at the top of the pane. The email notifications stuff will be a follow up MDL. See for the relevant settings options/web services (get_user_message_preferences() ? ) The settings will need to include the option for Anyone on the site, if site-wide messaging admin setting is enabled.
21.summary: Messaging: audit privacy api after table changes
description: Were adding columns and tables in this project, so check the provider and make sure were covering all relevant fields still. We also need to consider/check the new user preferences for messaging - added as part of . And finally, we need to export the conversations in the privacy export (now only private messages are exported). This will be done in
22.summary: Messaging: UI: Add group-based conversations support to new UI
description: Scope: Add group conversations accordion, which includes group-based conversations only (those conversations which were created based on a course group) the data_for_messagearea_conversations web service (or relevant service) should be returning relevant metadata about the conversations course/group, etc. Add group-based conversations support to search/results (again metadata from web service) The web service should already provide you with relevant conversation metadata for each message returned (see for details) Should be able to send/receive messages to/from the other group members within the conversation Ideally, wed (somehow) have a placeholder representing a group-based-conversations in the UI, when no messages have yet been sent. This just means we wont have created the conversation until we actually use it. Still need to work out if/how - will mention this on also - so check there too.
23.summary: Messaging: address conversations and favourite conversation in the privacy API
description: We need to work out how well present this now that we support group conversations. At the moment, its just a list of user which we have a 1:1 convo with, but this doesnt work with groups.
24.summary: Messaging: UI: Add the favouriting feature to the new UI
description: Scope: N.B. Web services facilitating this work will have been added to messaging in . Add the Favourites accordion Add the ability to favourite a conversation (star icon or ellipsis menu item - tbc by UX) Done within the conversation Add the ability to un-favourite a conversation (star icon or ellipsis menu item - tbc by UX) Done within the conversation
25.summary: Messaging: UI: Add the ability to block users in the new UI
description: Scope: Done via ellipsis menu in a 1:1 conversation only - out of scope for groups for now. UX to confirm designs for how to unblock a user.
26.summary: Messaging: UI: Add contact requests feature to the new UI
description: Scope: Web services should have been created as part of See prototype for screens. Dont forget to remove the stub page message/pendingcontactrequests.php
27.summary: Messaging: UI: Remove any legacy code leftovers
description: After this project is done there may be a lot of no longer used code, best to get rid of it. Eg. message/index.php related templates/JS.
28.summary: Messaging: Extend user search API to properly check user visibility in course/site
description: Scope: Assumes the search APIs have been updated - as per . When searching, and specifically when generating the User results (as opposed to Message results), we need to make sure we only return those users who are either: Contacts of the current user or; Are visible to the current user, either within his course (if site-wide messaging is disabled), or in a site (is site-wide messaging is enabled). Visibility may entail checking several capabilities, mainly those around viewing user names, or the ability to view course participants. Possibly identity fields, but hopefully not. This is key to maintaining a consistency with what users can see in other areas of the UI (in terms of user details), and with what details are returned in the messaging search results.
29.summary: Messaging: Unify get_messages and get_conversation_messages external functions
description: During , the get_conversation_messages method has been added to the message/externallib.php for adding support to conversation messages. For now, this method is based on the data_for_messagearea_messages, which is the one used from the UI. However, the message/externallib.php file contains also the get_messages method, which is quite similar. For this reason, we should add some extra parameters and logic to the get_conversation_messages method, for being able to deprecate also the get_messages method.
30.summary: Reimplement failing Behat tests
description: These scenarios were failing due to the changes in where a temporary page was created to confirm contact requests, so instead of editing them to go to a temporary page which would then need changing again when it is removed they were simply commented out.
31.summary: Add favourites subsystem to core
description: Needed for group messaging and course overview improvements projects, for starring conversations and courses, respectively. This should be fairly simple, in that we just want to allow components to mark items (essentially \string component, string itemtype, int itemid, int contextid) as favourite items for a specific user. This issue just deals with the subsystem. The usage in the respective projects will be issues attached to each epic and will come a bit later.
32.summary: Messaging: Create API for creating conversations
description: This needs to be done, yolo.
33.summary: Messaging: Allow creation of group conversations from the group edit page
description: Scope: Introduce an Add as conversation toggle on group edit form which creates group conversation (or flags group for future conversation creation via adhoc/scheduled tasks - this is up for discussion but as soon as possible would be the preference). Groups and their conversation must be linked somehow to facilitate synchronisation tasks (see ). Keep in mind we may very well have conversations which are NOT linked to groups, as well as conversations which may be linked to other things in Moodle - design should be flexible enough to accommodate these. The component, context, itemid idea perhaps seems reasonable as weve used this elsewhere. This issue should add to / extend the relevant non-search internal APIs (data_for_messagearea_conversations(), others?) and web services such that we include the required metadata about the conversation in any calls made to fetch it. This DOES NOT include search APIs - see for that. This data may include: Information about what the conversation is linked to (in as generic a way as possible) which, in our case, needs to include: Course name Group name Time of most recent message Unread count for the conversation Out of scope: Synchronisation of groups/group-conversations members (see for this)
34.summary: Messaging: Synchronise course group members with conversations members, for those groups having linked conversations.
description: Scope: This issue assumes : Groups can already be linked to conversations. This is about making sure we reflect any course group membership changes in the corresponding messaging group conversation, if present. It could be a task or an event listener perhaps - as long as we are able to handle cases like: course group updates via a web service updates via the browser, and any other expected means of changing group members.
35.summary: Messaging: Create web service and api for returning conversation members
description: This needs to be done, yolo.
36.summary: Messaging: Review can_post_message to use identifiers instead of user objects
description: The can_post_message function needs a $sender and a $recipient object but only the identifiers are really used inside. We should change this to save some possible previous DB queries.
37.summary: Web service for return conversation members does not confirm user is a member
description: Pretty much the WS will allow anyone to query any conversation they do not belong to and find out which members exist.
38.summary: Improve message_search_users queries from performance perspective
description: Current implementation for message_search_users() does a query within a query to get all messages for each conversation for each user. It will be good to improve this.
39.summary: The get_contact_requests API should make use of the get_member_info helper
description: This was written before the helper was introduced. Having one location define the return structure is much nicer. Also, if we wait for after release then we cant change the return structure due to third-parties using it.
40.summary: Add image url support to get_conversations()
description: This was something I forgot to add during work on . We need this so that we can support an image for any linked conversations. In future, this should be able to be set by the component area to which the group is linked, but for now, will just be hard coded to course groups, and their image url.
| 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 the ability to message a group of users
description: Having the ability to message multiple people at once in a group (not separate messages to all) is essential for a modern day messaging app.
### Response:
1.summary: Messaging: Audit message API to confirm level of support for group conversations
description: Background: Currently, message_send (in messagelib.php) and send_message (in lib/classes/message/manager.php) support 1:1 messaging. See: userto and userfrom used there. The table structure was re-worked to support group conversations (more than 2 users in a conversation - nothing to do with course groups here), but Im not sure if the APIs all support sending messages in conversations like this. Certainly the unit tests seem to only test 1:1 conversations. Im also not sure whether the conversation creation code supports groups of more than 2 members, or whether we can create a conversation without an initial message being sent (which well perhaps need so we can fetch conversation details for the initial UI load - depending how we end up doing that bit) Scope: Investigate message_send and send_message and check whether its possible to send messages to a conversation using existing APIs. Check also any other conversation creation code If the above is missing/incomplete: we will either need to update, or create new API allowing us to send a message to all members of a conversation. We may be better off creating a new API allowing us to do this by conversation as with groups of 3+ were not sending a message to a single user any more - needs investigation anyway. We should provide APIs to create conversations (collections of members), WITHOUT the need to send an initial message. We should add unit tests to message/tests/api_test.php to cover conversations with more than just 2 users to make sure everything works as expected. Create conversation (can we create a conversation without an initial message - this is important!) Send messages to conversaton Unread counts for all users in the conversation (message_unread table from memory)
2.summary: Make conversations favouritable
description: We should allow users to favourite their conversations so they are listed at the top.
3.summary: Use bootstrap classes to style the messaging interface
description: The messaging interface css, templates and js can be update to use more Bootstrap classes. This reduces the amount of css needed and allows the messaging interface to be styled using bootswatches.
4.summary: Make message contacts a two-way approval process
description: Currently you can add anyone as a contact. We should really have this a two-way process. This would really help as well with the issue where you cant message people who have the setting Prevent non-contacts from messaging me enabled. This would allow you to add the person as a contact and let them know you want to message them, they can of course approve/disapprove.
5.summary: Messaging: Add admin setting for toggling site-wide messaging
description: Add a new setting ($CFG->messagingallusers) to the existing message settings in advanced features. For new installations it should default to false; for existing instances, it will have the same value as $CFG.>messaging. This new privacy option will allow the users configure who can contact them. When $CFG->messagingallusers is enabled, a new option Anyone on this site will appear; otherwise, users will be able to decide only between Only my contacts or My contacts and anyone who shares a course with me.
6.summary: Add new messaging preferences per users allowing them to filter who can message them
description: Scope: We should allow users to choose who can message them, with a growing circle of contactability, if you will, with options for: my contacts only my contacts and anyone who shares a course with me anyone on the site (conditional) see blocker issue. This issue will also need to update any associated back end apis and webservices relating to message creation.
7.summary: Messaging: Add mark_all_conversation_messages_as_read support for group conversations
description: In has been identified that the mark_all_messages_as_read external function should be adapted to support group conversation (instead of just 1:1 personal messaging).
8.summary: Messaging: Update the message APIs allowing teachers to send 1:1 messages to students, regardless of their messaging prefs.
description: Scope: There should be a capability, given by default to the Teacher and Manager roles on install/upgrade, allowing them to bypass user privacy preferences for messaging Check message/classes/api.php for can_post_message() - should respect this cap Check lib/messagelib.php for message_send() - should respect this cap Other places?
9.summary: Messaging: Add get_conversation_members support for group conversations
description: In has been identified that the data_for_messagearea_get_profile external function should be adapted to support group conversation (instead of just 1:1 personal messaging). We should create a new get_conversation_members function for getting the participants lists of a given conversation. This function should also return, for each user, information like if is online or blocked by the current user.
10.summary: Messaging: Add delete_conversation/message support for group conversations
description: In has been identified that the delete_conversation external function should be adapted to support group conversation (instead of just 1:1 personal messaging).
11.summary: Messaging: Add/remove/count members to conversations
description: During the audit in , there have been identified some new functions to add, for supporting conversations between 3 or more users: add_members_to_conversation(userids, convid) remove_members_from_conversation(userids. convid) count_conversation_members(convid) We need to create these methods in the messaging API and add some phpunit tests for checking them. We also should add some extra testing scenarios for the existing methods create_conversation_between_users and get_conversation_between_users for covering conversations with 3 or more members.
12.summary: Messaging: Add get_messages support for group conversations
description: In Has been identified that some of the get_messages functions should be adapted to support group conversation (instead just 1:1 personal messaging).
13.summary: Messaging: Create web service and api for sending messages
description: This needs to be done.
14.summary: Extend member info with additional fields
description: We need 2 additional fields for the new UI: $member->canmessage $member->requirescontact Id suggest we add these to the output of the \core_message\helper::get_member_info() function, if theyre cheap enough, and adjust the get_conversation_member_structure() method in externallib.php to reflect this. Heres some code that Ryan was using to mock this data in the UI at present (for reference of the logic only, we dont want to add more DB hits or method calls if we can avoid it.) code:java $privacysetting = self::get_user_privacy_messaging_preference($otheruserid); $blocknoncontacts = $privacysetting = self::MESSAGE_PRIVACY_ONLYCONTACTS; $data->isblocked = self::is_blocked($userid, $otheruserid); $data->iscontact = self::is_contact($userid, $otheruserid); $data->canmessage = ($data->iscontact || !$blocknoncontacts) && !self::is_blocked($otheruserid, $userid); $data->contactrequests = $contactrequests; $data->requirescontact = $blocknoncontacts;code
15.summary: Create web service to get an individual conversation between users
description: Basically, we need a way to get the individual conversation between 2 users, so that when a users profile is clicked (from within a group conversation member listing, for example), we can call this to determine whether we have a conversation with that user or not. We already have the internal API, but we should expose this externally too.
16.summary: Messaging: Disable message outputs for group conversations
description: This sends one email per message - and needs work to switch over to generating summary emails, so for now, lets make sure this is disabled for group conversations with > 2 members. These email notifications should remain functional for the 1:1 conversations.
17.summary: Messaging: Updates to the search API
description: Scope: -This issue assumes the work in is complete so we have conversations linked to course groups (the ability to do so).- This issue can proceed without the group-linking work. Update the backend APIs for messaging search as follows (We ONLY want to update search_ functions - so things like search_contacts and search_messages. The get_ functions are different and should have been handled in ): Results should reflect the site-wide messaging admin setting . If site-wide is disabled, results restricted to only those users sharing courses with the current user. If site-wide is enabled, results show any users FOLLOW UP MDL: Limit users returned based on user visibility in the site/course. Users included, regardless of personal messaging privacy settings - this only comes into play when we want to initiate a conversation (or contact request) with someone - so we dont need to factor it in to search criteria, thankfully. Should be able to search for: Users who I dont have a conversation with (match users first / last name / any existing fields we match on already), returning user Names of users who I do have a conversation with (match users first / last name), returning messages the user sent Contents of messages in conversations Im a part of, returning messages When returning users, inclusion of relevant information about the person whether a contact or not (may already be present - need to check) When returning messages, Inclusion of relevant information relating to the message conversation details: course name (if applicable) - depending on how has been implemented, there may be a generic way to get relevant details of what a conversation has been linked to - check there first!! group name (if applicable) - depending on how has been implemented, there may be a generic way to get relevant details of what a conversation has been linked to - check there first!! -Is the conversation a favourite? (Blocked by for now)- We dont need to show this. Name of the user who created the message Message time -We need to allow filtering by conversation, to facilitate searching for messages within a conversation.- See for conversation searching. -We also need to create a new web service aggregating the above search methods into a single call which can be made by the front end.- Lets focus on getting the required information in the existing service first, before we worry about this. The current prototype UI works with the existing services, but just needs some additional information. Web service implementation should make considerations for lazy loading / batching. Deprecation of old search search APIs and web services, where no longer applicable. This issue has a wide scope, so may be better split into several smaller issues.
18.summary: Messaging: UI: Base version of new UI for 3.6
description: Scope: We should try to get this in with a basic set of features, allowing other feature-add MDLs to be based on this. If we can roughly cover most of the functionality we already have in messaging, then it will make it easier to land this one cleanly, replacing the existing messaging page at the same time, and hopefully leaving us with only a few follow ups to address missing functionality. Suggested in scopes (to keep this as simple as we can): On the main pane (after clicking the messaging icon in the page header) we should be able to view the following only: My contacts accordion Messages accordion (this lists 1:1 messages only) Search for users and messages from the main pane Initiate/participate in 1:1 conversations for users where their privacy settings allow this. Link to contact request page in order to make a contact request (for now. This feature will be added - see out of scopes below) Settings icon on main pane should just link to the existing messaging preferences page for now. Suggested out of scopes (meaning another MDL will add this feature): View group conversations accordion () View favourites accordion / favourite a conversation () Searching within a conversation () Message settings pane () Ability to block a user () Contact requests send/approve panes () Any other features.. UI Prototype:
19.summary: Messaging: Create get_conversations based on data_for_messagearea_conversations
description: In has been identified that the data_for_messagearea_conversations external function should be adapted to probably return the the message/classes/output/messagearea/conversation.php class instead of the current message/classes/output/messagearea/contacts.php. Probably the conversation class should also be reviewed to add the needed information to display in the UI (i.e. the mobile team would appreciate ).
20.summary: Messaging: UI: Add settings pane to new UI
description: Scope: Add the settings pane, but only the privacy controls at the top of the pane. The email notifications stuff will be a follow up MDL. See for the relevant settings options/web services (get_user_message_preferences() ? ) The settings will need to include the option for Anyone on the site, if site-wide messaging admin setting is enabled.
21.summary: Messaging: audit privacy api after table changes
description: Were adding columns and tables in this project, so check the provider and make sure were covering all relevant fields still. We also need to consider/check the new user preferences for messaging - added as part of . And finally, we need to export the conversations in the privacy export (now only private messages are exported). This will be done in
22.summary: Messaging: UI: Add group-based conversations support to new UI
description: Scope: Add group conversations accordion, which includes group-based conversations only (those conversations which were created based on a course group) the data_for_messagearea_conversations web service (or relevant service) should be returning relevant metadata about the conversations course/group, etc. Add group-based conversations support to search/results (again metadata from web service) The web service should already provide you with relevant conversation metadata for each message returned (see for details) Should be able to send/receive messages to/from the other group members within the conversation Ideally, wed (somehow) have a placeholder representing a group-based-conversations in the UI, when no messages have yet been sent. This just means we wont have created the conversation until we actually use it. Still need to work out if/how - will mention this on also - so check there too.
23.summary: Messaging: address conversations and favourite conversation in the privacy API
description: We need to work out how well present this now that we support group conversations. At the moment, its just a list of user which we have a 1:1 convo with, but this doesnt work with groups.
24.summary: Messaging: UI: Add the favouriting feature to the new UI
description: Scope: N.B. Web services facilitating this work will have been added to messaging in . Add the Favourites accordion Add the ability to favourite a conversation (star icon or ellipsis menu item - tbc by UX) Done within the conversation Add the ability to un-favourite a conversation (star icon or ellipsis menu item - tbc by UX) Done within the conversation
25.summary: Messaging: UI: Add the ability to block users in the new UI
description: Scope: Done via ellipsis menu in a 1:1 conversation only - out of scope for groups for now. UX to confirm designs for how to unblock a user.
26.summary: Messaging: UI: Add contact requests feature to the new UI
description: Scope: Web services should have been created as part of See prototype for screens. Dont forget to remove the stub page message/pendingcontactrequests.php
27.summary: Messaging: UI: Remove any legacy code leftovers
description: After this project is done there may be a lot of no longer used code, best to get rid of it. Eg. message/index.php related templates/JS.
28.summary: Messaging: Extend user search API to properly check user visibility in course/site
description: Scope: Assumes the search APIs have been updated - as per . When searching, and specifically when generating the User results (as opposed to Message results), we need to make sure we only return those users who are either: Contacts of the current user or; Are visible to the current user, either within his course (if site-wide messaging is disabled), or in a site (is site-wide messaging is enabled). Visibility may entail checking several capabilities, mainly those around viewing user names, or the ability to view course participants. Possibly identity fields, but hopefully not. This is key to maintaining a consistency with what users can see in other areas of the UI (in terms of user details), and with what details are returned in the messaging search results.
29.summary: Messaging: Unify get_messages and get_conversation_messages external functions
description: During , the get_conversation_messages method has been added to the message/externallib.php for adding support to conversation messages. For now, this method is based on the data_for_messagearea_messages, which is the one used from the UI. However, the message/externallib.php file contains also the get_messages method, which is quite similar. For this reason, we should add some extra parameters and logic to the get_conversation_messages method, for being able to deprecate also the get_messages method.
30.summary: Reimplement failing Behat tests
description: These scenarios were failing due to the changes in where a temporary page was created to confirm contact requests, so instead of editing them to go to a temporary page which would then need changing again when it is removed they were simply commented out.
31.summary: Add favourites subsystem to core
description: Needed for group messaging and course overview improvements projects, for starring conversations and courses, respectively. This should be fairly simple, in that we just want to allow components to mark items (essentially \string component, string itemtype, int itemid, int contextid) as favourite items for a specific user. This issue just deals with the subsystem. The usage in the respective projects will be issues attached to each epic and will come a bit later.
32.summary: Messaging: Create API for creating conversations
description: This needs to be done, yolo.
33.summary: Messaging: Allow creation of group conversations from the group edit page
description: Scope: Introduce an Add as conversation toggle on group edit form which creates group conversation (or flags group for future conversation creation via adhoc/scheduled tasks - this is up for discussion but as soon as possible would be the preference). Groups and their conversation must be linked somehow to facilitate synchronisation tasks (see ). Keep in mind we may very well have conversations which are NOT linked to groups, as well as conversations which may be linked to other things in Moodle - design should be flexible enough to accommodate these. The component, context, itemid idea perhaps seems reasonable as weve used this elsewhere. This issue should add to / extend the relevant non-search internal APIs (data_for_messagearea_conversations(), others?) and web services such that we include the required metadata about the conversation in any calls made to fetch it. This DOES NOT include search APIs - see for that. This data may include: Information about what the conversation is linked to (in as generic a way as possible) which, in our case, needs to include: Course name Group name Time of most recent message Unread count for the conversation Out of scope: Synchronisation of groups/group-conversations members (see for this)
34.summary: Messaging: Synchronise course group members with conversations members, for those groups having linked conversations.
description: Scope: This issue assumes : Groups can already be linked to conversations. This is about making sure we reflect any course group membership changes in the corresponding messaging group conversation, if present. It could be a task or an event listener perhaps - as long as we are able to handle cases like: course group updates via a web service updates via the browser, and any other expected means of changing group members.
35.summary: Messaging: Create web service and api for returning conversation members
description: This needs to be done, yolo.
36.summary: Messaging: Review can_post_message to use identifiers instead of user objects
description: The can_post_message function needs a $sender and a $recipient object but only the identifiers are really used inside. We should change this to save some possible previous DB queries.
37.summary: Web service for return conversation members does not confirm user is a member
description: Pretty much the WS will allow anyone to query any conversation they do not belong to and find out which members exist.
38.summary: Improve message_search_users queries from performance perspective
description: Current implementation for message_search_users() does a query within a query to get all messages for each conversation for each user. It will be good to improve this.
39.summary: The get_contact_requests API should make use of the get_member_info helper
description: This was written before the helper was introduced. Having one location define the return structure is much nicer. Also, if we wait for after release then we cant change the return structure due to third-parties using it.
40.summary: Add image url support to get_conversations()
description: This was something I forgot to add during work on . We need this so that we can support an image for any linked conversations. In future, this should be able to be set by the component area to which the group is linked, but for now, will just be hard coded to course groups, and their image url.
|
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: Upgrade moodle.org to 2.7
description: As mentioned in moodle.org should be upgraded one week prior to the major release.
| Unsolvable | 1.summary: Upgrade branch moodle.org-2.6-block_cool_sites-addon
description:
2.summary: Upgrade branch moodle.org-2.6-block_partners-addon
description:
3.summary: Upgrade branch moodle.org-2.6-block_spam_deletion-addon
description: moodle.org
4.summary: Upgrade branch moodle.org-2.6-block_unanswered_discussions-addon
description:
5.summary: Upgrade branch moodle.org-2.6-core-communities_ui-hack
description:
6.summary: Upgrade branch moodle.org-2.6-core-hack-favicon
description:
7.summary: Upgrade branch moodle.org-2.6-core_badges-hack-badges_efficiency_backport_MDL-42965
description:
8.summary: Upgrade branch moodle.org-2.6-core_badges-hack-badges_reaward_script
description:
9.summary: Upgrade branch moodle.org-2.6-core_badges-hack-delete_badges_backport_MDL-40551
description:
10.summary: Upgrade branch moodle.org-2.6-core_badges-hack-disable_cron
description:
11.summary: Upgrade branch moodle.org-2.6-enrol_groupsync-addon
description:
12.summary: Upgrade branch moodle.org-2.6-filter_geshi-addon
description:
13.summary: Upgrade branch moodle.org-2.6-filter_moodledocs-addon
description:
14.summary: Upgrade branch moodle.org-2.6-filter_moodlelinks-addon
description:
15.summary: Upgrade branch moodle.org-2.6-filter_skypeicons-addon
description:
16.summary: Upgrade branch moodle.org-2.6-local_adminer-addon
description:
17.summary: Upgrade branch moodle.org-2.6-local_chatlogs-addon
description:
18.summary: Upgrade branch moodle.org-2.6-local_dev-addon
description:
19.summary: Upgrade branch moodle.org-2.6-local_moodleorg-addon
description:
20.summary: Upgrade branch moodle.org-2.6-local_plugins-addon
description:
21.summary: Upgrade branch moodle.org-2.6-message_airnotifier-addon
description:
22.summary: Upgrade branch moodle.org-2.6-message_airnotifier-hack-services
description:
23.summary: Upgrade branch moodle.org-2.6-mod_forum-hack-bynameondate
description:
24.summary: Upgrade branch moodle.org-2.6-mod_forum-hack-permalink
description:
25.summary: Upgrade branch moodle.org-2.6-mod_forum-hack_avatar-size
description:
26.summary: Upgrade branch moodle.org-2.6-mod_forum-hack_course-fullname
description:
27.summary: Upgrade branch moodle.org-2.6-repository_github-addon
description:
28.summary: Upgrade branch moodle.org-2.6-set_google
description:
29.summary: Upgrade branch moodle.org-2.6-set_moodleorg-child-themes
description:
30.summary: Upgrade branch moodle.org-2.6-theme_bootstrapbase-hack-docking_backport_MDL-38923
description:
31.summary: Upgrade branch moodle.org-2.6-theme_moodleorgcleaned-addon
description:
32.summary: Running cron on next.moodle when server under heavy load fataled
description: according to Damyon (from previous chats) the cron should have carried on and recorded in its pages that something failed.. this is when DB conn failed btw.. a real exception :-D Database transaction aborted automatically in core\task\legacy_plugin_cron_task Default exception handler: Error reading from database Debug: MySQL server has gone away SELECT FROM task_scheduled WHERE classname = ? array ( 0 => \\core\\task\\legacy_plugin_cron_task, ) Error code: dmlreadexception line 443 of /lib/dml/moodle_database.php: dml_read_exception thrown line 1014 of /lib/dml/mysqli_native_moodle_database.php: call to moodle_database->query_end() line 1476 of /lib/dml/moodle_database.php: call to mysqli_native_moodle_database->get_records_sql() line 1448 of /lib/dml/moodle_database.php: call to moodle_database->get_record_sql() line 1427 of /lib/dml/moodle_database.php: call to moodle_database->get_record_select() line 562 of /lib/classes/task/manager.php: call to moodle_database->get_record() line 90 of /lib/cronlib.php: call to core\task\manager::scheduled_task_failed() line 61 of /admin/cli/cron.php: call to cron_run() PHP Fatal error: Uncaught exception coding_exception with message Coding error detected, it must be fixed by a programmer: \core\lock\lock() has fallen out of scope without being released. Locks must ALWAYS be released by calling $mylock->release(). in /var/www/vhosts/moodle.org/html/lib/classes/lock/lock.php:107 Stack trace: 0 internal function: core\lock\lock->__destruct() 1 main thrown in /var/www/vhosts/moodle.org/html/lib/classes/lock/lock.php on line 107 note not necessarily needs fixing but this is a good record to have re new cron management in 2.7. ping damyon - in case there is any possible developments here.
| 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: Upgrade moodle.org to 2.7
description: As mentioned in moodle.org should be upgraded one week prior to the major release.
### Response:
1.summary: Upgrade branch moodle.org-2.6-block_cool_sites-addon
description:
2.summary: Upgrade branch moodle.org-2.6-block_partners-addon
description:
3.summary: Upgrade branch moodle.org-2.6-block_spam_deletion-addon
description: moodle.org
4.summary: Upgrade branch moodle.org-2.6-block_unanswered_discussions-addon
description:
5.summary: Upgrade branch moodle.org-2.6-core-communities_ui-hack
description:
6.summary: Upgrade branch moodle.org-2.6-core-hack-favicon
description:
7.summary: Upgrade branch moodle.org-2.6-core_badges-hack-badges_efficiency_backport_MDL-42965
description:
8.summary: Upgrade branch moodle.org-2.6-core_badges-hack-badges_reaward_script
description:
9.summary: Upgrade branch moodle.org-2.6-core_badges-hack-delete_badges_backport_MDL-40551
description:
10.summary: Upgrade branch moodle.org-2.6-core_badges-hack-disable_cron
description:
11.summary: Upgrade branch moodle.org-2.6-enrol_groupsync-addon
description:
12.summary: Upgrade branch moodle.org-2.6-filter_geshi-addon
description:
13.summary: Upgrade branch moodle.org-2.6-filter_moodledocs-addon
description:
14.summary: Upgrade branch moodle.org-2.6-filter_moodlelinks-addon
description:
15.summary: Upgrade branch moodle.org-2.6-filter_skypeicons-addon
description:
16.summary: Upgrade branch moodle.org-2.6-local_adminer-addon
description:
17.summary: Upgrade branch moodle.org-2.6-local_chatlogs-addon
description:
18.summary: Upgrade branch moodle.org-2.6-local_dev-addon
description:
19.summary: Upgrade branch moodle.org-2.6-local_moodleorg-addon
description:
20.summary: Upgrade branch moodle.org-2.6-local_plugins-addon
description:
21.summary: Upgrade branch moodle.org-2.6-message_airnotifier-addon
description:
22.summary: Upgrade branch moodle.org-2.6-message_airnotifier-hack-services
description:
23.summary: Upgrade branch moodle.org-2.6-mod_forum-hack-bynameondate
description:
24.summary: Upgrade branch moodle.org-2.6-mod_forum-hack-permalink
description:
25.summary: Upgrade branch moodle.org-2.6-mod_forum-hack_avatar-size
description:
26.summary: Upgrade branch moodle.org-2.6-mod_forum-hack_course-fullname
description:
27.summary: Upgrade branch moodle.org-2.6-repository_github-addon
description:
28.summary: Upgrade branch moodle.org-2.6-set_google
description:
29.summary: Upgrade branch moodle.org-2.6-set_moodleorg-child-themes
description:
30.summary: Upgrade branch moodle.org-2.6-theme_bootstrapbase-hack-docking_backport_MDL-38923
description:
31.summary: Upgrade branch moodle.org-2.6-theme_moodleorgcleaned-addon
description:
32.summary: Running cron on next.moodle when server under heavy load fataled
description: according to Damyon (from previous chats) the cron should have carried on and recorded in its pages that something failed.. this is when DB conn failed btw.. a real exception :-D Database transaction aborted automatically in core\task\legacy_plugin_cron_task Default exception handler: Error reading from database Debug: MySQL server has gone away SELECT FROM task_scheduled WHERE classname = ? array ( 0 => \\core\\task\\legacy_plugin_cron_task, ) Error code: dmlreadexception line 443 of /lib/dml/moodle_database.php: dml_read_exception thrown line 1014 of /lib/dml/mysqli_native_moodle_database.php: call to moodle_database->query_end() line 1476 of /lib/dml/moodle_database.php: call to mysqli_native_moodle_database->get_records_sql() line 1448 of /lib/dml/moodle_database.php: call to moodle_database->get_record_sql() line 1427 of /lib/dml/moodle_database.php: call to moodle_database->get_record_select() line 562 of /lib/classes/task/manager.php: call to moodle_database->get_record() line 90 of /lib/cronlib.php: call to core\task\manager::scheduled_task_failed() line 61 of /admin/cli/cron.php: call to cron_run() PHP Fatal error: Uncaught exception coding_exception with message Coding error detected, it must be fixed by a programmer: \core\lock\lock() has fallen out of scope without being released. Locks must ALWAYS be released by calling $mylock->release(). in /var/www/vhosts/moodle.org/html/lib/classes/lock/lock.php:107 Stack trace: 0 internal function: core\lock\lock->__destruct() 1 main thrown in /var/www/vhosts/moodle.org/html/lib/classes/lock/lock.php on line 107 note not necessarily needs fixing but this is a good record to have re new cron management in 2.7. ping damyon - in case there is any possible developments here.
|
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: Docs reboot
description: Project goals: New theme for Moodle Docs user wikis incorporating black sites bar Improving the Moodle Docs overview page Improving the search ranking of most recent version wiki
| Solvable | 1.summary: Create new theme for Moodle Docs
description: Theme should have: Black sites bar across top Purple colour scheme Responsive design for main skin and our page content
2.summary: Add black sites bar to docs wiki
description:
3.summary: Improve the Moodle Docs overview page
description: Rather than maintaining a separate page, lets move the docs overview to say and then redirect docs.moodle.org/overview/ to docs.moodle.org/en/Overview. The docs overview page would then also be easily editable. Links should be arranged by language, and the headings Moodle Documentation by release, Moodle Documentation (combined versions) and Unmaintained documentation (read-only archives) should be removed. Links to unmaintained documentation should be moved to a separate page, since the docs have not been changed in over 3 years and cover Moodle 1.9 which is no longer supported.
| 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: Docs reboot
description: Project goals: New theme for Moodle Docs user wikis incorporating black sites bar Improving the Moodle Docs overview page Improving the search ranking of most recent version wiki
### Response:
1.summary: Create new theme for Moodle Docs
description: Theme should have: Black sites bar across top Purple colour scheme Responsive design for main skin and our page content
2.summary: Add black sites bar to docs wiki
description:
3.summary: Improve the Moodle Docs overview page
description: Rather than maintaining a separate page, lets move the docs overview to say and then redirect docs.moodle.org/overview/ to docs.moodle.org/en/Overview. The docs overview page would then also be easily editable. Links should be arranged by language, and the headings Moodle Documentation by release, Moodle Documentation (combined versions) and Unmaintained documentation (read-only archives) should be removed. Links to unmaintained documentation should be moved to a separate page, since the docs have not been changed in over 3 years and cover Moodle 1.9 which is no longer supported.
|
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 1 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. This Epic will see the tasks the final specification is broken down into completed. Note - for organisation, this work is being split into 2 epics, this first one (stage 1) and (stage 2)
| Unsolvable | 1.summary: Create the element library admin tool
description: Implement the admin tool defined in
2.summary: Specify the requirements for the element library
description: This should be a dev docs page describing the element library tool, and describing how a developer would add a renderable/renderer method to the tool. It should list the mandatory and optional features for this tool requires in order to meet the goals specified in:
3.summary: Define the initial list of renderables to be added to the element library
description: The proposed categories for renderables are: Elements Components (built of smaller elements) Layouts (structured arrangements of smaller components/elements/layouts) The names of these categories needs to be agreed on, and docs created to describe each category. An (early) list of renderables is defined here: This list needs reviewing and categorising.
4.summary: Define style guide for renderables
description: This document should go hand in hand with the element library, but will define best practices to follow when creating the default implementations of renderables. See:
5.summary: Document renderer best practices
description: As part of the the Render library specification| we agree that a best practices document was needed for the creation of renderers. It should include: The dos and donts of writing a render. A best practices for output. Any rules and recommendations in situations where elements cannot (or will not) be used.
6.summary: Define and document JavaScript output guide
description: As part of the the Render library specification| we need to establish how the relationship between JavaScript and output should exist. This involves deciding if handlebars is what we want to use, how we want to use it, how it ties in with renderers and elements, and then documenting the process thoroughly. We should also consider here how to document elements and the JavaScript components that ship with them.
7.summary: Decide and document output components
description: This is an essential part of the task - unfortunately the approaches are broad and what we choose now we have to commit to and live with. It has to meet our needs now and in the future. Some of the things that need to factor into this decisions are: Element and component re-use Re-use is key to this approach. We want to have components containing existing elements and components, and when we want to change how an element looks we want that change reflected in all uses of the element within other components that dont require it to look different. This way you can style a button and instantly have the look updated across other components like search forms containing buttons. Elements and components can be complex Elements dont need to be easy to write - they should be feature full and limited in number. Developers should not write components instead they should be re-using the available elements and components. Overriding a render to change how an element must be both easy and robust Re-use is key as per the above point. However we need to achieve this in such a way that we dont introduce magic and keep things simple to understand and override. We have to be able to deal with state and attribute requirements of the element in relation to its parent component and do it in such as way that the state is owned by the component and attributes are owner by the render method. and keep it all understandable.
| 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 1 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. This Epic will see the tasks the final specification is broken down into completed. Note - for organisation, this work is being split into 2 epics, this first one (stage 1) and (stage 2)
### Response:
1.summary: Create the element library admin tool
description: Implement the admin tool defined in
2.summary: Specify the requirements for the element library
description: This should be a dev docs page describing the element library tool, and describing how a developer would add a renderable/renderer method to the tool. It should list the mandatory and optional features for this tool requires in order to meet the goals specified in:
3.summary: Define the initial list of renderables to be added to the element library
description: The proposed categories for renderables are: Elements Components (built of smaller elements) Layouts (structured arrangements of smaller components/elements/layouts) The names of these categories needs to be agreed on, and docs created to describe each category. An (early) list of renderables is defined here: This list needs reviewing and categorising.
4.summary: Define style guide for renderables
description: This document should go hand in hand with the element library, but will define best practices to follow when creating the default implementations of renderables. See:
5.summary: Document renderer best practices
description: As part of the the Render library specification| we agree that a best practices document was needed for the creation of renderers. It should include: The dos and donts of writing a render. A best practices for output. Any rules and recommendations in situations where elements cannot (or will not) be used.
6.summary: Define and document JavaScript output guide
description: As part of the the Render library specification| we need to establish how the relationship between JavaScript and output should exist. This involves deciding if handlebars is what we want to use, how we want to use it, how it ties in with renderers and elements, and then documenting the process thoroughly. We should also consider here how to document elements and the JavaScript components that ship with them.
7.summary: Decide and document output components
description: This is an essential part of the task - unfortunately the approaches are broad and what we choose now we have to commit to and live with. It has to meet our needs now and in the future. Some of the things that need to factor into this decisions are: Element and component re-use Re-use is key to this approach. We want to have components containing existing elements and components, and when we want to change how an element looks we want that change reflected in all uses of the element within other components that dont require it to look different. This way you can style a button and instantly have the look updated across other components like search forms containing buttons. Elements and components can be complex Elements dont need to be easy to write - they should be feature full and limited in number. Developers should not write components instead they should be re-using the available elements and components. Overriding a render to change how an element must be both easy and robust Re-use is key as per the above point. However we need to achieve this in such a way that we dont introduce magic and keep things simple to understand and override. We have to be able to deal with state and attribute requirements of the element in relation to its parent component and do it in such as way that the state is owned by the component and attributes are owner by the render method. and keep it all understandable.
|
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 8.0
description: !taken_on_close.png! _(image taken before closing, now php80 is being tested everywhere, GHA, CI... so no need for those custom tests and branches anymore)_ Accumulative branches (with all the pending stuff still not upstream) are: - master: (deleted) - 311_STABLE: (deleted) An, hopefully, small epic to turn Moodle ready for PHP 8.0. When: Being cristal clear (aka transparent), the ideal target release for this is Moodle 3.11.0 (aka, supported since the very beginning of the branch), but be warned that full support may arrive later in any Moodle 3.11.x minor release in the branch, depending of a number of factors (extensions availability and bugs, 3rd part libraries, last minute surprises...). Some initial links: - Main changes explained: and - Changes detailed: - Accepted RFCs: Some basic requirements for this: (/) get unit and acceptance tests passing against all databases (may imply the need of upgrading phpunit/behat...). (/) phpunit upgrade: (/) behat upgrade: (/) check all the changes details| have been reviewed and fixed (attached file). (/) ensure older versions of Moodle dont work with PHP 8.0 () (/) get travis| and gha| working with the new php version () (/) verify that there apache logs are clean of PHP 8.0 notices/warnings/errors () (/) get moodle-php-apache| docker images working with the new php version (/) verify that php-parallel-lint/php-parallel-lint| passes for all php versions () (/) Update docs| (and others, see testing instructions) once this is ready. - ... And some tasks to do once this is upstream: TODO 1: Review the travis and/or github actions configuration for various repositories. The new PHP version needs to be covered. Known to need review / fix repos include: - (/) moodle_docker| (PR158| - (/) moodle-ci-runner| - (/) nightlyjobs| (MR!31| - (/) moodle-plugin-ci| (PR94| - (/) local_codechecker| (PR145| - (/) local_moodlecheck| (PR74| - (/) local_ci| - moodle-tool_pluginskel| (PR109| - ... TODO 2: Verify that this PR has been fixed/hopefully released| @ MinkExtension (new PHP 8 warning) and update our dependencies to it. All the issues belonging to this epic should be pulled into both MOODLE_311_STABLE and master (unless they are bug fixes requiring patching older, still supported, branches)
| Unsolvable | 1.summary: Magic methods signature checks
description: From CHANGELOG: quote . Magic Methods will now have their arguments and return types checked if they have them declared. The signatures should match the following list: __call(string $name, array $arguments): mixed __callStatic(string $name, array $arguments): mixed __clone(): void __debugInfo(): ?array __get(string $name): mixed __invoke(mixed $arguments): mixed __isset(string $name): bool __serialize(): array __set(string $name, mixed $value): void __set_state(array $properties): object __sleep(): array __unserialize(array $data): void __unset(string $name): void __wakeup(): void RFC: quote Regular expression used to detect all uses and fix them when needed: code ag __call|__callStatic|__clone|__debugInfo|\ __get__invoke|__isset|__serialize|__set|\ __set_state|__sleep|__unserialize|__unset|__wakeup --php code
2.summary: PHP 8.0: getdate(null) returns current date instead of Jan 1st 1970 as it is in php7
description: The original description of this issue has been modified. Initially it was reported as an error in the dateselector field which is actually part of This issue has been re-purposed for another problem discovered in the process: code getdate(null) code returns different results in PHP8 and PHP7. Since Moodle supports both php7 and php8 we need to make sure that usergetdate() is never called with the null argument because the behavior will be inconsistent. To see the differences, take a look to Summary: - Not passing anything is consistent, returns now (2021). - Passing zero (0) is consistent, returns 0 (1970) - Passing null is inconsistent, with php7 it returns 0, but with php8, it returns now. Hence: - We must prevent any (inconsistent) call passing null to happen (thats what the 1st commit does, detect). - We must change any call previously passing null, to pass 0, to keep results the same. 2nd commit will do.
3.summary: Verify that there apache logs are clean of PHP 8.0 notices/warnings/errors
description: Once we get behat passing, its time to inspect web server logs to see if there is anything there that has not been detected by the runs. Usually we get both the logs from a js and non-js run and go looking to them. See for example to know how to clean the logs and focus on the important bits and, also, how to be able to know (by times) which the problematic scenario is.
4.summary: Investigate in_array usage
description: Investigate the usages and results of in_array in currently supported php versions. During a review of , it was identified that in_array throws up false +ves/-ves. It was suggested to review its usages and confirm there are no hidden cases where this is failing and not being picked up. Refer to this comment| Note: Ive only included enrolments and 3.11 but this should be a core-wide check.
5.summary: Investigate behat/mink-extension alternatives
description: Working on (php80 epic) it was detected that behat/mink-extension| part of out behat tool-chain... is not ready for php8. The problem, right now, doesnt go beyond displaying some PHP Warnings, and normally allow CI tools to pass (ci.moodle.org, GHA integrations...)... although... if the tool performs any output/error analysis (for example moodle-plugin-ci with travis), it fails. code PHP Deprecated: Method ReflectionParameter::getClass() is deprecated in /h 538 ome/travis/build/moodle/vendor/behat/mink-extension/src/Behat/MinkExtension 539 /ServiceContainer/Driver/GoutteFactory.php on line 119 540 PHP Deprecated: Method ReflectionParameter::getClass() is deprecated in /h 541 ome/travis/build/moodle/vendor/behat/mink-extension/src/Behat/MinkExtension 542 /ServiceContainer/Driver/GoutteFactory.php on line 119 code In any case, this is only the detail that raised the alarms. The current status is that, while the extension is not officially abandoned... in practice it has not received any update since 2018 and, also, they arent proceeding to fix or process stuff. See, for example, about the PHP Warnings problem commented above. So this issue is about consider which alternatives we have, understanding that the extension is a MUST in our Behat tool-chain.
6.summary: PHP 8.0: Fix all problems detected by phplint
description: Just run: code composer require --dev php-parallel-lint/php-parallel-lint && \ vendor/bin/parallel-lint --show-deprecated . code And fix all the problems detected by the linter
7.summary: Perform a complete PHPCompatibility 8.0 execution against codebase
description: This task is one of the final ones to perform when everything else in the epic has been already applied. Its about to run the PHPCompatibility standard (that we usually also run as part of our local_codechecker) against the whole codebase. Prerequisites: (/) The epic must be almost finished (to avoid detecting problems that correspond to other issues). (/) PHPCompatibility must support the php versions being checked. (/) Determine the range of PHP versions supported for the branch (7.3-8.0) To perform the run against master, just: Clone locally. Ensure youre in the "develop" branch (the "master" branch contains the latest release, quite old now 2019). run composer install Run: code export DIRROOT=/path/to/your/moodle ; vendor/bin/phpcs \ --standard=PHPCompatibility \ --runtime-set testVersion 7.3-8.0 \ --extensions=php \ --ignore=$DIRROOT/vendor/,$DIRROOT/local/ \ --cache=/tmp/cache -p $DIRROOT code Look for detected stuff, discard false positives (it can be useful to look to the results of previous PHP XY Epic - ) to copy any decision there.
| 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 8.0
description: !taken_on_close.png! _(image taken before closing, now php80 is being tested everywhere, GHA, CI... so no need for those custom tests and branches anymore)_ Accumulative branches (with all the pending stuff still not upstream) are: - master: (deleted) - 311_STABLE: (deleted) An, hopefully, small epic to turn Moodle ready for PHP 8.0. When: Being cristal clear (aka transparent), the ideal target release for this is Moodle 3.11.0 (aka, supported since the very beginning of the branch), but be warned that full support may arrive later in any Moodle 3.11.x minor release in the branch, depending of a number of factors (extensions availability and bugs, 3rd part libraries, last minute surprises...). Some initial links: - Main changes explained: and - Changes detailed: - Accepted RFCs: Some basic requirements for this: (/) get unit and acceptance tests passing against all databases (may imply the need of upgrading phpunit/behat...). (/) phpunit upgrade: (/) behat upgrade: (/) check all the changes details| have been reviewed and fixed (attached file). (/) ensure older versions of Moodle dont work with PHP 8.0 () (/) get travis| and gha| working with the new php version () (/) verify that there apache logs are clean of PHP 8.0 notices/warnings/errors () (/) get moodle-php-apache| docker images working with the new php version (/) verify that php-parallel-lint/php-parallel-lint| passes for all php versions () (/) Update docs| (and others, see testing instructions) once this is ready. - ... And some tasks to do once this is upstream: TODO 1: Review the travis and/or github actions configuration for various repositories. The new PHP version needs to be covered. Known to need review / fix repos include: - (/) moodle_docker| (PR158| - (/) moodle-ci-runner| - (/) nightlyjobs| (MR!31| - (/) moodle-plugin-ci| (PR94| - (/) local_codechecker| (PR145| - (/) local_moodlecheck| (PR74| - (/) local_ci| - moodle-tool_pluginskel| (PR109| - ... TODO 2: Verify that this PR has been fixed/hopefully released| @ MinkExtension (new PHP 8 warning) and update our dependencies to it. All the issues belonging to this epic should be pulled into both MOODLE_311_STABLE and master (unless they are bug fixes requiring patching older, still supported, branches)
### Response:
1.summary: Magic methods signature checks
description: From CHANGELOG: quote . Magic Methods will now have their arguments and return types checked if they have them declared. The signatures should match the following list: __call(string $name, array $arguments): mixed __callStatic(string $name, array $arguments): mixed __clone(): void __debugInfo(): ?array __get(string $name): mixed __invoke(mixed $arguments): mixed __isset(string $name): bool __serialize(): array __set(string $name, mixed $value): void __set_state(array $properties): object __sleep(): array __unserialize(array $data): void __unset(string $name): void __wakeup(): void RFC: quote Regular expression used to detect all uses and fix them when needed: code ag __call|__callStatic|__clone|__debugInfo|\ __get__invoke|__isset|__serialize|__set|\ __set_state|__sleep|__unserialize|__unset|__wakeup --php code
2.summary: PHP 8.0: getdate(null) returns current date instead of Jan 1st 1970 as it is in php7
description: The original description of this issue has been modified. Initially it was reported as an error in the dateselector field which is actually part of This issue has been re-purposed for another problem discovered in the process: code getdate(null) code returns different results in PHP8 and PHP7. Since Moodle supports both php7 and php8 we need to make sure that usergetdate() is never called with the null argument because the behavior will be inconsistent. To see the differences, take a look to Summary: - Not passing anything is consistent, returns now (2021). - Passing zero (0) is consistent, returns 0 (1970) - Passing null is inconsistent, with php7 it returns 0, but with php8, it returns now. Hence: - We must prevent any (inconsistent) call passing null to happen (thats what the 1st commit does, detect). - We must change any call previously passing null, to pass 0, to keep results the same. 2nd commit will do.
3.summary: Verify that there apache logs are clean of PHP 8.0 notices/warnings/errors
description: Once we get behat passing, its time to inspect web server logs to see if there is anything there that has not been detected by the runs. Usually we get both the logs from a js and non-js run and go looking to them. See for example to know how to clean the logs and focus on the important bits and, also, how to be able to know (by times) which the problematic scenario is.
4.summary: Investigate in_array usage
description: Investigate the usages and results of in_array in currently supported php versions. During a review of , it was identified that in_array throws up false +ves/-ves. It was suggested to review its usages and confirm there are no hidden cases where this is failing and not being picked up. Refer to this comment| Note: Ive only included enrolments and 3.11 but this should be a core-wide check.
5.summary: Investigate behat/mink-extension alternatives
description: Working on (php80 epic) it was detected that behat/mink-extension| part of out behat tool-chain... is not ready for php8. The problem, right now, doesnt go beyond displaying some PHP Warnings, and normally allow CI tools to pass (ci.moodle.org, GHA integrations...)... although... if the tool performs any output/error analysis (for example moodle-plugin-ci with travis), it fails. code PHP Deprecated: Method ReflectionParameter::getClass() is deprecated in /h 538 ome/travis/build/moodle/vendor/behat/mink-extension/src/Behat/MinkExtension 539 /ServiceContainer/Driver/GoutteFactory.php on line 119 540 PHP Deprecated: Method ReflectionParameter::getClass() is deprecated in /h 541 ome/travis/build/moodle/vendor/behat/mink-extension/src/Behat/MinkExtension 542 /ServiceContainer/Driver/GoutteFactory.php on line 119 code In any case, this is only the detail that raised the alarms. The current status is that, while the extension is not officially abandoned... in practice it has not received any update since 2018 and, also, they arent proceeding to fix or process stuff. See, for example, about the PHP Warnings problem commented above. So this issue is about consider which alternatives we have, understanding that the extension is a MUST in our Behat tool-chain.
6.summary: PHP 8.0: Fix all problems detected by phplint
description: Just run: code composer require --dev php-parallel-lint/php-parallel-lint && \ vendor/bin/parallel-lint --show-deprecated . code And fix all the problems detected by the linter
7.summary: Perform a complete PHPCompatibility 8.0 execution against codebase
description: This task is one of the final ones to perform when everything else in the epic has been already applied. Its about to run the PHPCompatibility standard (that we usually also run as part of our local_codechecker) against the whole codebase. Prerequisites: (/) The epic must be almost finished (to avoid detecting problems that correspond to other issues). (/) PHPCompatibility must support the php versions being checked. (/) Determine the range of PHP versions supported for the branch (7.3-8.0) To perform the run against master, just: Clone locally. Ensure youre in the "develop" branch (the "master" branch contains the latest release, quite old now 2019). run composer install Run: code export DIRROOT=/path/to/your/moodle ; vendor/bin/phpcs \ --standard=PHPCompatibility \ --runtime-set testVersion 7.3-8.0 \ --extensions=php \ --ignore=$DIRROOT/vendor/,$DIRROOT/local/ \ --cache=/tmp/cache -p $DIRROOT code Look for detected stuff, discard false positives (it can be useful to look to the results of previous PHP XY Epic - ) to copy any decision there.
|
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: List of questions for the UX team to study and respond
description: This is a collection of questions about the functionality of the course overview block and suggestions that need validation.
| Unsolvable | 1.summary: UX Question: Should activities with a start + end date show both dates?
description: E.g. Assignment shows due date (last one). Chat shows start time (first one).
2.summary: UX Question - is there a way to show activities without dates?
description: Activities without any dates - but with actions do not display on course overview. Should they (and how)?
3.summary: UX Question: Should we rename the timeline to "To do?"
description: Rational - it does not show everything - only actionable things so its not really a timeline. It is subjective depending on the meaning associated with the words Todo and Timeline based on each users previous experiences.
4.summary: UX Question - what number should show for forums?
description: Currently it ended up being "the number of posts remaining for you to complete this forum activity (if this is set as a completion criteria)". This will rarely be the completion condition used, and the much more obvious "how many unread posts are there" is never displayed. Lets please consider: a) which number is the most important b) should we have 2 numbers?
5.summary: UX Question: Is there a better way to display future activities which are not currently actionable?
description: E.g. upcoming chats, quizes and assignments show a disabled link to perform the action. It is not clear why the link is not actionable. There is also a related issue about showing start and end dates for these activities which does affect this.
6.summary: UX Question - Validate user story "As a teacher I can see the list of actions a student has due".
description: Is there a valid user story for a teacher to see a students view of the course overview timeline? In a lot of cases the view will be different for each student.
| 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: List of questions for the UX team to study and respond
description: This is a collection of questions about the functionality of the course overview block and suggestions that need validation.
### Response:
1.summary: UX Question: Should activities with a start + end date show both dates?
description: E.g. Assignment shows due date (last one). Chat shows start time (first one).
2.summary: UX Question - is there a way to show activities without dates?
description: Activities without any dates - but with actions do not display on course overview. Should they (and how)?
3.summary: UX Question: Should we rename the timeline to "To do?"
description: Rational - it does not show everything - only actionable things so its not really a timeline. It is subjective depending on the meaning associated with the words Todo and Timeline based on each users previous experiences.
4.summary: UX Question - what number should show for forums?
description: Currently it ended up being "the number of posts remaining for you to complete this forum activity (if this is set as a completion criteria)". This will rarely be the completion condition used, and the much more obvious "how many unread posts are there" is never displayed. Lets please consider: a) which number is the most important b) should we have 2 numbers?
5.summary: UX Question: Is there a better way to display future activities which are not currently actionable?
description: E.g. upcoming chats, quizes and assignments show a disabled link to perform the action. It is not clear why the link is not actionable. There is also a related issue about showing start and end dates for these activities which does affect this.
6.summary: UX Question - Validate user story "As a teacher I can see the list of actions a student has due".
description: Is there a valid user story for a teacher to see a students view of the course overview timeline? In a lot of cases the view will be different for each student.
|
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.4)
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: Quick link Remaining open issues in this epic|
| Unsolvable | 1.summary: Upgrade ADOdb to 5.20.9 for Moodle 3.4 release
description: see parent and previous upgrade issue
2.summary: Note bennu version is 0.1 in lib/thirdpartylibs.xml
description: Double check it actually is v0.1 Consider upgrade if not Add version 0.1 to lib/thirdpartylibs.xml to prevent confusion in future
3.summary: Upgrade HTMLPurifier to 4.9.3 for Moodle 3.4 release
description: Update HTMLPurifier to 4.9.3
4.summary: Upgrade MatthiasMullie\Minify to 1.3.51 and MatthiasMullie\PathConverter to 1.1.0 for Moodle 3.4 release
description: Upgrade minify to 1.3.51 and pathconverter to 1.1.0
5.summary: Upgrade Video.JS to 6.3.2 and videojs_youtube to 2.4.0
description: The latest stable now is 6.1.0 ( also see conversation on VideoJS blog| This is also an opportunity to introduce HLS and MPEG-DASH support (using corresponding extensions), as well as RTMP (by resolving that depends on VideoJS upgrade to version 6) in core Moodle. Notice, that flash support has become an extension in 6.0.0> ( edited: latest versions at the moment are: Video.JS 6.3.2 and videojs_youtube 2.4.0
6.summary: Upgrade CAS to 1.3.5 for Moodle 3.4 release
description: /auth/cas/CAS/ 1.3.5 available see also
7.summary: Put deprecated auth plugins into plugins database
description: In we deprecated some auth plugins and they need to go to the plugins DB: nntp pam imap pop3 fc
8.summary: Upgrade Google APIs client library to 2.2.0 for Moodle 3.4 release
description: Upgrade Google APIs client library to 2.2.0 for Moodle 3.4 release /lib/google/
9.summary: Upgrade Popper.js to 1.12.5 for Moodle 3.4 release
description: Popper.js /admin/tool/usertours/amd/src/popper.js current version: 1.0.8 latest version: 1.12.5
10.summary: Upgrade PHPMailer for Moodle 3.4 release
description: We currently have 5.2.23 Latest versions available on are: 5.2.25 and 6.0.1 For 6.0 it says quoteThis is a major update that breaks backwards compatibility. For information about whats changed, refer to the changelog and README files. The most important changes are that PHPMailer now defines a namespace (PHPMailer\PHPMailer), and requires a minimum of PHP 5.5. To find out more about how to upgrade, read the upgrade guide.quote Investigate if we can upgrade to 6.0.x , if yes - upgrade, if no - upgrade to 5.2.23
11.summary: Upgrade JQuery to 3.2.1 for Moodle 3.4 release
description: jQuery /lib/jquery/ 3.1.0 -> 3.2.1 last upgrade:
12.summary: Upgrade MathJax to 2.7.2 for Moodle 3.4 release
description: Upgrade MathJax to 2.7.2 for Moodle 3.4 release
13.summary: Upgrade SimplePie to 1.5 for Moodle 3.4 release
description: Upgrade SimplePie to 1.5 for Moodle 3.4 release /lib/simplepie/ 1.4.2 -> 1.5
14.summary: Upgrade TCPDF to 6.2.13 for Moodle 3.4 release
description: TCPDF /lib/tcpdf/ 6.2.12 -> 6.2.13
15.summary: Upgrade HTML2Text to 4.1.0 for Moodle 3.4 release
description: HTML2Text /lib/html2text/ 4.0.1 -> 4.1.0
16.summary: Upgrade Markdown to 1.7.0 for Moodle 3.4 release
description: Markdown original+extra /lib/markdown/ 1.6.0 -> 1.7.0
17.summary: Upgrade Horde to 5.2.17 for Moodle 3.4 release
description: Horde /lib/horde/ 5.2.7 -> 5.2.17
18.summary: Update RequireJS to 2.3.5 for Moodle 3.4 release
description: RequireJS /lib/requirejs/ 2.3.2 -> 2.3.5
19.summary: Upgrade loglevel.js to 1.5.1 for Moodle 3.4 release
description: loglevel.js /lib/amd/src/loglevel.js 1.4.1 -> 1.5.0
20.summary: Upgrade Mustache.php to 2.12.0 and Mustache.js to 2.3.0 for Moodle 3.4 release
description: Putting these two libraries in one issue for easier testing Mustache /lib/mustache/ 2.11.1 -> 2.12.0 Mustache.js /lib/amd/src/mustache.js 2.2.1 -> 2.3.0
21.summary: Upgrade scssphp to 0.6.7 for Moodle 3.4 release
description: Includes pull requests from fred scssphp /lib/scssphp/ 0.6.5 -> 0.6.7
22.summary: Upgrade Spout to 2.7.3 for Moodle 3.4 release
description: Spout /lib/spout/ 2.6.0 -> 2.7.3
23.summary: Upgrade Chart.js to 2.7.0 for Moodle 3.4 release
description: Chart.js /lib/amd/src/chartjs-lazy.js 2.2.2 -> 2.7.0
24.summary: Upgrade GeoIP for Moodle 3.4 release
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.4.2 -> 2.6.0 MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.0 -> 1.1.3
25.summary: Upgrade FPDI to 1.6.2 for Moodle 3.4 release
description: FPDI /mod/assign/feedback/editpdf/fpdi/ 1.6.1 -> 1.6.2
26.summary: Upgrade/patch xhprof to 0.9.4 for Moodle 3.4 release
description: Upgrade xhprof to 0.9.4 patch for PHP 7.2 compatibility (deprecated create_function() call)
27.summary: Upgrade Horde library for Moodle 3.4
description: We have previously closed several rounds of Horde upgrade because there were "no changes upstream". However it looks like horde stopped upgrading/maintaining "horde framework" and the same modules that we use can be taken from "horde core". It uses different versioning, the latest version is 2.30.2 (for comparision, we use version 5.2.7 or "horde framework"). Latest version of horde core includes changes that we need for PHP 7.2 compatibility. And the latest version of horde framework does not. ---- Horde library uses deprecated create_function and IDNA varaibles. For example, this is a fix for create_function regarding idn_to_ascii and idn_to_utf8, the code is very different upstream horde: and moodle:
| 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.4)
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: Quick link Remaining open issues in this epic|
### Response:
1.summary: Upgrade ADOdb to 5.20.9 for Moodle 3.4 release
description: see parent and previous upgrade issue
2.summary: Note bennu version is 0.1 in lib/thirdpartylibs.xml
description: Double check it actually is v0.1 Consider upgrade if not Add version 0.1 to lib/thirdpartylibs.xml to prevent confusion in future
3.summary: Upgrade HTMLPurifier to 4.9.3 for Moodle 3.4 release
description: Update HTMLPurifier to 4.9.3
4.summary: Upgrade MatthiasMullie\Minify to 1.3.51 and MatthiasMullie\PathConverter to 1.1.0 for Moodle 3.4 release
description: Upgrade minify to 1.3.51 and pathconverter to 1.1.0
5.summary: Upgrade Video.JS to 6.3.2 and videojs_youtube to 2.4.0
description: The latest stable now is 6.1.0 ( also see conversation on VideoJS blog| This is also an opportunity to introduce HLS and MPEG-DASH support (using corresponding extensions), as well as RTMP (by resolving that depends on VideoJS upgrade to version 6) in core Moodle. Notice, that flash support has become an extension in 6.0.0> ( edited: latest versions at the moment are: Video.JS 6.3.2 and videojs_youtube 2.4.0
6.summary: Upgrade CAS to 1.3.5 for Moodle 3.4 release
description: /auth/cas/CAS/ 1.3.5 available see also
7.summary: Put deprecated auth plugins into plugins database
description: In we deprecated some auth plugins and they need to go to the plugins DB: nntp pam imap pop3 fc
8.summary: Upgrade Google APIs client library to 2.2.0 for Moodle 3.4 release
description: Upgrade Google APIs client library to 2.2.0 for Moodle 3.4 release /lib/google/
9.summary: Upgrade Popper.js to 1.12.5 for Moodle 3.4 release
description: Popper.js /admin/tool/usertours/amd/src/popper.js current version: 1.0.8 latest version: 1.12.5
10.summary: Upgrade PHPMailer for Moodle 3.4 release
description: We currently have 5.2.23 Latest versions available on are: 5.2.25 and 6.0.1 For 6.0 it says quoteThis is a major update that breaks backwards compatibility. For information about whats changed, refer to the changelog and README files. The most important changes are that PHPMailer now defines a namespace (PHPMailer\PHPMailer), and requires a minimum of PHP 5.5. To find out more about how to upgrade, read the upgrade guide.quote Investigate if we can upgrade to 6.0.x , if yes - upgrade, if no - upgrade to 5.2.23
11.summary: Upgrade JQuery to 3.2.1 for Moodle 3.4 release
description: jQuery /lib/jquery/ 3.1.0 -> 3.2.1 last upgrade:
12.summary: Upgrade MathJax to 2.7.2 for Moodle 3.4 release
description: Upgrade MathJax to 2.7.2 for Moodle 3.4 release
13.summary: Upgrade SimplePie to 1.5 for Moodle 3.4 release
description: Upgrade SimplePie to 1.5 for Moodle 3.4 release /lib/simplepie/ 1.4.2 -> 1.5
14.summary: Upgrade TCPDF to 6.2.13 for Moodle 3.4 release
description: TCPDF /lib/tcpdf/ 6.2.12 -> 6.2.13
15.summary: Upgrade HTML2Text to 4.1.0 for Moodle 3.4 release
description: HTML2Text /lib/html2text/ 4.0.1 -> 4.1.0
16.summary: Upgrade Markdown to 1.7.0 for Moodle 3.4 release
description: Markdown original+extra /lib/markdown/ 1.6.0 -> 1.7.0
17.summary: Upgrade Horde to 5.2.17 for Moodle 3.4 release
description: Horde /lib/horde/ 5.2.7 -> 5.2.17
18.summary: Update RequireJS to 2.3.5 for Moodle 3.4 release
description: RequireJS /lib/requirejs/ 2.3.2 -> 2.3.5
19.summary: Upgrade loglevel.js to 1.5.1 for Moodle 3.4 release
description: loglevel.js /lib/amd/src/loglevel.js 1.4.1 -> 1.5.0
20.summary: Upgrade Mustache.php to 2.12.0 and Mustache.js to 2.3.0 for Moodle 3.4 release
description: Putting these two libraries in one issue for easier testing Mustache /lib/mustache/ 2.11.1 -> 2.12.0 Mustache.js /lib/amd/src/mustache.js 2.2.1 -> 2.3.0
21.summary: Upgrade scssphp to 0.6.7 for Moodle 3.4 release
description: Includes pull requests from fred scssphp /lib/scssphp/ 0.6.5 -> 0.6.7
22.summary: Upgrade Spout to 2.7.3 for Moodle 3.4 release
description: Spout /lib/spout/ 2.6.0 -> 2.7.3
23.summary: Upgrade Chart.js to 2.7.0 for Moodle 3.4 release
description: Chart.js /lib/amd/src/chartjs-lazy.js 2.2.2 -> 2.7.0
24.summary: Upgrade GeoIP for Moodle 3.4 release
description: GeoIP2 PHP API /lib/maxmind/GeoIp2/ 2.4.2 -> 2.6.0 MaxMind DB Reader API /lib/maxmind/MaxMind/ 1.1.0 -> 1.1.3
25.summary: Upgrade FPDI to 1.6.2 for Moodle 3.4 release
description: FPDI /mod/assign/feedback/editpdf/fpdi/ 1.6.1 -> 1.6.2
26.summary: Upgrade/patch xhprof to 0.9.4 for Moodle 3.4 release
description: Upgrade xhprof to 0.9.4 patch for PHP 7.2 compatibility (deprecated create_function() call)
27.summary: Upgrade Horde library for Moodle 3.4
description: We have previously closed several rounds of Horde upgrade because there were "no changes upstream". However it looks like horde stopped upgrading/maintaining "horde framework" and the same modules that we use can be taken from "horde core". It uses different versioning, the latest version is 2.30.2 (for comparision, we use version 5.2.7 or "horde framework"). Latest version of horde core includes changes that we need for PHP 7.2 compatibility. And the latest version of horde framework does not. ---- Horde library uses deprecated create_function and IDNA varaibles. For example, this is a fix for create_function regarding idn_to_ascii and idn_to_utf8, the code is very different upstream horde: and moodle:
|
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.2 upgrade
description: Moodle 3.2 scheduled release date: Monday 28 November 2016.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.2
description: According to the release process| moodle.org should be upgraded to the beta release one week prior to release.
2.summary: Upgrade learn.moodle.net to 3.2
description:
3.summary: Upgrade lang.moodle.org to 3.2
description:
4.summary: Upgrade school.demo.moodle.net to 3.2
description:
5.summary: Upgrade demo.moodle.net to 3.2
description:
6.summary: Upgrade dev.moodle.org to 3.2
description:
7.summary: Upgrade moodle.net to 3.2
description:
8.summary: Upgrade moodlemoot.org sites to 3.2
description:
9.summary: Upgrade download.moodle.org to 3.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 community sites 3.2 upgrade
description: Moodle 3.2 scheduled release date: Monday 28 November 2016.
### Response:
1.summary: Upgrade moodle.org to 3.2
description: According to the release process| moodle.org should be upgraded to the beta release one week prior to release.
2.summary: Upgrade learn.moodle.net to 3.2
description:
3.summary: Upgrade lang.moodle.org to 3.2
description:
4.summary: Upgrade school.demo.moodle.net to 3.2
description:
5.summary: Upgrade demo.moodle.net to 3.2
description:
6.summary: Upgrade dev.moodle.org to 3.2
description:
7.summary: Upgrade moodle.net to 3.2
description:
8.summary: Upgrade moodlemoot.org sites to 3.2
description:
9.summary: Upgrade download.moodle.org to 3.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: MoodleNet
summary: Admins and moderators can see information about instances and communities
description: Admins and moderators can see information about instances and communities.
| Solvable | 1.summary: Create a plan for MoodleNet analytics
description: At the US MoodleMoot, participants requested open analytics for MoodleNet. We should figure out what that means. Etherpad:
| 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: Admins and moderators can see information about instances and communities
description: Admins and moderators can see information about instances and communities.
### Response:
1.summary: Create a plan for MoodleNet analytics
description: At the US MoodleMoot, participants requested open analytics for MoodleNet. We should figure out what that means. Etherpad:
|
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: Activity chooser follow ups
description: As we are aiming to land the major chooser features under one epic we need somewhere to place the follow ups of small & trivial fixes that should not block the main components of work.
| Unsolvable | 1.summary: Improve favourites performance for the activity chooser
description: There are 2 parts to this: The first, is an addition to the existing API, to address a situation encountered in . This situation is when a component wishes to store favourites for an area using multiple different itemtype strings. In such a case, wed like to be able to get the favourites for all the item types at once - at present, this must be done via multiple API calls to find_favourites_by_type. The second is to update the calling code in content_item_readonly_repository, to use the single new API call instead of several calls in a loop (the current situation).
2.summary: Improve performance of course_section_add_cm_control()
description: This method is called once per course section and currently handles a few cases: If $THEME->enablecourseajax == true AND $course->id == $this->page->course->id AND $usermodchooser == true (a user pref), then display the "Add an activity or resource" link allowing the chooser modal to be opened. If $THEME->enablecourseajax == true AND $course->id == $this->page->course->id AND $usermodchooser == false (a user pref), then display fallback 1 - a control including two lists of resources and activities which, when selected, take the user to the creation page for that module. If $THEME->enablecourseajax == true AND $course->id != $this->page->course->id, then display fallback 1 - a control including two lists of resources and activities, which, when selected, take the user to the creation page for that module. If $THEME->enablecourseajax == false, then display fallback 1 - a control including two lists of resources and activities which, when selected, take the user to the creation page for that module. If JS is disabled in the browser (not a case we support any more), then fallback 2 is shown - a control including the same two lists of resources and activities plus a Go submit button. The user needs to select the activity/resource and then click Go in this fallback case. Fallback 1 and 2 are handled by the same code - its just that when loaded in a browser without js enabled, the Go button is shown (its inside a tag) The way this method is currently structured is such that we always generate the fallback control HTML. I.e. every time this method is called, which is once per course section, this is created. Then, if the theme supports course ajax (provided the course also matches the page course, as above), then we wrap that entire fallback HTML inside tags and append the link control to the output string before returning. I think we can clean this up. We dont have any obligation to support the "I disabled JS in my browser" case as we have been JS dependent for some time now. We should therefore be able to do one of two things depending only on the courseajax support: Render fallback control 1 in cases where: -- The theme sets $THEME->enablecourseajax to false or; -- $THEME->enablecourseajax is true but course doesnt match the this->page->course or; -- The user has disabled the modchooser in their user prefs. -- Were running in Behat, since many behat setup steps expect the step _I add a "x" to section "y" and I fill the form with_ to work without JS. Render the link control in cases where the $THEME->enablecourseajax is true and the course matches the $this->page->course and the user preference allows for the chooser. This would mean were likely going to reduce DB calls, and reduce the volume of code were running on every course home load - when editing is enabled, of course.
3.summary: Finalise the final layout of various Activity chooser elements
description: During the development of the activity chooser we have been focused on the functionality of the chooser and eye balling the designs. Here, we want to ensure we match the designs and handle any unexpected cases in the designs and make sure we handle the responsiveness of the modal and items within it. I can foresee some changes will have to be made as the original design had a reduced number of activities than we have in core so either scrolling or a larger modal will have to be used. Link to invisio here|
4.summary: Update language strings in the activity chooser
description: Based on review feedback we want to make the following changes because we do want to be able to talk about Activities and Resources (and in a separate issue introduce separate tabs for these): Rename the Add an activity link on the course page to Add an activity or resource Rename the Activity chooser title from Add an activity to Add an activity or resource Rename the Activities tab to All
5.summary: Introduce an Activities and Resources tab
description: Based on review feedback we want to make the following changes because we do want to be able to display activities and resources in their own individual tabs: Add a separate tab for just Activities and one for just Resources Tabs are to be ordered like this: Starred, All, Activities, Resources, Recommended Default tab to be open when the activity chooser opens: All If there are starred items then this tab should be show first. Otherwise the All tab should be show first. The recommended tab is now not part of the default focus workflow. Tab styling needs to be improved when they are stacked (e.g. you get 2 rows in a narrow screen) to make it clearer which tab you are on
6.summary: The search icon container in the activity chooser search bar should use bootstrap classes
description: The search icon container in the activity chooser search bar should use the existing bootstrap class (input-group-append) instead of creating a custom alternative one. (
7.summary: Add searching of the recommended activities admin page
description: Add the ability to search through all of the activities on the recommended activities admin page to narrow it down to a reasonable number, we will have thousands of entries on this page.
8.summary: Activity chooser modal should support the scrollable functionallity
description: A new functionality has been introduced in where modals can be configured to become scrollable (modals body) when the modals height exceeds the browsers height. Currently, scrollable is disabled for the Activity chooser modal as the modal does not support the scrollable functionality due to the existing min-height attribute in the modals body.
9.summary: Make activity chooser groups (of elements) clearer
description: Note: Maybe its only me, so get this issue with a pinch of salt. Every time I see the chooser, my brain has to become accommodated to the new distribution. At first sight its not clear which each group of elements is (icon, name, fav and info). !activity_chooser_better_grouping_needed.jpeg|thumbnail! Of course, at the end, its obvious that every fav and info belongs to the activity on top of them... but somehow its not immediate and, maybe clearer grouping may be needed. Posible solutions (from a chat) may include: - Better grouping by making in-group spacing narrower (and inter-group spacing bigger). - Use the cards display, so everything is clearly enclosed in a group. - ... And thats all, just a little detail / perception, maybe personal... but better tracked here. Ciao :-)
10.summary: Activity chooser should use existing :addinstance strings
description: For the activity chooser, right now "Add new" + modulename is hardcoded. But thats a string that is managed in localizations. The original string should be used.
11.summary: Further customisation of the activity chooser tabs
description: For consideration after the Moodle 3.9 release: Create a user preference to remember which tab the user was on last and display that next time the activity chooser is opened Create Activity chooser settings heading under Site Admin->Courses, with Activity chooser settings: List of tabs with checkboxes: Starred, Activities, Resources, Recommended. Default checked: Starred, Recommended. Recommended activities page Moodle out of the box shows Starred, All and Recommended by default. Further: Add an External tools tab which only appears when external tools are pre-configured Insert the External tools tab before the Recommended tab Create additional admin setting to enable/disable the external tools tab
| 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: Activity chooser follow ups
description: As we are aiming to land the major chooser features under one epic we need somewhere to place the follow ups of small & trivial fixes that should not block the main components of work.
### Response:
1.summary: Improve favourites performance for the activity chooser
description: There are 2 parts to this: The first, is an addition to the existing API, to address a situation encountered in . This situation is when a component wishes to store favourites for an area using multiple different itemtype strings. In such a case, wed like to be able to get the favourites for all the item types at once - at present, this must be done via multiple API calls to find_favourites_by_type. The second is to update the calling code in content_item_readonly_repository, to use the single new API call instead of several calls in a loop (the current situation).
2.summary: Improve performance of course_section_add_cm_control()
description: This method is called once per course section and currently handles a few cases: If $THEME->enablecourseajax == true AND $course->id == $this->page->course->id AND $usermodchooser == true (a user pref), then display the "Add an activity or resource" link allowing the chooser modal to be opened. If $THEME->enablecourseajax == true AND $course->id == $this->page->course->id AND $usermodchooser == false (a user pref), then display fallback 1 - a control including two lists of resources and activities which, when selected, take the user to the creation page for that module. If $THEME->enablecourseajax == true AND $course->id != $this->page->course->id, then display fallback 1 - a control including two lists of resources and activities, which, when selected, take the user to the creation page for that module. If $THEME->enablecourseajax == false, then display fallback 1 - a control including two lists of resources and activities which, when selected, take the user to the creation page for that module. If JS is disabled in the browser (not a case we support any more), then fallback 2 is shown - a control including the same two lists of resources and activities plus a Go submit button. The user needs to select the activity/resource and then click Go in this fallback case. Fallback 1 and 2 are handled by the same code - its just that when loaded in a browser without js enabled, the Go button is shown (its inside a tag) The way this method is currently structured is such that we always generate the fallback control HTML. I.e. every time this method is called, which is once per course section, this is created. Then, if the theme supports course ajax (provided the course also matches the page course, as above), then we wrap that entire fallback HTML inside tags and append the link control to the output string before returning. I think we can clean this up. We dont have any obligation to support the "I disabled JS in my browser" case as we have been JS dependent for some time now. We should therefore be able to do one of two things depending only on the courseajax support: Render fallback control 1 in cases where: -- The theme sets $THEME->enablecourseajax to false or; -- $THEME->enablecourseajax is true but course doesnt match the this->page->course or; -- The user has disabled the modchooser in their user prefs. -- Were running in Behat, since many behat setup steps expect the step _I add a "x" to section "y" and I fill the form with_ to work without JS. Render the link control in cases where the $THEME->enablecourseajax is true and the course matches the $this->page->course and the user preference allows for the chooser. This would mean were likely going to reduce DB calls, and reduce the volume of code were running on every course home load - when editing is enabled, of course.
3.summary: Finalise the final layout of various Activity chooser elements
description: During the development of the activity chooser we have been focused on the functionality of the chooser and eye balling the designs. Here, we want to ensure we match the designs and handle any unexpected cases in the designs and make sure we handle the responsiveness of the modal and items within it. I can foresee some changes will have to be made as the original design had a reduced number of activities than we have in core so either scrolling or a larger modal will have to be used. Link to invisio here|
4.summary: Update language strings in the activity chooser
description: Based on review feedback we want to make the following changes because we do want to be able to talk about Activities and Resources (and in a separate issue introduce separate tabs for these): Rename the Add an activity link on the course page to Add an activity or resource Rename the Activity chooser title from Add an activity to Add an activity or resource Rename the Activities tab to All
5.summary: Introduce an Activities and Resources tab
description: Based on review feedback we want to make the following changes because we do want to be able to display activities and resources in their own individual tabs: Add a separate tab for just Activities and one for just Resources Tabs are to be ordered like this: Starred, All, Activities, Resources, Recommended Default tab to be open when the activity chooser opens: All If there are starred items then this tab should be show first. Otherwise the All tab should be show first. The recommended tab is now not part of the default focus workflow. Tab styling needs to be improved when they are stacked (e.g. you get 2 rows in a narrow screen) to make it clearer which tab you are on
6.summary: The search icon container in the activity chooser search bar should use bootstrap classes
description: The search icon container in the activity chooser search bar should use the existing bootstrap class (input-group-append) instead of creating a custom alternative one. (
7.summary: Add searching of the recommended activities admin page
description: Add the ability to search through all of the activities on the recommended activities admin page to narrow it down to a reasonable number, we will have thousands of entries on this page.
8.summary: Activity chooser modal should support the scrollable functionallity
description: A new functionality has been introduced in where modals can be configured to become scrollable (modals body) when the modals height exceeds the browsers height. Currently, scrollable is disabled for the Activity chooser modal as the modal does not support the scrollable functionality due to the existing min-height attribute in the modals body.
9.summary: Make activity chooser groups (of elements) clearer
description: Note: Maybe its only me, so get this issue with a pinch of salt. Every time I see the chooser, my brain has to become accommodated to the new distribution. At first sight its not clear which each group of elements is (icon, name, fav and info). !activity_chooser_better_grouping_needed.jpeg|thumbnail! Of course, at the end, its obvious that every fav and info belongs to the activity on top of them... but somehow its not immediate and, maybe clearer grouping may be needed. Posible solutions (from a chat) may include: - Better grouping by making in-group spacing narrower (and inter-group spacing bigger). - Use the cards display, so everything is clearly enclosed in a group. - ... And thats all, just a little detail / perception, maybe personal... but better tracked here. Ciao :-)
10.summary: Activity chooser should use existing :addinstance strings
description: For the activity chooser, right now "Add new" + modulename is hardcoded. But thats a string that is managed in localizations. The original string should be used.
11.summary: Further customisation of the activity chooser tabs
description: For consideration after the Moodle 3.9 release: Create a user preference to remember which tab the user was on last and display that next time the activity chooser is opened Create Activity chooser settings heading under Site Admin->Courses, with Activity chooser settings: List of tabs with checkboxes: Starred, Activities, Resources, Recommended. Default checked: Starred, Recommended. Recommended activities page Moodle out of the box shows Starred, All and Recommended by default. Further: Add an External tools tab which only appears when external tools are pre-configured Insert the External tools tab before the Recommended tab Create additional admin setting to enable/disable the external tools tab
|
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.9
description: In 3.9 we can remove functionality that was deprecated in 3.5 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: CLONE - Update windows timezone list in core_date
description: Update lib/classes/date.php badzones to the latest time zone information. should translate over to Use the IANA timezone information database - Please create a clone of this issue for next version before closing this
2.summary: Deprecate enrol_database_admin_setting_category class
description: Working on we realize enrol_database_admin_setting_category class could be deprecated and admin_settings_coursecat_select used instead.
3.summary: Remove titlestr and titlecomponent from replaceSectionActionItem and replaceActionItem methods in course/amd/src/actions.js
description: In the titlestr and titlecomponent from replaceSectionActionItem and replaceActionItem methods in course/amd/src/actions.js are not used anymore. For now, a comment has been added to the replaceActionItem jsdoc, but some deprecation process should be raised for them to make sure the legacy code is cleaned at some point.
4.summary: Deprecation of legacy cron
description: In we introduced the scheduled tasks system and making use of this system and moving away from legacy cron brings a lot of benefits (admin configurable times, tasks prevented from interfering with each other etc etc). We should eventually move away from legacy cron and deprecate that system in favour of everything using scheduled tasks.
5.summary: Remove strings deprecated in 3.5
description: Remove strings from language files under the heading "Deprecated in Moodle 3.5" and the respective lines in deprecated.txt files See also
6.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.5
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.5 should be replaced with exceptions in 3.9 This includes all functions in lib/deprecatedlib.php that say since 3.5: question_add_tops question_is_only_toplevel_category_in_context message_move_userfrom_unread2read message_get_blocked_users message_get_contacts message_mark_message_read message_can_delete_message message_delete_message
7.summary: Remove behat steps deprecated in 3.5
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.5 (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
8.summary: Final deprecation of mark_all_read_for_user in message/classes/api.php
description: This was deprecated in 3.5, get rid of it.
9.summary: CLONE - 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.
10.summary: deprecate plagiarism_get_form_elements()
description: we should deprecate plagiarism_get_form_elements() and recommend the use of the coursemodule callbacks (added in 3.1) The "replacement" function would be to use plagiarism_get_form_elements - but by using callbacks plugin devs can also hook into the validation/edit_post_actions functions as well which wasnt possible using plagiarism_get_form_elements
11.summary: Deprecate dupe cron_run_single_task() function
description: Working on we created a new class that does cron_run_single_task() never used again in the core.
12.summary: Deprecate and fix plagiarismlib use of config vars
description: plagiarismlib.php plagiarism_load_available_plugins() doesnt use config consistently with other plugin types. get_config(plagiarism, $plugin."_use") we should deprecate this style of storing the details of enabled plagiarism plugins with something more like: get_config(plagiarism_. $plugin, enabled) so that we are storing plugin settings within their own frankenstyle namespace instead of in the "global" "plagiarism" plugin space. we should be checking if that old var exists and if so, throw a debug notice - the plagiarism plugin developer should be responsible for migrating to the new method and deleting the old var from the db.
| 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.9
description: In 3.9 we can remove functionality that was deprecated in 3.5 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: CLONE - Update windows timezone list in core_date
description: Update lib/classes/date.php badzones to the latest time zone information. should translate over to Use the IANA timezone information database - Please create a clone of this issue for next version before closing this
2.summary: Deprecate enrol_database_admin_setting_category class
description: Working on we realize enrol_database_admin_setting_category class could be deprecated and admin_settings_coursecat_select used instead.
3.summary: Remove titlestr and titlecomponent from replaceSectionActionItem and replaceActionItem methods in course/amd/src/actions.js
description: In the titlestr and titlecomponent from replaceSectionActionItem and replaceActionItem methods in course/amd/src/actions.js are not used anymore. For now, a comment has been added to the replaceActionItem jsdoc, but some deprecation process should be raised for them to make sure the legacy code is cleaned at some point.
4.summary: Deprecation of legacy cron
description: In we introduced the scheduled tasks system and making use of this system and moving away from legacy cron brings a lot of benefits (admin configurable times, tasks prevented from interfering with each other etc etc). We should eventually move away from legacy cron and deprecate that system in favour of everything using scheduled tasks.
5.summary: Remove strings deprecated in 3.5
description: Remove strings from language files under the heading "Deprecated in Moodle 3.5" and the respective lines in deprecated.txt files See also
6.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.5
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.5 should be replaced with exceptions in 3.9 This includes all functions in lib/deprecatedlib.php that say since 3.5: question_add_tops question_is_only_toplevel_category_in_context message_move_userfrom_unread2read message_get_blocked_users message_get_contacts message_mark_message_read message_can_delete_message message_delete_message
7.summary: Remove behat steps deprecated in 3.5
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.5 (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
8.summary: Final deprecation of mark_all_read_for_user in message/classes/api.php
description: This was deprecated in 3.5, get rid of it.
9.summary: CLONE - 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.
10.summary: deprecate plagiarism_get_form_elements()
description: we should deprecate plagiarism_get_form_elements() and recommend the use of the coursemodule callbacks (added in 3.1) The "replacement" function would be to use plagiarism_get_form_elements - but by using callbacks plugin devs can also hook into the validation/edit_post_actions functions as well which wasnt possible using plagiarism_get_form_elements
11.summary: Deprecate dupe cron_run_single_task() function
description: Working on we created a new class that does cron_run_single_task() never used again in the core.
12.summary: Deprecate and fix plagiarismlib use of config vars
description: plagiarismlib.php plagiarism_load_available_plugins() doesnt use config consistently with other plugin types. get_config(plagiarism, $plugin."_use") we should deprecate this style of storing the details of enabled plagiarism plugins with something more like: get_config(plagiarism_. $plugin, enabled) so that we are storing plugin settings within their own frankenstyle namespace instead of in the "global" "plagiarism" plugin space. we should be checking if that old var exists and if so, throw a debug notice - the plagiarism plugin developer should be responsible for migrating to the new method and deleting the old var from the db.
|
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.5
description: In 3.5 we can remove functionality that was deprecated in 3.1 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.5. 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 events_trigger()
description: Its been deprecated since 2.6. Debugging message was added in 3.1, therefore final deprecation should happen in 3.5 See
2.summary: Remove events_trigger_legacy() for groups from core
description: Some events_trigger() were left for backwards compatibility because they cannot be replaced by a new event as they are _wrong_ (bulk events). They should be removed during 2.7-dev for 2.8 release. See group/lib.php: - groups_delete_group_members() > groups_members_removed - groups_delete_groupings_groups() > groups_groupings_groups_removed - groups_delete_groups() > groups_groups_deleted - groups_delete_groupings() > groups_groupings_deleted code $ git grep group/lib.php: // TODO Remove events_trigger_legacy(groups_members_removed). group/lib.php: // TODO Remove events_trigger_legacy(groups_groupings_groups_removed). group/lib.php: // TODO Remove events_trigger_legacy(groups_groups_deleted). group/lib.php: // TODO Remove events_trigger_legacy(groups_groupings_deleted). code
3.summary: Final deprecation of notify()
description: Final deprecation of notify()
4.summary: Update windows timezone list in core_date
description: Update lib/classes/date.php badzones to the latest time zone information. should translate over to Use the IANA timezone information database - Please create a clone of this issue for next version before closing this
5.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.1
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.1 should be replaced with exceptions in 3.5 This includes all functions in lib/deprecatedlib.php that say since 3.1 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.5- please list them in this issue description_
6.summary: Remove strings deprecated in 3.1
description: Remove strings from language files under the heading "Deprecated in Moodle 3.1" and the respective lines in deprecated.txt files See also
7.summary: Deprecate the legacy log store
description: Deprecate the actual legacy log store class.
8.summary: Remove deprecated \core\output\notification constants following
description: Deprecate: lib/classes/output/notification.php NOTIFY_PROBLEM: NOTIFY_REDIRECT: NOTIFY_MESSAGE:
9.summary: Final deprecation of course_scale_used() and site_scale_used
description: Following the changes in
10.summary: Drop support for module callback get_types() in 3.5
description: Deprecated under in Moodle 3.1 Also drop support for similar ltisource callback.
11.summary: Final deprecation of external_function_info() in 3.5.
description: What it says.
12.summary: Phase 2 of deprecation of functions in mod/feedback/lib.php
description: Remove all functions from mod/feedback/lib.php that were deprecated in Moodle 3.1
13.summary: Drop database table events_queue_handlers
description: Used in functions deprecated in 3.1 Make sure nothing uses this table first!
14.summary: Final deprecation of the old Events API
description: events_cron events_dispatch events_is_registered events_load_def events_pending_count events_process_queued_handler events_queue_handler events_trigger_legacy events_update_definition
15.summary: Deprecate behat step: I navigate to "ITEM" node in "MAINNODE > PATH"
description: See -- about what it should be replaced with We need to deprecate step: I navigate to "ITEM" node in "MAINNODE > PATH" and use one of the following steps instead: I navigate to "PATH > ITEM" in current page administration I navigate to "PATH > ITEM" in site administration I navigate to course participants I navigate to "TAB1 > TAB2" in the course gradebook All these steps will work with both Clean theme (using Navigation/Administration blocks) and Boost theme (using flat navigation drawer and page edit cog). If some items are not available without Navigation block at all, one can use combination of: I add the "Navigation" block if not present I click on "LINK" "link" in the "Navigation" "block" See
16.summary: Remove behat steps deprecated in 3.1
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.1 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: Deprecate dupe get_roles_on_exact_context|with_assignment_on_context() function
description: While working on we detected that, actually, there are 2 accesslib methods to fetch the roles used at an exact context: - get_roles_on_exact_context() - get_roles_with_assignment_on_context() In the other side, for fetch all the roles used in a context (including parents) is: - get_roles_used_in_context() Right now there isnt any use in core of any of the "exact" functions. This is about to decide what to do: 1) Deprecate the 2 "exact context" functions and add the "including parents" one to also support "exact context" 2) Deprecate one of the 2 "exact context", leaving the other. If so, Id propose to deprecate the get_roles_with_assignment_on_context() because its less clear.
18.summary: Final deprecation of events_trigger_legacy()
description: Its been deprecated since 3.1. This is intended to be used from new event base only and its related with events_trigger.
| 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.5
description: In 3.5 we can remove functionality that was deprecated in 3.1 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.5. 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 events_trigger()
description: Its been deprecated since 2.6. Debugging message was added in 3.1, therefore final deprecation should happen in 3.5 See
2.summary: Remove events_trigger_legacy() for groups from core
description: Some events_trigger() were left for backwards compatibility because they cannot be replaced by a new event as they are _wrong_ (bulk events). They should be removed during 2.7-dev for 2.8 release. See group/lib.php: - groups_delete_group_members() > groups_members_removed - groups_delete_groupings_groups() > groups_groupings_groups_removed - groups_delete_groups() > groups_groups_deleted - groups_delete_groupings() > groups_groupings_deleted code $ git grep group/lib.php: // TODO Remove events_trigger_legacy(groups_members_removed). group/lib.php: // TODO Remove events_trigger_legacy(groups_groupings_groups_removed). group/lib.php: // TODO Remove events_trigger_legacy(groups_groups_deleted). group/lib.php: // TODO Remove events_trigger_legacy(groups_groupings_deleted). code
3.summary: Final deprecation of notify()
description: Final deprecation of notify()
4.summary: Update windows timezone list in core_date
description: Update lib/classes/date.php badzones to the latest time zone information. should translate over to Use the IANA timezone information database - Please create a clone of this issue for next version before closing this
5.summary: Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.1
description: As per all functions in lib/deprecatedlib.php that were deprecated in 3.1 should be replaced with exceptions in 3.5 This includes all functions in lib/deprecatedlib.php that say since 3.1 _If any functions from this file do not have this comment but also need to be finally deprecated in 3.5- please list them in this issue description_
6.summary: Remove strings deprecated in 3.1
description: Remove strings from language files under the heading "Deprecated in Moodle 3.1" and the respective lines in deprecated.txt files See also
7.summary: Deprecate the legacy log store
description: Deprecate the actual legacy log store class.
8.summary: Remove deprecated \core\output\notification constants following
description: Deprecate: lib/classes/output/notification.php NOTIFY_PROBLEM: NOTIFY_REDIRECT: NOTIFY_MESSAGE:
9.summary: Final deprecation of course_scale_used() and site_scale_used
description: Following the changes in
10.summary: Drop support for module callback get_types() in 3.5
description: Deprecated under in Moodle 3.1 Also drop support for similar ltisource callback.
11.summary: Final deprecation of external_function_info() in 3.5.
description: What it says.
12.summary: Phase 2 of deprecation of functions in mod/feedback/lib.php
description: Remove all functions from mod/feedback/lib.php that were deprecated in Moodle 3.1
13.summary: Drop database table events_queue_handlers
description: Used in functions deprecated in 3.1 Make sure nothing uses this table first!
14.summary: Final deprecation of the old Events API
description: events_cron events_dispatch events_is_registered events_load_def events_pending_count events_process_queued_handler events_queue_handler events_trigger_legacy events_update_definition
15.summary: Deprecate behat step: I navigate to "ITEM" node in "MAINNODE > PATH"
description: See -- about what it should be replaced with We need to deprecate step: I navigate to "ITEM" node in "MAINNODE > PATH" and use one of the following steps instead: I navigate to "PATH > ITEM" in current page administration I navigate to "PATH > ITEM" in site administration I navigate to course participants I navigate to "TAB1 > TAB2" in the course gradebook All these steps will work with both Clean theme (using Navigation/Administration blocks) and Boost theme (using flat navigation drawer and page edit cog). If some items are not available without Navigation block at all, one can use combination of: I add the "Navigation" block if not present I click on "LINK" "link" in the "Navigation" "block" See
16.summary: Remove behat steps deprecated in 3.1
description: go through lib/tests/behat/behat_deprecated.php and remove steps that were deprecated in Moodle 3.1 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: Deprecate dupe get_roles_on_exact_context|with_assignment_on_context() function
description: While working on we detected that, actually, there are 2 accesslib methods to fetch the roles used at an exact context: - get_roles_on_exact_context() - get_roles_with_assignment_on_context() In the other side, for fetch all the roles used in a context (including parents) is: - get_roles_used_in_context() Right now there isnt any use in core of any of the "exact" functions. This is about to decide what to do: 1) Deprecate the 2 "exact context" functions and add the "including parents" one to also support "exact context" 2) Deprecate one of the 2 "exact context", leaving the other. If so, Id propose to deprecate the get_roles_with_assignment_on_context() because its less clear.
18.summary: Final deprecation of events_trigger_legacy()
description: Its been deprecated since 3.1. This is intended to be used from new event base only and its related with events_trigger.
|
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: EpicEvent monitor follow up issues
description: From poltawski on : In subscriptions the module instance thing is weird. I really feel like this is fundamentally designed wrong. Surely it should be a context, it seems weirdly hardcoded to module instance. See this screenshot: !werd_module_instance.png|thumbnail! As seen in screenshot, it doesnt apply to a core event like comment created and you get an empty select box. Which is also crazy, because I would love to know when a comment is created in a specific module. But I cant. Would be better described as something else. Limited to activity/resource? Select as the title in Rules you can subscribe to sucks a bit The Select the plugin type selector needs better UX Its silly that Book IMS CP export sites on the same level as Core A teacher has no idea what Core means Core should almost certainly be split up into components Big long dropdowns suck really. There is no way for an administrator to see all the event monitoring rules going on. There is no way other than going into each individual course. The ad-hoc tasks should output more information about what its doing. If a site gets crippled by someone setting up the monitoring, there needs to be a way to work out whats causing it. i.e. which monitoring events are running etc. The navigation structure is confusing. Even just a plain link under the rules table table to get to your notification settings would be useful and vice versa. Needs something because each are useless without the other and its not clear. As a teacher I get the edit links to manage site rules and then get presented with a permissions error. There are no indciations about what rules are site rules and what are course rules. When deleting a rule we end up at actionable url, this bad practice (try refreshing the page). Should be a POST, but definitely shouldnt be able to refresh and end up with a database error. Havent checked the extent of this problem, but also saw it on the subscription page. e.g.: I didnt underestand what Frequency of events was, the help string didnt help me. But then I read the setting below - that could be made better I think (putting both on one line, for example - maybe someone has a better idea. We could perhaps generalise both those into something more understandable. I feel we could make it more straight forward than it is. The help strings need review. e.g Select a plugin that you are interested in monitoring. The event list below would be updated to display events from the selected plugin. From dobedobedoh on : .Rules page Manage section - should this perhaps be an action menu instead of icons? Uneven spacing for the "X" link. No redirect after duplicating or deleting .Add new rule form Frequency selector should allow other time periods e.g. hours
| Unsolvable | 1.summary: Event monitor: Create examples of templates
description: When writing a rule for the event manager, a user can make use of placeholders in their template. There is a help string that lists the placeholders with a brief description. With this help string there should also be a link to additional information on the Moodle User Docs. In preparation for this User Docs template information page, template examples including placeholders should be written. Before they are copied to the User Docs they can be written in/with the specification doc in the Dev Docs.
2.summary: Event monitor: Review all strings and the UI in tool_monitor
description: Once the tool is done, review all strings in the report and make sure they are correct and consistent with rest of Moodle.
3.summary: Add more debugging info to the adhoc task.
description: Tool_monitor can display some more info while running the adhoc tasks.
| 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: EpicEvent monitor follow up issues
description: From poltawski on : In subscriptions the module instance thing is weird. I really feel like this is fundamentally designed wrong. Surely it should be a context, it seems weirdly hardcoded to module instance. See this screenshot: !werd_module_instance.png|thumbnail! As seen in screenshot, it doesnt apply to a core event like comment created and you get an empty select box. Which is also crazy, because I would love to know when a comment is created in a specific module. But I cant. Would be better described as something else. Limited to activity/resource? Select as the title in Rules you can subscribe to sucks a bit The Select the plugin type selector needs better UX Its silly that Book IMS CP export sites on the same level as Core A teacher has no idea what Core means Core should almost certainly be split up into components Big long dropdowns suck really. There is no way for an administrator to see all the event monitoring rules going on. There is no way other than going into each individual course. The ad-hoc tasks should output more information about what its doing. If a site gets crippled by someone setting up the monitoring, there needs to be a way to work out whats causing it. i.e. which monitoring events are running etc. The navigation structure is confusing. Even just a plain link under the rules table table to get to your notification settings would be useful and vice versa. Needs something because each are useless without the other and its not clear. As a teacher I get the edit links to manage site rules and then get presented with a permissions error. There are no indciations about what rules are site rules and what are course rules. When deleting a rule we end up at actionable url, this bad practice (try refreshing the page). Should be a POST, but definitely shouldnt be able to refresh and end up with a database error. Havent checked the extent of this problem, but also saw it on the subscription page. e.g.: I didnt underestand what Frequency of events was, the help string didnt help me. But then I read the setting below - that could be made better I think (putting both on one line, for example - maybe someone has a better idea. We could perhaps generalise both those into something more understandable. I feel we could make it more straight forward than it is. The help strings need review. e.g Select a plugin that you are interested in monitoring. The event list below would be updated to display events from the selected plugin. From dobedobedoh on : .Rules page Manage section - should this perhaps be an action menu instead of icons? Uneven spacing for the "X" link. No redirect after duplicating or deleting .Add new rule form Frequency selector should allow other time periods e.g. hours
### Response:
1.summary: Event monitor: Create examples of templates
description: When writing a rule for the event manager, a user can make use of placeholders in their template. There is a help string that lists the placeholders with a brief description. With this help string there should also be a link to additional information on the Moodle User Docs. In preparation for this User Docs template information page, template examples including placeholders should be written. Before they are copied to the User Docs they can be written in/with the specification doc in the Dev Docs.
2.summary: Event monitor: Review all strings and the UI in tool_monitor
description: Once the tool is done, review all strings in the report and make sure they are correct and consistent with rest of Moodle.
3.summary: Add more debugging info to the adhoc task.
description: Tool_monitor can display some more info while running the adhoc tasks.
|
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: Improvements and refactors in Web Services for Moodle 3.0
description: META issue for adding tasks with all the improvements and refactors to do in the Web Services layer for Moodle 3.0
| Unsolvable | 1.summary: Apply the new groups_user_groups_visible() where possible
description: With a new function was introduced to check if the current user ($USER) has any group in common with a give user ($userid). That calculation is used in many places to decide when 2 users can perform various actions between them. Right now that calculation is done "manually" everywhere (messaging, completion, restore...). This is about to apply the new groups_user_groups_visible() function in all those places, leading to less duplicate code and unified logic. Thats it. Ciao :-)
2.summary: External services does not support gravatar profile image URLS
description: External functions usually creates the user profile image using moodle_url::make_pluginfile_url( $usercontext->id, user, icon, null, /, f1); or moodle_url::make_webservice_pluginfile_url( $usercontext->id, user, icon, null, /, f1); As mentioned in the user_picture class method get_url should be used
3.summary: Review external_format_text() implementation details
description: As mentioned in external_format_text function can be improved (mostly the way returned text is cleaned) I was thinking in adding a new option for allowing noclean = true, mostly for backwards compatibility, but of course noclean will be equal to false by default. Note that in some cases we could assume that the text is trusted (it was introduced by a teacher) so it can make sense in some cases to allow noclean = true.
4.summary: Decide if we should have a external_format_string function
description: Currently strings like course or activity names that supports filteres are returned raw (without formatting)
5.summary: Allow external functions to add themselves into services
description: Pre-built services are good, but they have limitations: - You cannot add new functions (it will require modify the lib/db/services.php and upgrade the site) - You cannot add new functions via add-ons We need to allow admins (and plugins) to add and remove existing functions, in this way it will be possible to: - Create standard Moodle plugins that add new functions (or remove) to the Mobile service For the record, the functionality that finally was implemented was: - Add a new attribute "services" in the external functions declaration (/db/services.php file), in this attribute you can now indicate a list of prebuilt services where do you want to add the function. In this way, via a contributed plugins you can add external functions to the official mobile service to extends its functionality. This also has the advantage that now Moodle plugins are self-containing. The plugins are responsible of adding their functions to the service (previously, the core services had the plugins external functions hardcoded)
6.summary: Review web services design and reduce required boilerplate code
description: We discussed in scrum how web services structure has been extensively used by mobile and now learning plans when their initial purpose was to expose part of the moodle APIs for external systems to synchronize data. Performance was probably not a critical point when ws were developed, as enrolling users, creating courses... were cronjob actions running in daily basis, but it is now that learning plans or mobile are extensively using them, as the user experience depends on the time the user waits for the ws to return the required data. We should review the execution flow and detect things like . The current code requirements to add a web service function suggest that it was not expected that we would make that extensive use, a big part of what we define in _parameters() and _returns() could be abstracted (same for the new _is_allowed_from_ajax). I would propose to extend the db/services.php parameters of a ws function to allow (not require as we will not always be able to do it) things like: Flag if it is allowed for ajax or not Add _parameters() and _returns() structures (until a certain point) the code that will automatically manage this would be smart enough to autoload a (for example) \tool_lp\external::get_competency_external_structure() Specify api calls, autoload helps here (probably better explained in the example below) I propose these changes so we dont need to add 100 or 200 lines of code (that we will have to maintain) every time we want to expose something as simple as the code below: code // Current dev \tool_lp\external::create_competency_framework() // validate_parameters could run internally $result = api::create_framework($params); return $result->to_record(); code We could instead define something like code $functions = array( tool_lp_create_competency_framework => array( classname => tool_lp\external, methodname => create_competency_framework, classpath => , description => Creates new competency frameworks., type => write, capabilities=> tool/lp:competencymanage, allowsajax => true, parameters => get_competency_framework_structure, returns => get_competency_framework_structure ) ) // get_competency_framework_structure should be a classname function // Not sure yet how to automate the api::create_framework() as, in any case, we should not include PHP code on a declaration file. Actually this is what this issue is about, how to abstract these things. With mobile and learning plans we have enough examples of what we might need. code Im creating 1 single issue to review this all as what we can abstract depends partially of the functionality we support. In any case, all these services.php "shortcuts" should be optional, as ws functions should be as flexible as they currently are. Mobile team comments and suggestions would be appreciated as they are currently the main ws consumer. Having this centralized and moodle API-oriented way to expose moodle funtionalities would encourage us to reuse or refactor moodles APIs instead of duplicating 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: META: Improvements and refactors in Web Services for Moodle 3.0
description: META issue for adding tasks with all the improvements and refactors to do in the Web Services layer for Moodle 3.0
### Response:
1.summary: Apply the new groups_user_groups_visible() where possible
description: With a new function was introduced to check if the current user ($USER) has any group in common with a give user ($userid). That calculation is used in many places to decide when 2 users can perform various actions between them. Right now that calculation is done "manually" everywhere (messaging, completion, restore...). This is about to apply the new groups_user_groups_visible() function in all those places, leading to less duplicate code and unified logic. Thats it. Ciao :-)
2.summary: External services does not support gravatar profile image URLS
description: External functions usually creates the user profile image using moodle_url::make_pluginfile_url( $usercontext->id, user, icon, null, /, f1); or moodle_url::make_webservice_pluginfile_url( $usercontext->id, user, icon, null, /, f1); As mentioned in the user_picture class method get_url should be used
3.summary: Review external_format_text() implementation details
description: As mentioned in external_format_text function can be improved (mostly the way returned text is cleaned) I was thinking in adding a new option for allowing noclean = true, mostly for backwards compatibility, but of course noclean will be equal to false by default. Note that in some cases we could assume that the text is trusted (it was introduced by a teacher) so it can make sense in some cases to allow noclean = true.
4.summary: Decide if we should have a external_format_string function
description: Currently strings like course or activity names that supports filteres are returned raw (without formatting)
5.summary: Allow external functions to add themselves into services
description: Pre-built services are good, but they have limitations: - You cannot add new functions (it will require modify the lib/db/services.php and upgrade the site) - You cannot add new functions via add-ons We need to allow admins (and plugins) to add and remove existing functions, in this way it will be possible to: - Create standard Moodle plugins that add new functions (or remove) to the Mobile service For the record, the functionality that finally was implemented was: - Add a new attribute "services" in the external functions declaration (/db/services.php file), in this attribute you can now indicate a list of prebuilt services where do you want to add the function. In this way, via a contributed plugins you can add external functions to the official mobile service to extends its functionality. This also has the advantage that now Moodle plugins are self-containing. The plugins are responsible of adding their functions to the service (previously, the core services had the plugins external functions hardcoded)
6.summary: Review web services design and reduce required boilerplate code
description: We discussed in scrum how web services structure has been extensively used by mobile and now learning plans when their initial purpose was to expose part of the moodle APIs for external systems to synchronize data. Performance was probably not a critical point when ws were developed, as enrolling users, creating courses... were cronjob actions running in daily basis, but it is now that learning plans or mobile are extensively using them, as the user experience depends on the time the user waits for the ws to return the required data. We should review the execution flow and detect things like . The current code requirements to add a web service function suggest that it was not expected that we would make that extensive use, a big part of what we define in _parameters() and _returns() could be abstracted (same for the new _is_allowed_from_ajax). I would propose to extend the db/services.php parameters of a ws function to allow (not require as we will not always be able to do it) things like: Flag if it is allowed for ajax or not Add _parameters() and _returns() structures (until a certain point) the code that will automatically manage this would be smart enough to autoload a (for example) \tool_lp\external::get_competency_external_structure() Specify api calls, autoload helps here (probably better explained in the example below) I propose these changes so we dont need to add 100 or 200 lines of code (that we will have to maintain) every time we want to expose something as simple as the code below: code // Current dev \tool_lp\external::create_competency_framework() // validate_parameters could run internally $result = api::create_framework($params); return $result->to_record(); code We could instead define something like code $functions = array( tool_lp_create_competency_framework => array( classname => tool_lp\external, methodname => create_competency_framework, classpath => , description => Creates new competency frameworks., type => write, capabilities=> tool/lp:competencymanage, allowsajax => true, parameters => get_competency_framework_structure, returns => get_competency_framework_structure ) ) // get_competency_framework_structure should be a classname function // Not sure yet how to automate the api::create_framework() as, in any case, we should not include PHP code on a declaration file. Actually this is what this issue is about, how to abstract these things. With mobile and learning plans we have enough examples of what we might need. code Im creating 1 single issue to review this all as what we can abstract depends partially of the functionality we support. In any case, all these services.php "shortcuts" should be optional, as ws functions should be as flexible as they currently are. Mobile team comments and suggestions would be appreciated as they are currently the main ws consumer. Having this centralized and moodle API-oriented way to expose moodle funtionalities would encourage us to reuse or refactor moodles APIs instead of duplicating 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: A list of issues related to communication between MoodleNet and moodle
description: This epic encapsulates work that needs to be done to have communication between MoodleNet and moodle. This spans from sending users to MoodleNet to receiving files and links from the MoodleNet platform. Our initial focus is basic links to MoodleNet and receiving standard files and links to merge into courses for 3.9. There is a mockup available here|
| Unsolvable | 1.summary: Create mod_moodlenet activity (mod_moodlenet 3.7 and 3.8)
description: This plugin is part of a set (the set also includes an admin tool, tool_moodlenet) to be provided, via the plugins db, to sites on versions 3.7 and 3.8 of Moodle. Acceptance criteria: A minimal plugin which: Provides an implementation of get_shortcuts(), providing one single resource called MoodleNet with relevant explanatory text in the description (text TBC). Provides a modified edit_form.php, which just redirects to a MoodleNet url (with params) instead of loading up the normal mod edit form. This allows the chooser to present the required MoodleNet item to the users, and allows them to be sent to MoodleNet via the edit_form.php page. The edit_form.php page asks the tool_moodlenet plugin (part of a set) for the MoodleNet URL for a given user and uses this link in redirection. mod_moodlenet: Fix edit.php so it correctly uses section and not sr (annoyingly, section return is something else entirely). Passes unit tests relating to privacy and is ready for deployment to the plugins DB.
2.summary: Add links to MoodleNet in Moodle (master)
description: The desire is to guide users to MoodleNet via the activity chooser. The following users stories outline the areas to introduce these links. ||User story||Approach|| |As a teacher (in Moodle) I can navigate to MoodleNet from the Activity Chooser, so I can find content for my course|See UX designs - there is a link in the footer, as well as another carousel pane, depending on whether the user has added a MoodleNet account on their profile or not.| |-As a teacher (in Moodle) I can navigate to MoodleNet from an empty course page, so I can find content for my course-|-On a blank course page I am presented with:- -Description of what I can find on MoodleNet, and that I will be directed out of the Moodle site- -A link to MoodleNet-| |-As a teacher (in Moodle) I can navigate to MoodleNet from the course gear menu, so I can find content for my course-|-The course gear menu has an item that links to MoodleNet-| |-As a teacher (in Moodle) I can enter my MoodleNet profile URL on my profile page, so people can find my MoodleNet profile page from Moodle- Handled in .|-An editable field for MoodleNet profile URL on the Moodle profile page- -A link to the MoodleNet profile- -MoodleNet instance URL to be derived from the profile URL-| . Acceptance Criteria: There should be an admin setting (in adv features for now) "Enable MoodleNet integration", defaulting to enabled. When the integration is enabled, there should be an image link in the footer of the activity chooser as per the mockups. If the tool_moodlenet plugin is uninstalled (a possibility), then the link should just be a link to the MoodleNet site (checking the users profile for a site as needed). This WILL NOT call the MoodleNet endpoint. If the tool_moodlenet plugin is installed and the user DOES NOT HAVE a saved MoodleNet profile URL in their user profile, then the link will trigger a load of the MoodleNet selection pane in the chooser - as per UX mocks. If a user enters a profile URL at this step, this is saved to their profile and this pane should not be seen again (again, as per UX mocks). If the tool_moodlenet plugin is installed and the user DOES HAVE a saved MoodleNet profile URL in their user profile, then the link will be to the MoodleNet endpoint and will include the params: The Moodle site URL (e.g. my.moodle.org) The Moodle endpoint path (admin/tool/moodlenetendpoint.php) When the integration is disabled, there should be no link in the activity chooser footer.
3.summary: Import API: create the file_extension_register contract
description: Create the file_extension_register interface. This should have: A method register_extensions which returns all extensions supported by the implementing class, and their lang string descriptors. E.g. png => what is going to happen when this module processes the png . This could be an array or a formal object - time permitting. Note: objects in plugins only implement this contract when they want to support at least one file extension, however, we need to provide a way that this method can return all known extensions . Whether that be via a special extension or some other return is up for discussion.
4.summary: Import API: create the file_processor contract
description: Create a file_processor interface in course\classes\local\import (namespace TBD) This should have: a process method which takes a file container object (as defined in ). This is a contract for file processors and must be implemented by plugins intending to process files.
5.summary: Provide site details when redirecting to moodlenet (tool_moodlenet 3.7 and 3.8
description: Please ensure when redirecting to moodlenet to provide details about our site and path. Taken from chat with Jake: quoteOFFICIALSITECONFIGVALUE?site=URLENCODEDSITE&path=URLENCODEDPATH quote Its likely that both the mod_moodlenet plugin as well as the master implementation will have to be checked and updated. Jake: Heres the commit running on the prototype site for 3.8 right now ( Well need to clean this up and add support for the case when a user enters their MoodleNet profile URL into the page (this commit only handles the "Browse official" button), but it gives you the idea. The main things we need: 1. tool_moodlenet: Fix tool_moodlenet_add_resource_redirect_url() so that when its returning the instance.php url, it also includes course and section params so these can be used in creation of the path param that well provide to MoodleNet. Given the path param creation needs to happen on the instance page, the instance page needs to know the course and section. 2. tool_moodlenet: Make sure that when sending the user to MoodleNet, we send them to the following URL: MOODLENETSITE?site=URLENCODEDSITE&path=URLENCODEDPATH Where: MOODLENETSITE is the URL of the users MoodleNet site, including the path to the (as yet to be determined) endpoint. e.g. URLENCODEDSITE is the Moodle site ($CFG->wwwroot), urlencoded. E.g. urlencode(" URLENCODEDPATH is the path to the tools import script, including any params such as course and section, also urlencoded. E.g. urlencode("/admin/tool/moodlenet/import.php?course=x§ion=y"); Note: I would not recommend exploiting the renderable+template context as a way to get data into the rendered like Ive done here. This was just a quick patch to test end to end comms with the test client.
6.summary: Update MoodleNet integration language strings
description: The below google doc shows the updated strings: Prototypes will also be updated to match. barbararamiro can you link those here when done?
7.summary: If only one import format option is available, skip the selection step for the user
description: This is driven by the link import case, in which there is only one handler - mod_url. In cases like this, rather than have the user select that single option (when there really is no choice to make), we should just skip this step and proceed with the import. Currently, the options.php page handles self posts to create/import the resource. This assumes the user submit a form with sesskey on that page. The options.php page however, can be reached via either the course select page (select.php - via a link) or the confirmation page (index.php - via a redirect), depending on whether or not the course has been provided. We shouldnt make state changes on these GET requests, though, so we cant just start an import on page load. I think well need to decide where we want to check the handler count (i.e. where we make the decision about whether to auto-import or not) and how we plan to post to the options.php page from the other two pages.
8.summary: Tool MoodleNet plugin branches
description: This issue just contains the reviewed and merged commit for the respective versions of the plugin. The plan is to split 3.7 and 3.8 out into stand alone plugins for distribution once were happy with them.
9.summary: Mod MoodleNet plugin branches (37 and 38 only)
description: Holds the feature branch for the 37 and 38 mod_moodlenet plugin. This plugins purpose is to extend the activity chooser with a MoodleNet item for 3.7 and 3.8, since the 3.9 activity chooser changes are not present in these branches.
10.summary: Allow links to be imported by tool_moodlenet (all versions)
description: We currently have a workflow for file import only. We want to support links too. As a teacher I want to be able to send links Ive shared on MoodleNet to Moodle and have them be imported into an activity instance So that I dont need to manually create resources in Moodle using the URL Acceptance criteria: 1. MoodleNet side: A teacher is able to use the send to Moodle button in MoodleNet to initiate an import for a link. 2. Once initiated, the workflow should present the same steps as the file import process (confirm, course select, format select) 3. Relevant strings should be updated to reflect the name of the item being imported during the various stages 4. The teacher is able to select from a range of supported link handlers at the format select stage. 5. Once selected, the resource should be created and should have a name and description value matching those provided by MoodleNet. 6. mod_url must always be available to handle link import in core, and other modules should also be able to register interest in handling links (core already supports this - we just want to confirm it works nicely) Spec: 1. MoodleNet will provide a type field in the POST data being sent to admin/tool/moodlenet/import.php, letting Moodle know whether a resource is to be treated as a file or as a link. Supported values are link and file right now only. 2. MoodleNet will send JSON data in the resource_info field in the aforementioned POST, containing name and summary fields, among others. These are to be used for the name and description values in Moodle. Sample below: code:java "collection": "community": "canonicalUrl": " "icon": " "name": "K12 teachers", "preferredUsername": "K12_teachers "summary": "Just a general space to hang out and chat if youre a schoolteacher!" , "canonicalUrl": " "icon": null, "name": "Teacher humour", "preferredUsername": "Teacher_humour "summary": "Share memes and other funny things you come across! (keep it clean, people)" , "canonicalUrl": " "icon": " "licence": "CC-BY-SA", "name": "30 Cheesy Teacher Jokes That Crack Us Up", "summary": "Need a good laugh? Weve got you covered.", "url": " code
11.summary: Mirror drag and drop options when importing a resource from MoodleNet (tool_moodlenet all versions)
description: Once we have received POST data from MoodleNet for a file that is not a backup, we eventually (depending on whether or not we have the course/section or need to prompt the user for it - but thats another issue) need to present options to the user, asking them what module theyd like to use to handle the file import. We want to provide the same options that are presented during a drag and drop addition to a course. Drag and drop is handled by course module callbacks, specific to drag and drop. The objective here is to make use of that existing set of callbacks and present those same options to users conducting an import from MoodleNet into Moodle. Some notes on the way this works: Moodle determines what actions are most suitable based on the type of file. Use the \mod_plugin_dndupload_register() and \mod_plugin_dndupload_handle() for each module to put their hand up to say they handle a certain type of file. So, what we want here is as follows: A plugin page which presents a list of options to the user, based on the dnd hooks. The page assumes the course and section have already been passed in (params to the page). E.g. In the workflow where the user starts in Moodle, MoodleNet POSTS back the course and section information to the import.php endpoint, so we have this already. If the page does not have a valid course and section, show an error. Once selected, the file should be downloaded (see ) and then handed over to \mod_plugin_dndupload_handle() which will create the relevant content in the course. Once content is created (as above step), the user should be redirected to the course home page + section. This issue IS NOT scoped with creation of any course or section selection pages.
12.summary: Add method which returns MoodleNet link (tool_moodlenet 3.7 and 3.8)
description: On stable branches, where we provide two plugins, the mod_moodlenet plugin needs to be able to ask the tool_moodlenet plugin for the MoodleNet endpoint for a given user. The module will then redirect the user there, initiating the MoodleNet browse-and-import process. This URL can be one of two things: A URL to a tool_moodlenet page asking the user to either enter their MoodleNet profile URL or proceed to the global MoodleNet instance. This page will have been created in the blocker - . A user-specific MoodleNet URL, which WILL kick off the browse-and-import process with MoodleNet. This URL is based on the value of their custom profile field MoodleNet profile URL (it uses only the site portion after the This URL MUST include two params site and path: -- Site must be a the URL of the Moodle site, url-encoded. E.g. institution.edu. -- Path must be the path to the MoodleNet import endpoint, including course and section params, and should also be url-encoded. E.g. admin/tool/moodlenet/import.php?course=X§ion=Y) An example of the syntax of the complete URL is: something.moodle.net?site=ENCODEDSITE&path=ENCODEDPATH The acceptance criteria for this task is as follows: The method must be callable by another plugin and should take in params course and section. The method must return the user-specific MoodleNet URL if set in the users custom profile field. Otherwise, if not set, it must return the URL of the tool_moodlenet page allowing the user to select the MoodleNet instance to go to (this page is created in ).
13.summary: Handling Moodle course backup files from MoodleNet (tool_moodlenet all versions)
description: This issue deals with MoodleNet resources which are Moodle course backups only. deals with activity backups and is a follow on from this issue. If, once the user has clicked Send to Moodle in MoodleNet, the file is detected as an MBZ file, the user is presented with a plugin page, asking the user to confirm their intent to restore the course backup file into Moodle (see mocks for look and feel of this page). Options to Cancel and go back and Restore are presented. If the user confirms the restore, the file should be downloaded by Moodle, and the user should be taken to the Step 1 of the restore process. They can then continue to restore the course as per the normal restore process. Downloading of the file into the relevant file area is handled by and is a precursor to this issue. If the user cancels the restore, then they are redirected back to the referring page on MoodleNet. The acceptance criteria for this issue is as follows: The decision page should be presented to the user when both of the following are true: -- MoodleNet posts to import.php AND -- The file is an MBZ file. The look and feel of the decision page matches the mocks. This is a page, not a modal. If accepted, the restore can be completed in full and a new course is created. If cancelled, the user is sent back to dashboard. If the user isnt logged in to Moodle, and they decide to cancel and go back, this also needs to take them back to dashboard. I.e. the Cancel aspect must work through the login process.
14.summary: Code to migrate the feature toggle from the plugin settings to core (tool_moodlenet master only)
description: This is required so that sites can upgrade from 3.7 or 3.8 to master and retain their feature toggle state. The way this should work is that the plugins have a version (say 2020030500) while the master plugin will be on a higher version (say 2020031000). In the master upgrade code for the tool, we want to read the tool setting and write it to the core setting. Acceptance criteria for this issue is as follows: 3.7 or 3.8 should be able to upgrade to master and the value of their feature toggle should carry over to the core setting in master. This should work when the toggle is true or false i.e. works regardless of state. Put a comment in version.php in the plugin to make sure it doesnt ever exceed a certain version number in master.
15.summary: Add page for selecting a course (tool_moodlenet all versions)
description: This should be in all versions of the tool in the first iteration. Later, it will be replaced in master. The mockups are still pending for this issue, however the functional acceptance criteria is as follows: When receiving a POST from MoodleNet (when the user clicks the Send to Moodle button in MoodleNet - use the test client!), the tool should take the user to this new course selection page ONLY if the course param IS NOT set in the request to the import URL. E.g. 1. Data POSTed to site/admin/tool/moodlenet/import.php?course=3§ion=5 will NOT take the user to this new page. This represents an import where the user started in Moodle. E.g. 2. Data POSTed to site/admin/tool/moodlenet/import.php will take the user to this new page. This represents an import where the user started in MoodleNet. The page should allow a course to be clicked. Clicking a course should send the user directly to the options selection page () with relevant params (see next point) When sending the user to the options selection page (67889), the course id should be passed in, and section 0 (the first section) should be used. There is no section selection process in the first iteration.
16.summary: Add MoodleNet profile information into the user table / object / profile
description: ||User story||Approach|| |As a user I can add my MoodleNet profile details to my user profile|When creating or updating a user, there is a field for a link to the users MoodleNet profile.| This is used to redirect the user to that profile when leaving Moodle to MoodleNet.
17.summary: Add enablemoodlenet setting to tool_moodlenet (tool_moodlenet 3.7 and 3.8)
description: This setting currently lives in core on master but we need to provide it as part of the plugins for 3.7 and 3.8. Acceptance criteria: New setting enablemoodlenet added to the stable versions of the tool_moodlenet plugin. This setting should default to yes. The help text for this setting should match master (see string in )
18.summary: Page for selecting which MoodleNet instance to go to (tool_moodlenet 3.7 and 3.8)
description: This view is seen in the activity chooser in master, as a pane, but must be a plugin page in Moodle 3.7 and 3.8. The acceptance criteria for this page are as follows: The look and feel of the page should match the mocks, albeit as a page not a pane. This page does not need to be linked to from anywhere in this issue. Entering a profile url and saving should: - Validate the profile URL syntax - Save the profile URL into the users MoodleNet profile URL custom field - Redirect the user to the respective MoodleNet endpoint - there is a method to generate this endpoint - see .
19.summary: Create a method which returns a MoodleNet endpoint (tool_moodlenet all versions)
description: Several issues need a method to generate a MoodleNet endpoint URL for a given profileurl and return path. The way this URL is created is as follows: Take the users MoodleNet profile URL which will be in the format " grabbing the site portion only. Assume a fixed MoodleNet path of /endpoint for now (this is being worked on by the MoodleNet team) Append the endpoint to the site URL - e.g. their.moodle.site/endpoint Next, we need to pass 2 params to this endpoint - site and path - which represent the site and path we want MoodleNet to send users back to, once content is selected. - Site: this is the Moodle site URL, urlencoded. E.g. urlencode(my.moodle.site) - Path: this is the path to our MoodleNet plugin import endpoint, urlencoded, and can include params itself (this is important for getting back the course and section). E.g. urlencode(admin/tool/moodlenet/import.php?course=2§ion=4) The endpoint should now look like: their.moodle.site/endpoint?site=ENCODEDSITE&path=ENCODEDPATHWITHPARAMS The acceptance criteria for this issue are as follows: Generated URL should match the above syntax. Unit tests to confirm the params and can be urldecoded and match the inputs.
20.summary: Core setting to toggle MoodleNet features globally (master)
description: Essentially just a feature toggle, but it wont be impacting anything in this issue. Some things it will affect in future: - The MoodleNet admin tool will check this to decide whether it permits communication to/from MoodleNet. - The activity picker will present the link to MoodleNet in the footer if this setting is enabled.
21.summary: Add class for handling download of MoodleNet resources (tool_moodlenet all versions)
description: Consider this a helper type class. At certain times during our process, wed like to be able to download the remote resource and put it in temp storage (for use in subsequent steps). Some examples: If the file is a backup, we want to download this prior to starting the restore, but after confirming the users intent to do so. If the file is an image, we want to postpone file download until the user has confirmed their intent to import the file into a specific course section. Note: Licenses are deemed to follow the same rules as other files in Moodle. A must have a license set by the teacher/content creator, when that file is used in Moodle. In our case, this is when the import is complete, and is something which should be achieved through existing UI elements. Nothing specific is required to facilitate this in this issue. See also: Moodle URL downloader repo - this might provide useful/relevant. The acceptance criteria for this issue is as follows: A new class in admin/tool/moodlenet/classes/local/ Must support downloading a remote URL to a file area (temp or otherwise), returning relevant handle for the resource, which can then be used for other things.
22.summary: Investigation of potential MoodleNet approaches
description: MDL for tracking time and discussions surrounding the project. Sub task of
23.summary: Create admin tool to deal with MoodleNet communication (tool_moodlenet all versions)
description: This issue is a foundation for several others as it creates the admin tool plugin (tool_moodlenet) and the basic communication flow between MoodleNet and Moodle. More specifically, it provides the endpoint which MoodleNet can POST information about the file (as JSON) to. This issue will help us to complete the following user story (it wont fully complete it because it only deals with the endpoint, not the processing + decision code): ||User Story||Approach|| |As a teacher, after selecting a resource in MoodleNet, I am redirected to my Moodle site where I can decide what to do with the imported resource.|MoodleNet will POST information about the resource, as JSON, to the Moodle endpoint. The endpoint will process the data and present the user with options for import.| . Acceptance criteria: There is a new admin tool tool_moodlenet created in core. The plugin provides an endpoint for MoodleNet to POST to MoodleNet should be able to POST to this endpoint (we need to simulate this in in testing in the first instance as it isnt built yet), regardless of whether a user is logged in or not and the POST data should be retained after login for use by the tool. The referring MoodleNet page should be captured and present as a param in the wantsurl. -We require a plugin (admin tool) to handle receiving requests to include MoodleNet content into a course.- -It has been suggested that the workflow could be similar to how plugins are installed from the plugin database (moodle.org).- -Plugin workflow - The button to install a plugin is a base64 encoded string which contains information (name, component, version) related to the plugin to make a request back to fetch it later. - End plugin workflow.- -Checks need to be done as to whether accepting files from MoodleNet is allowed by the system.- -The user needs to be logged in with an authenticated account.- -After getting the file it then has to be decided what to do with it- -Backup files to ultimately be restored.- -Other file types to be handled with a call back to activity plugins.- -An option to just put the file into the private files area of the user.- ||User story||Approach|| |-As a teacher (in Moodle), I am redirected to my Moodle site, and the MoodleNet resource is processed so I can use it in my Moodle site-|-I am redirected to the import from MoodleNet flow on my Moodle site. The details of the MoodleNet instance and details of the MoodleNet resource are included in the redirect- -I am prompted to login if not already authenticated into Moodle. The flow should continue after logging in.- -Moodle downloads the file to users private files, analyses the file and the metadata provided by MoodleNet about the resource, and takes the following action based on the type:- -Course/activity backup (MBZ): Moodle automatically commences the course/activity restore workflow- -I am prompted to select where I want to restore the course, or in which course and section I want to restore the activity.- -Any other file or link:- -Moodle determines what actions are most suitable based on the type of file, and the user can choose among a sub-set of:- -File resource- -Label resource- -Keep in private files- -Page resource- -Link resource- -If adding as a resource, Im prompted to select which course and section I want to import the file or link in (with the course and/or section the flow started in pre-selected, when applicable).- -The file or link is added to the correct course and section, or file area (e.g. Private Files) as selected-|
24.summary: Handling Moodle activity backup files from MoodleNet (tool_moodlenet all versions)
description: This issue deals with MoodleNet resources which are Moodle activity backups only. deals with course backups. If, once the user has clicked Send to Moodle in MoodleNet, the file is detected as an MBZ file, the user is presented with a plugin page, asking the user to confirm their intent to restore the activity backup file into Moodle (see mocks for look and feel of this page). Options to Cancel and go back and Restore are presented. If the user confirms the restore, the file should be downloaded by Moodle, and the user should be taken to the relevant step of the restore process. They can then continue to restore the activity as per the normal restore process. Downloading of the file into the relevant file area is handled by and is a precursor to this issue. If the user cancels the restore, then they are redirected back to the referring page on MoodleNet. The acceptance criteria for this issue is as follows: The decision page should be presented to the user when both of the following are true: - MoodleNet posts to import.php AND - The file is an MBZ file. The look and feel of the decision page matches the mocks. This is a page, not a modal. If accepted, the restore can be completed in full and a new activity is created. If cancelled, the user is sent back to the MoodleNet page they came from. If the user isnt logged in to Moodle, and they decide to cancel and go back, this also needs to take them back to the MoodleNet page they came from. I.e. the Go back aspect must work through the login process.
25.summary: Create a confirmation page to begin the import process (tool_moodlenet all versions)
description: The idea here is to have a single page that the user sees as the first step in the import process. They are asked to confirm their intention to import the file into Moodle, after which, the import process continues as per the mock ups. The mocks ups for this issue should be available soon. The two directions of workflow look like this: Starting in Moodle (course and section known): Navigation to MoodleNet steps omitted. These are the same as the mocks. User is in MoodleNet and clicks Send to Moodle on a resource. User presented with the confirmation/landing page. If the user needs to log in, they see this page immediately after login. User confirms and is taken to the what do you want to do with this content page Process continues and import is processed as per mocks. Starting in MoodleNet (no course and section known): User is in MoodleNet and clicks Send to Moodle on a resource. User presented with the confirmation/landing page. If the user needs to log in, they see this page immediately after login. User confirms and it taken to the select a course page. Process continues and import is processed as per mocks.
26.summary: Revise: Create custom banner item for moodlenet
description: Create a custom banner class for moodlenet to handle advanced options such as what to do on close, and cancel. On cancel the user should stay on the current page. A call to the resource manager needs to be made to clear the session data. There should be no close button.|
27.summary: Core setting to set a default MoodleNet instance (master)
description: Basically thisll be a string that points towards the HQ run instance of MoodleNet. Some things it will affect in future: - If an admin removes the MoodleNet tool but still wants the integration enabled we need a link to the HQ run MoodleNet instance to redirect users to - The activity picker will present this link to MoodleNet in the footer
| 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 issues related to communication between MoodleNet and moodle
description: This epic encapsulates work that needs to be done to have communication between MoodleNet and moodle. This spans from sending users to MoodleNet to receiving files and links from the MoodleNet platform. Our initial focus is basic links to MoodleNet and receiving standard files and links to merge into courses for 3.9. There is a mockup available here|
### Response:
1.summary: Create mod_moodlenet activity (mod_moodlenet 3.7 and 3.8)
description: This plugin is part of a set (the set also includes an admin tool, tool_moodlenet) to be provided, via the plugins db, to sites on versions 3.7 and 3.8 of Moodle. Acceptance criteria: A minimal plugin which: Provides an implementation of get_shortcuts(), providing one single resource called MoodleNet with relevant explanatory text in the description (text TBC). Provides a modified edit_form.php, which just redirects to a MoodleNet url (with params) instead of loading up the normal mod edit form. This allows the chooser to present the required MoodleNet item to the users, and allows them to be sent to MoodleNet via the edit_form.php page. The edit_form.php page asks the tool_moodlenet plugin (part of a set) for the MoodleNet URL for a given user and uses this link in redirection. mod_moodlenet: Fix edit.php so it correctly uses section and not sr (annoyingly, section return is something else entirely). Passes unit tests relating to privacy and is ready for deployment to the plugins DB.
2.summary: Add links to MoodleNet in Moodle (master)
description: The desire is to guide users to MoodleNet via the activity chooser. The following users stories outline the areas to introduce these links. ||User story||Approach|| |As a teacher (in Moodle) I can navigate to MoodleNet from the Activity Chooser, so I can find content for my course|See UX designs - there is a link in the footer, as well as another carousel pane, depending on whether the user has added a MoodleNet account on their profile or not.| |-As a teacher (in Moodle) I can navigate to MoodleNet from an empty course page, so I can find content for my course-|-On a blank course page I am presented with:- -Description of what I can find on MoodleNet, and that I will be directed out of the Moodle site- -A link to MoodleNet-| |-As a teacher (in Moodle) I can navigate to MoodleNet from the course gear menu, so I can find content for my course-|-The course gear menu has an item that links to MoodleNet-| |-As a teacher (in Moodle) I can enter my MoodleNet profile URL on my profile page, so people can find my MoodleNet profile page from Moodle- Handled in .|-An editable field for MoodleNet profile URL on the Moodle profile page- -A link to the MoodleNet profile- -MoodleNet instance URL to be derived from the profile URL-| . Acceptance Criteria: There should be an admin setting (in adv features for now) "Enable MoodleNet integration", defaulting to enabled. When the integration is enabled, there should be an image link in the footer of the activity chooser as per the mockups. If the tool_moodlenet plugin is uninstalled (a possibility), then the link should just be a link to the MoodleNet site (checking the users profile for a site as needed). This WILL NOT call the MoodleNet endpoint. If the tool_moodlenet plugin is installed and the user DOES NOT HAVE a saved MoodleNet profile URL in their user profile, then the link will trigger a load of the MoodleNet selection pane in the chooser - as per UX mocks. If a user enters a profile URL at this step, this is saved to their profile and this pane should not be seen again (again, as per UX mocks). If the tool_moodlenet plugin is installed and the user DOES HAVE a saved MoodleNet profile URL in their user profile, then the link will be to the MoodleNet endpoint and will include the params: The Moodle site URL (e.g. my.moodle.org) The Moodle endpoint path (admin/tool/moodlenetendpoint.php) When the integration is disabled, there should be no link in the activity chooser footer.
3.summary: Import API: create the file_extension_register contract
description: Create the file_extension_register interface. This should have: A method register_extensions which returns all extensions supported by the implementing class, and their lang string descriptors. E.g. png => what is going to happen when this module processes the png . This could be an array or a formal object - time permitting. Note: objects in plugins only implement this contract when they want to support at least one file extension, however, we need to provide a way that this method can return all known extensions . Whether that be via a special extension or some other return is up for discussion.
4.summary: Import API: create the file_processor contract
description: Create a file_processor interface in course\classes\local\import (namespace TBD) This should have: a process method which takes a file container object (as defined in ). This is a contract for file processors and must be implemented by plugins intending to process files.
5.summary: Provide site details when redirecting to moodlenet (tool_moodlenet 3.7 and 3.8
description: Please ensure when redirecting to moodlenet to provide details about our site and path. Taken from chat with Jake: quoteOFFICIALSITECONFIGVALUE?site=URLENCODEDSITE&path=URLENCODEDPATH quote Its likely that both the mod_moodlenet plugin as well as the master implementation will have to be checked and updated. Jake: Heres the commit running on the prototype site for 3.8 right now ( Well need to clean this up and add support for the case when a user enters their MoodleNet profile URL into the page (this commit only handles the "Browse official" button), but it gives you the idea. The main things we need: 1. tool_moodlenet: Fix tool_moodlenet_add_resource_redirect_url() so that when its returning the instance.php url, it also includes course and section params so these can be used in creation of the path param that well provide to MoodleNet. Given the path param creation needs to happen on the instance page, the instance page needs to know the course and section. 2. tool_moodlenet: Make sure that when sending the user to MoodleNet, we send them to the following URL: MOODLENETSITE?site=URLENCODEDSITE&path=URLENCODEDPATH Where: MOODLENETSITE is the URL of the users MoodleNet site, including the path to the (as yet to be determined) endpoint. e.g. URLENCODEDSITE is the Moodle site ($CFG->wwwroot), urlencoded. E.g. urlencode(" URLENCODEDPATH is the path to the tools import script, including any params such as course and section, also urlencoded. E.g. urlencode("/admin/tool/moodlenet/import.php?course=x§ion=y"); Note: I would not recommend exploiting the renderable+template context as a way to get data into the rendered like Ive done here. This was just a quick patch to test end to end comms with the test client.
6.summary: Update MoodleNet integration language strings
description: The below google doc shows the updated strings: Prototypes will also be updated to match. barbararamiro can you link those here when done?
7.summary: If only one import format option is available, skip the selection step for the user
description: This is driven by the link import case, in which there is only one handler - mod_url. In cases like this, rather than have the user select that single option (when there really is no choice to make), we should just skip this step and proceed with the import. Currently, the options.php page handles self posts to create/import the resource. This assumes the user submit a form with sesskey on that page. The options.php page however, can be reached via either the course select page (select.php - via a link) or the confirmation page (index.php - via a redirect), depending on whether or not the course has been provided. We shouldnt make state changes on these GET requests, though, so we cant just start an import on page load. I think well need to decide where we want to check the handler count (i.e. where we make the decision about whether to auto-import or not) and how we plan to post to the options.php page from the other two pages.
8.summary: Tool MoodleNet plugin branches
description: This issue just contains the reviewed and merged commit for the respective versions of the plugin. The plan is to split 3.7 and 3.8 out into stand alone plugins for distribution once were happy with them.
9.summary: Mod MoodleNet plugin branches (37 and 38 only)
description: Holds the feature branch for the 37 and 38 mod_moodlenet plugin. This plugins purpose is to extend the activity chooser with a MoodleNet item for 3.7 and 3.8, since the 3.9 activity chooser changes are not present in these branches.
10.summary: Allow links to be imported by tool_moodlenet (all versions)
description: We currently have a workflow for file import only. We want to support links too. As a teacher I want to be able to send links Ive shared on MoodleNet to Moodle and have them be imported into an activity instance So that I dont need to manually create resources in Moodle using the URL Acceptance criteria: 1. MoodleNet side: A teacher is able to use the send to Moodle button in MoodleNet to initiate an import for a link. 2. Once initiated, the workflow should present the same steps as the file import process (confirm, course select, format select) 3. Relevant strings should be updated to reflect the name of the item being imported during the various stages 4. The teacher is able to select from a range of supported link handlers at the format select stage. 5. Once selected, the resource should be created and should have a name and description value matching those provided by MoodleNet. 6. mod_url must always be available to handle link import in core, and other modules should also be able to register interest in handling links (core already supports this - we just want to confirm it works nicely) Spec: 1. MoodleNet will provide a type field in the POST data being sent to admin/tool/moodlenet/import.php, letting Moodle know whether a resource is to be treated as a file or as a link. Supported values are link and file right now only. 2. MoodleNet will send JSON data in the resource_info field in the aforementioned POST, containing name and summary fields, among others. These are to be used for the name and description values in Moodle. Sample below: code:java "collection": "community": "canonicalUrl": " "icon": " "name": "K12 teachers", "preferredUsername": "K12_teachers "summary": "Just a general space to hang out and chat if youre a schoolteacher!" , "canonicalUrl": " "icon": null, "name": "Teacher humour", "preferredUsername": "Teacher_humour "summary": "Share memes and other funny things you come across! (keep it clean, people)" , "canonicalUrl": " "icon": " "licence": "CC-BY-SA", "name": "30 Cheesy Teacher Jokes That Crack Us Up", "summary": "Need a good laugh? Weve got you covered.", "url": " code
11.summary: Mirror drag and drop options when importing a resource from MoodleNet (tool_moodlenet all versions)
description: Once we have received POST data from MoodleNet for a file that is not a backup, we eventually (depending on whether or not we have the course/section or need to prompt the user for it - but thats another issue) need to present options to the user, asking them what module theyd like to use to handle the file import. We want to provide the same options that are presented during a drag and drop addition to a course. Drag and drop is handled by course module callbacks, specific to drag and drop. The objective here is to make use of that existing set of callbacks and present those same options to users conducting an import from MoodleNet into Moodle. Some notes on the way this works: Moodle determines what actions are most suitable based on the type of file. Use the \mod_plugin_dndupload_register() and \mod_plugin_dndupload_handle() for each module to put their hand up to say they handle a certain type of file. So, what we want here is as follows: A plugin page which presents a list of options to the user, based on the dnd hooks. The page assumes the course and section have already been passed in (params to the page). E.g. In the workflow where the user starts in Moodle, MoodleNet POSTS back the course and section information to the import.php endpoint, so we have this already. If the page does not have a valid course and section, show an error. Once selected, the file should be downloaded (see ) and then handed over to \mod_plugin_dndupload_handle() which will create the relevant content in the course. Once content is created (as above step), the user should be redirected to the course home page + section. This issue IS NOT scoped with creation of any course or section selection pages.
12.summary: Add method which returns MoodleNet link (tool_moodlenet 3.7 and 3.8)
description: On stable branches, where we provide two plugins, the mod_moodlenet plugin needs to be able to ask the tool_moodlenet plugin for the MoodleNet endpoint for a given user. The module will then redirect the user there, initiating the MoodleNet browse-and-import process. This URL can be one of two things: A URL to a tool_moodlenet page asking the user to either enter their MoodleNet profile URL or proceed to the global MoodleNet instance. This page will have been created in the blocker - . A user-specific MoodleNet URL, which WILL kick off the browse-and-import process with MoodleNet. This URL is based on the value of their custom profile field MoodleNet profile URL (it uses only the site portion after the This URL MUST include two params site and path: -- Site must be a the URL of the Moodle site, url-encoded. E.g. institution.edu. -- Path must be the path to the MoodleNet import endpoint, including course and section params, and should also be url-encoded. E.g. admin/tool/moodlenet/import.php?course=X§ion=Y) An example of the syntax of the complete URL is: something.moodle.net?site=ENCODEDSITE&path=ENCODEDPATH The acceptance criteria for this task is as follows: The method must be callable by another plugin and should take in params course and section. The method must return the user-specific MoodleNet URL if set in the users custom profile field. Otherwise, if not set, it must return the URL of the tool_moodlenet page allowing the user to select the MoodleNet instance to go to (this page is created in ).
13.summary: Handling Moodle course backup files from MoodleNet (tool_moodlenet all versions)
description: This issue deals with MoodleNet resources which are Moodle course backups only. deals with activity backups and is a follow on from this issue. If, once the user has clicked Send to Moodle in MoodleNet, the file is detected as an MBZ file, the user is presented with a plugin page, asking the user to confirm their intent to restore the course backup file into Moodle (see mocks for look and feel of this page). Options to Cancel and go back and Restore are presented. If the user confirms the restore, the file should be downloaded by Moodle, and the user should be taken to the Step 1 of the restore process. They can then continue to restore the course as per the normal restore process. Downloading of the file into the relevant file area is handled by and is a precursor to this issue. If the user cancels the restore, then they are redirected back to the referring page on MoodleNet. The acceptance criteria for this issue is as follows: The decision page should be presented to the user when both of the following are true: -- MoodleNet posts to import.php AND -- The file is an MBZ file. The look and feel of the decision page matches the mocks. This is a page, not a modal. If accepted, the restore can be completed in full and a new course is created. If cancelled, the user is sent back to dashboard. If the user isnt logged in to Moodle, and they decide to cancel and go back, this also needs to take them back to dashboard. I.e. the Cancel aspect must work through the login process.
14.summary: Code to migrate the feature toggle from the plugin settings to core (tool_moodlenet master only)
description: This is required so that sites can upgrade from 3.7 or 3.8 to master and retain their feature toggle state. The way this should work is that the plugins have a version (say 2020030500) while the master plugin will be on a higher version (say 2020031000). In the master upgrade code for the tool, we want to read the tool setting and write it to the core setting. Acceptance criteria for this issue is as follows: 3.7 or 3.8 should be able to upgrade to master and the value of their feature toggle should carry over to the core setting in master. This should work when the toggle is true or false i.e. works regardless of state. Put a comment in version.php in the plugin to make sure it doesnt ever exceed a certain version number in master.
15.summary: Add page for selecting a course (tool_moodlenet all versions)
description: This should be in all versions of the tool in the first iteration. Later, it will be replaced in master. The mockups are still pending for this issue, however the functional acceptance criteria is as follows: When receiving a POST from MoodleNet (when the user clicks the Send to Moodle button in MoodleNet - use the test client!), the tool should take the user to this new course selection page ONLY if the course param IS NOT set in the request to the import URL. E.g. 1. Data POSTed to site/admin/tool/moodlenet/import.php?course=3§ion=5 will NOT take the user to this new page. This represents an import where the user started in Moodle. E.g. 2. Data POSTed to site/admin/tool/moodlenet/import.php will take the user to this new page. This represents an import where the user started in MoodleNet. The page should allow a course to be clicked. Clicking a course should send the user directly to the options selection page () with relevant params (see next point) When sending the user to the options selection page (67889), the course id should be passed in, and section 0 (the first section) should be used. There is no section selection process in the first iteration.
16.summary: Add MoodleNet profile information into the user table / object / profile
description: ||User story||Approach|| |As a user I can add my MoodleNet profile details to my user profile|When creating or updating a user, there is a field for a link to the users MoodleNet profile.| This is used to redirect the user to that profile when leaving Moodle to MoodleNet.
17.summary: Add enablemoodlenet setting to tool_moodlenet (tool_moodlenet 3.7 and 3.8)
description: This setting currently lives in core on master but we need to provide it as part of the plugins for 3.7 and 3.8. Acceptance criteria: New setting enablemoodlenet added to the stable versions of the tool_moodlenet plugin. This setting should default to yes. The help text for this setting should match master (see string in )
18.summary: Page for selecting which MoodleNet instance to go to (tool_moodlenet 3.7 and 3.8)
description: This view is seen in the activity chooser in master, as a pane, but must be a plugin page in Moodle 3.7 and 3.8. The acceptance criteria for this page are as follows: The look and feel of the page should match the mocks, albeit as a page not a pane. This page does not need to be linked to from anywhere in this issue. Entering a profile url and saving should: - Validate the profile URL syntax - Save the profile URL into the users MoodleNet profile URL custom field - Redirect the user to the respective MoodleNet endpoint - there is a method to generate this endpoint - see .
19.summary: Create a method which returns a MoodleNet endpoint (tool_moodlenet all versions)
description: Several issues need a method to generate a MoodleNet endpoint URL for a given profileurl and return path. The way this URL is created is as follows: Take the users MoodleNet profile URL which will be in the format " grabbing the site portion only. Assume a fixed MoodleNet path of /endpoint for now (this is being worked on by the MoodleNet team) Append the endpoint to the site URL - e.g. their.moodle.site/endpoint Next, we need to pass 2 params to this endpoint - site and path - which represent the site and path we want MoodleNet to send users back to, once content is selected. - Site: this is the Moodle site URL, urlencoded. E.g. urlencode(my.moodle.site) - Path: this is the path to our MoodleNet plugin import endpoint, urlencoded, and can include params itself (this is important for getting back the course and section). E.g. urlencode(admin/tool/moodlenet/import.php?course=2§ion=4) The endpoint should now look like: their.moodle.site/endpoint?site=ENCODEDSITE&path=ENCODEDPATHWITHPARAMS The acceptance criteria for this issue are as follows: Generated URL should match the above syntax. Unit tests to confirm the params and can be urldecoded and match the inputs.
20.summary: Core setting to toggle MoodleNet features globally (master)
description: Essentially just a feature toggle, but it wont be impacting anything in this issue. Some things it will affect in future: - The MoodleNet admin tool will check this to decide whether it permits communication to/from MoodleNet. - The activity picker will present the link to MoodleNet in the footer if this setting is enabled.
21.summary: Add class for handling download of MoodleNet resources (tool_moodlenet all versions)
description: Consider this a helper type class. At certain times during our process, wed like to be able to download the remote resource and put it in temp storage (for use in subsequent steps). Some examples: If the file is a backup, we want to download this prior to starting the restore, but after confirming the users intent to do so. If the file is an image, we want to postpone file download until the user has confirmed their intent to import the file into a specific course section. Note: Licenses are deemed to follow the same rules as other files in Moodle. A must have a license set by the teacher/content creator, when that file is used in Moodle. In our case, this is when the import is complete, and is something which should be achieved through existing UI elements. Nothing specific is required to facilitate this in this issue. See also: Moodle URL downloader repo - this might provide useful/relevant. The acceptance criteria for this issue is as follows: A new class in admin/tool/moodlenet/classes/local/ Must support downloading a remote URL to a file area (temp or otherwise), returning relevant handle for the resource, which can then be used for other things.
22.summary: Investigation of potential MoodleNet approaches
description: MDL for tracking time and discussions surrounding the project. Sub task of
23.summary: Create admin tool to deal with MoodleNet communication (tool_moodlenet all versions)
description: This issue is a foundation for several others as it creates the admin tool plugin (tool_moodlenet) and the basic communication flow between MoodleNet and Moodle. More specifically, it provides the endpoint which MoodleNet can POST information about the file (as JSON) to. This issue will help us to complete the following user story (it wont fully complete it because it only deals with the endpoint, not the processing + decision code): ||User Story||Approach|| |As a teacher, after selecting a resource in MoodleNet, I am redirected to my Moodle site where I can decide what to do with the imported resource.|MoodleNet will POST information about the resource, as JSON, to the Moodle endpoint. The endpoint will process the data and present the user with options for import.| . Acceptance criteria: There is a new admin tool tool_moodlenet created in core. The plugin provides an endpoint for MoodleNet to POST to MoodleNet should be able to POST to this endpoint (we need to simulate this in in testing in the first instance as it isnt built yet), regardless of whether a user is logged in or not and the POST data should be retained after login for use by the tool. The referring MoodleNet page should be captured and present as a param in the wantsurl. -We require a plugin (admin tool) to handle receiving requests to include MoodleNet content into a course.- -It has been suggested that the workflow could be similar to how plugins are installed from the plugin database (moodle.org).- -Plugin workflow - The button to install a plugin is a base64 encoded string which contains information (name, component, version) related to the plugin to make a request back to fetch it later. - End plugin workflow.- -Checks need to be done as to whether accepting files from MoodleNet is allowed by the system.- -The user needs to be logged in with an authenticated account.- -After getting the file it then has to be decided what to do with it- -Backup files to ultimately be restored.- -Other file types to be handled with a call back to activity plugins.- -An option to just put the file into the private files area of the user.- ||User story||Approach|| |-As a teacher (in Moodle), I am redirected to my Moodle site, and the MoodleNet resource is processed so I can use it in my Moodle site-|-I am redirected to the import from MoodleNet flow on my Moodle site. The details of the MoodleNet instance and details of the MoodleNet resource are included in the redirect- -I am prompted to login if not already authenticated into Moodle. The flow should continue after logging in.- -Moodle downloads the file to users private files, analyses the file and the metadata provided by MoodleNet about the resource, and takes the following action based on the type:- -Course/activity backup (MBZ): Moodle automatically commences the course/activity restore workflow- -I am prompted to select where I want to restore the course, or in which course and section I want to restore the activity.- -Any other file or link:- -Moodle determines what actions are most suitable based on the type of file, and the user can choose among a sub-set of:- -File resource- -Label resource- -Keep in private files- -Page resource- -Link resource- -If adding as a resource, Im prompted to select which course and section I want to import the file or link in (with the course and/or section the flow started in pre-selected, when applicable).- -The file or link is added to the correct course and section, or file area (e.g. Private Files) as selected-|
24.summary: Handling Moodle activity backup files from MoodleNet (tool_moodlenet all versions)
description: This issue deals with MoodleNet resources which are Moodle activity backups only. deals with course backups. If, once the user has clicked Send to Moodle in MoodleNet, the file is detected as an MBZ file, the user is presented with a plugin page, asking the user to confirm their intent to restore the activity backup file into Moodle (see mocks for look and feel of this page). Options to Cancel and go back and Restore are presented. If the user confirms the restore, the file should be downloaded by Moodle, and the user should be taken to the relevant step of the restore process. They can then continue to restore the activity as per the normal restore process. Downloading of the file into the relevant file area is handled by and is a precursor to this issue. If the user cancels the restore, then they are redirected back to the referring page on MoodleNet. The acceptance criteria for this issue is as follows: The decision page should be presented to the user when both of the following are true: - MoodleNet posts to import.php AND - The file is an MBZ file. The look and feel of the decision page matches the mocks. This is a page, not a modal. If accepted, the restore can be completed in full and a new activity is created. If cancelled, the user is sent back to the MoodleNet page they came from. If the user isnt logged in to Moodle, and they decide to cancel and go back, this also needs to take them back to the MoodleNet page they came from. I.e. the Go back aspect must work through the login process.
25.summary: Create a confirmation page to begin the import process (tool_moodlenet all versions)
description: The idea here is to have a single page that the user sees as the first step in the import process. They are asked to confirm their intention to import the file into Moodle, after which, the import process continues as per the mock ups. The mocks ups for this issue should be available soon. The two directions of workflow look like this: Starting in Moodle (course and section known): Navigation to MoodleNet steps omitted. These are the same as the mocks. User is in MoodleNet and clicks Send to Moodle on a resource. User presented with the confirmation/landing page. If the user needs to log in, they see this page immediately after login. User confirms and is taken to the what do you want to do with this content page Process continues and import is processed as per mocks. Starting in MoodleNet (no course and section known): User is in MoodleNet and clicks Send to Moodle on a resource. User presented with the confirmation/landing page. If the user needs to log in, they see this page immediately after login. User confirms and it taken to the select a course page. Process continues and import is processed as per mocks.
26.summary: Revise: Create custom banner item for moodlenet
description: Create a custom banner class for moodlenet to handle advanced options such as what to do on close, and cancel. On cancel the user should stay on the current page. A call to the resource manager needs to be made to clear the session data. There should be no close button.|
27.summary: Core setting to set a default MoodleNet instance (master)
description: Basically thisll be a string that points towards the HQ run instance of MoodleNet. Some things it will affect in future: - If an admin removes the MoodleNet tool but still wants the integration enabled we need a link to the HQ run MoodleNet instance to redirect users to - The activity picker will present this link to MoodleNet in the footer
|
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 advanced forum reporting
description: This is an epic to capture all of the relevant changes to support enhanced reporting within the Forum. This issue duplicates a number of other issues but serves as a clean place for the purposes of project development.
| Unsolvable | 1.summary: Forum: Report for analysis of discussions
description: Generate reports on forum usage including: number of posts number of discussions number of replies This may also include other information once other features land: number of substantive posts It may also include: distributions who replied to whom
2.summary: Forum report: Basic skeleton
description: Create a basic skeleton for the Forum report. Create new forum subplugin for forumreport Summary for single forum No Download required initially No filtering required initially Basic fields: Names, Reply counts, Created discussion count
3.summary: Groups filter in forum summary report
description: Set up the filter area in the report interface, and add ability within that filter area to choose which group(s) within that forum are shown.
4.summary: Forum summary report option to message selected users
description: See participants report for how we do this. We need to add a new column to select users, and a way of messaging those users. As a teacher, to allow me to message a student who is not interacting regularly, I want to be able to message that student As a teacher, to allow me to message several students who are not interacting regularly, I want to be able to send a message to multiple users. When I send a message to multiple users, those users should only see the conversation between that one student and the teacher who initiated the conversation.
5.summary: Add columns to show earliest and most recent post timestamps
description: Add two columns to the forum summary report, one for each users earliest post, and one for their most recent.
6.summary: Add column to show post view count, if information is available
description: Add a column to the forum summary report to show "Number of views", the number of posts each user has viewed. This will probably require checking log entries to determine a users read count, which would mean the column should only be shown if the site is using an internal log store. An example of similar log checking and data calculation can be seen in this report|
| 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 advanced forum reporting
description: This is an epic to capture all of the relevant changes to support enhanced reporting within 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: Forum: Report for analysis of discussions
description: Generate reports on forum usage including: number of posts number of discussions number of replies This may also include other information once other features land: number of substantive posts It may also include: distributions who replied to whom
2.summary: Forum report: Basic skeleton
description: Create a basic skeleton for the Forum report. Create new forum subplugin for forumreport Summary for single forum No Download required initially No filtering required initially Basic fields: Names, Reply counts, Created discussion count
3.summary: Groups filter in forum summary report
description: Set up the filter area in the report interface, and add ability within that filter area to choose which group(s) within that forum are shown.
4.summary: Forum summary report option to message selected users
description: See participants report for how we do this. We need to add a new column to select users, and a way of messaging those users. As a teacher, to allow me to message a student who is not interacting regularly, I want to be able to message that student As a teacher, to allow me to message several students who are not interacting regularly, I want to be able to send a message to multiple users. When I send a message to multiple users, those users should only see the conversation between that one student and the teacher who initiated the conversation.
5.summary: Add columns to show earliest and most recent post timestamps
description: Add two columns to the forum summary report, one for each users earliest post, and one for their most recent.
6.summary: Add column to show post view count, if information is available
description: Add a column to the forum summary report to show "Number of views", the number of posts each user has viewed. This will probably require checking log entries to determine a users read count, which would mean the column should only be shown if the site is using an internal log store. An example of similar log checking and data calculation can be seen in this report|
|
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 front page redesign
description: Both areas of moodle.net - courses to enrol in and downloadable courses and content - are of equal importance and are both landing pages . Thus an index page for a front page is useful in establishing the two areas of the site and helps in communicating what moodle.net is to new visitors. The page should include: What is Moodle.net info Buttons to Courses to join and Resources to download (terms to be confirmed) Announcements: moodle.net/news RSS feeds on upcoming and latest courses and resources Footer (common to all pages) and social media links
| Solvable | 1.summary: Create wireframe for Moodle.net front page
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 front page redesign
description: Both areas of moodle.net - courses to enrol in and downloadable courses and content - are of equal importance and are both landing pages . Thus an index page for a front page is useful in establishing the two areas of the site and helps in communicating what moodle.net is to new visitors. The page should include: What is Moodle.net info Buttons to Courses to join and Resources to download (terms to be confirmed) Announcements: moodle.net/news RSS feeds on upcoming and latest courses and resources Footer (common to all pages) and social media links
### Response:
1.summary: Create wireframe for Moodle.net front page
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: Restore performance improvements
description: Restore performance is very poor as it does large number of database interactions. It also does millions of function calls. There are a number of optimizations that can be included to improve the performance of the restore function.
| Unsolvable | 1.summary: backupidsexists and backupidscache could be used more effectively
description: The restore process uses backupidsexists and backupidscache to store the existence and data from the database to reduce overhead when importing. The cache was installed as part of . It is slanted to be replaced by MUC. This issue will explore the performance benefit/cost of MUC and also improvements to the way these caches are used to reduce database calls. This will provide performance improvements for restore and for activity duplication.
2.summary: grouped_parser_processor::grouped_parent_exists is called too much
description: Following on from the changes in , where a cache has been added to the get_parent_path function, I found from profiling that a significant time in restore is still spent on grouped_parser_processor::parent_exists. Adding a cache directly to this function (in addition to the existing get_parent_path cache) appears to improve performance on a large test course by about one sixth with about a 2MB memory cost. I did two runs before/after my code patch (alternating) using the M size standard test course, with profiling turned off again. Results: Before: 359.5s (forgot to note memory use) After: 308.4s (85.6 MB) Before: 373.7s (83.4MB) After: 297.7s (85.6MB) Average is a 17 improvement. This needs review as maybe Im missing something silly. If successful, it may be possible to backport this change to 2.4 and 2.5.
3.summary: Read moodle_backup.xml only once during restore
description: When restoring complicated courses, backup_general_helper::get_backup_information() can be called many times. In the example of a Large example course the following happens |Calls to get_backup_information|5546 |Time per call|4-5 seconds |Restore Time|6.3 hours Caching get_backup_information can provide a significant performance improvement as much of the calculation of the restore is stored in memory.
| 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: Restore performance improvements
description: Restore performance is very poor as it does large number of database interactions. It also does millions of function calls. There are a number of optimizations that can be included to improve the performance of the restore function.
### Response:
1.summary: backupidsexists and backupidscache could be used more effectively
description: The restore process uses backupidsexists and backupidscache to store the existence and data from the database to reduce overhead when importing. The cache was installed as part of . It is slanted to be replaced by MUC. This issue will explore the performance benefit/cost of MUC and also improvements to the way these caches are used to reduce database calls. This will provide performance improvements for restore and for activity duplication.
2.summary: grouped_parser_processor::grouped_parent_exists is called too much
description: Following on from the changes in , where a cache has been added to the get_parent_path function, I found from profiling that a significant time in restore is still spent on grouped_parser_processor::parent_exists. Adding a cache directly to this function (in addition to the existing get_parent_path cache) appears to improve performance on a large test course by about one sixth with about a 2MB memory cost. I did two runs before/after my code patch (alternating) using the M size standard test course, with profiling turned off again. Results: Before: 359.5s (forgot to note memory use) After: 308.4s (85.6 MB) Before: 373.7s (83.4MB) After: 297.7s (85.6MB) Average is a 17 improvement. This needs review as maybe Im missing something silly. If successful, it may be possible to backport this change to 2.4 and 2.5.
3.summary: Read moodle_backup.xml only once during restore
description: When restoring complicated courses, backup_general_helper::get_backup_information() can be called many times. In the example of a Large example course the following happens |Calls to get_backup_information|5546 |Time per call|4-5 seconds |Restore Time|6.3 hours Caching get_backup_information can provide a significant performance improvement as much of the calculation of the restore is stored in memory.
|
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: BigBlueButton New Features and Improvements for 4.3
description: As usual, there are several new features and improvements that will not make it to 4.2 and need to be carried forward, and of course as usual, the new ones we need to include in the next release Moodle 4.3.
| Unsolvable | 1.summary: Add support for BigBlueButton Subplugins
description: The current integrated BigblueButtonBN module is now part of Moodle core. It would be great to use sub-plugins to add more flexibility in some installation to to add new (and maybe experimental) features as sub-plugins, as for example: Specific completion criteria Additional room types Specific grouping or joining workflow
2.summary: BigBlueButton Subplugin : allow action_url_addons to know about the instance
description: Currently and following the implementation of , we have added a callback ( action_url_addons) that can be used to change the join and create url according to a BigBlueButton activity instance value/data. The only issue is that we do not have information about the instance in the callback, so we cannot get parameters that we have set in the module instance.
3.summary: Add backup support for BigBlueButton subplugins
description: While we implemented we did not add a way to backup content for a subplugin. This is the implementation of backup with related tests.
4.summary: Refactor BigBlueButton instance class
description: The BigBlueButton \mod_bigbluebuttonbn\instance has a couple of flaws that need to be fixed in order to fix other issues: This bug: - basically we need to get the cm_info systematically for the instance to be created. This results in an exception at creation even if we dont need it (if the module is disabled the get_fast_modinfo will not get the instance The subplugin related routines for which we need to add information about new data field (joined tabled) added by the subplugins Avoid code duplication in get_from_instanceid, get_from_cmid and get_all_instances_in_course
5.summary: Add support for additional settings in BigBlueButton module edit form
description: As is being part of 4.2, we also need to extend the implementation to support custom settings in the activity standard edit form. This would be a better way to solve
| 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: BigBlueButton New Features and Improvements for 4.3
description: As usual, there are several new features and improvements that will not make it to 4.2 and need to be carried forward, and of course as usual, the new ones we need to include in the next release Moodle 4.3.
### Response:
1.summary: Add support for BigBlueButton Subplugins
description: The current integrated BigblueButtonBN module is now part of Moodle core. It would be great to use sub-plugins to add more flexibility in some installation to to add new (and maybe experimental) features as sub-plugins, as for example: Specific completion criteria Additional room types Specific grouping or joining workflow
2.summary: BigBlueButton Subplugin : allow action_url_addons to know about the instance
description: Currently and following the implementation of , we have added a callback ( action_url_addons) that can be used to change the join and create url according to a BigBlueButton activity instance value/data. The only issue is that we do not have information about the instance in the callback, so we cannot get parameters that we have set in the module instance.
3.summary: Add backup support for BigBlueButton subplugins
description: While we implemented we did not add a way to backup content for a subplugin. This is the implementation of backup with related tests.
4.summary: Refactor BigBlueButton instance class
description: The BigBlueButton \mod_bigbluebuttonbn\instance has a couple of flaws that need to be fixed in order to fix other issues: This bug: - basically we need to get the cm_info systematically for the instance to be created. This results in an exception at creation even if we dont need it (if the module is disabled the get_fast_modinfo will not get the instance The subplugin related routines for which we need to add information about new data field (joined tabled) added by the subplugins Avoid code duplication in get_from_instanceid, get_from_cmid and get_all_instances_in_course
5.summary: Add support for additional settings in BigBlueButton module edit form
description: As is being part of 4.2, we also need to extend the implementation to support custom settings in the activity standard edit form. This would be a better way to solve
|
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: My course overview improvements
description: This Epic is tracking all of the tasks related to completing the project MUA-26. "a redesign of the My Courses overview thats been used on My Dashboard" Here are the prototypes this work will be based on (quoting comment from UX-8| quote Prototype 6c Test plan: Course Overview Test Plan.rtf Desktop Scenario 1: Scenario 2: Mobile (WIP) Sort by dates Sort by courses Scenario 2: quote Developer documentation:
| Unsolvable | 1.summary: Add exporters for the new calendar classes
description: Exporters for classes created in .
2.summary: Respond to the MUA with a statement of work
description: Analyse the requirements and respond to the MUA with a statement of work for this project.
3.summary: Technical specification for My course overview improvements
description: Review the UI design for the My Course Overview improvements project and design the new APIs that are needed to support those screens.
4.summary: Remove block_course_overview block
description: There is another issue to add this to the plugins DB. See
5.summary: Deprecate xxx_print_overview() and related functions
description: They will no longer be used by core due to . Display debugging messages.
6.summary: Alter database table event to store more information
description: As components will _decorate_ the calendar events which are relevant to the myoverview block, not all of the information mentioned in the document below will need to be stored. We may want to use a separate table to store the information relevant to the completion of a calendar event. The functions to create the events must support the newly added persisted properties (sort date, etc...). See
7.summary: Add infrastructure for new block
description: Call it block_myoverview with pluginname being My overview.
8.summary: Write upgrade code to replace course overview with my overview
description: If the block_course_overview block is installed then do nothing. If the block_course_overview block is not installed then replace occurrences of it with block_myoverview.
9.summary: Design TODO API
description: This will allow us to create follow-up issues when developing the new API. List of classes. List of functions and what they do.
10.summary: Ability for calendar events and TODOs restricted by logic in component that created the event
description: Eg. Activity due date shown to students. Activity marking deadline shown to teachers.
11.summary: Component that created the calendar event needs to supply action details
description: How to phrase, link, count ... Is there a visibility override (e.g. can the user see this event?) Is the action completed by the user? Will most likely use _component_callback()_. Possibly multiple callbacks will be responsible for this (callback, closure, etc...). See
12.summary: Design course progress API
description: We need this to display those nice pie graphs. This solely uses the completion API. If courses do not use the completion API we do not give a progress estimate.
13.summary: Create timeline by date templates
description: See:
14.summary: Create timeline by courses templates
description: See
15.summary: Create courses templates
description: See:
16.summary: Create issues for the AMD modules needed to load data etc for templates
description: For fetching TODOs, and many more things. A bunch of small AMD modules will be needed, create issues for each.
17.summary: Create Behat tests for UI
description: This will need to be broken down in to smaller issues for each user story.
18.summary: Add function to calendar API to get all events for a user
description: This function accepts a from and to date. Ensure the function does not return duplicated events (example: overrides) - May be related to . This function will return a collection of events, and _myoverview_ events. (The callback transforming data to myoverview events should be done in )
19.summary: Create a function which returns the events relevant to the myoverview block timeline sort by dates view
description: This only returns the events which are _decorated_ with an action. The function needs to be comprehensive enough to return the calendar events required for the "sort by dates" view in the timeline of the myoverview block. However it doesnt necessarily need to be specific to that use (general is good). function needs to live in calendar/lib.php or potentially add calendar/classes/api.php and deprecate functions in calendar/lib.php
20.summary: Move the calendar_event class
description: We need to move this class so that it uses namespacing and allows us to further customise/extend it ready for myoverview events.
21.summary: Use the new classes across the calendar API
description: Backwards compatibility must be maintained.
22.summary: Functions to fetch courses per current, upcoming and completed
description: These are paginated. See prototype.
23.summary: Show course progress on myoverview block
description: Show the users course progress percentage in a doughnut chart on the myoverview block
24.summary: Create an external function to get myoverview events for the timeline sort by dates view
description: Create an external function that return the calendar events for the timeline sort by dates view (other external functions will be addressed in separate issues). The external function will likely use the API added in . The function is primarily for the sort by dates view however is not limited to that. A generic function would be nice.
25.summary: Create an external function to get myoverview events for a user grouped by courses
description: As the summary says.
26.summary: Create external functions to fetch courses and their progress
description: Those courses need to be filtered by upcoming, current and completed.
27.summary: Add context examples to the templates
description: Once the context for the templates is finalised add in some example contexts for the docs.
28.summary: Create an AMD module for the main myoverview block
description: Add an AMD module to manage the overall block view. Doing things like switching between the timeline view and courses view.
29.summary: Create an AMD module for the timeline view
description: Create an AMD module that manages the timeline view of the block. Doing stuff like switching between the date and courses view and triggering data load on the "view more" button press.
30.summary: Create an AMD module for the timeline dates view
description: Module to load all of the event data and render the correct templates and stuff.
31.summary: Create an AMD module for the timeline courses view
description: Needs to retrieve the correct information (has course information in this one) with the events and load more etc. Render the correct templates.
32.summary: Create an AMD module for the courses view
description: The module needs to handle switching between the in progress, future and past views. It also needs to use the course retrieval module to get the data from the server and then render the correct templates for it.
33.summary: Create an AMD module for retrieving the calendar events from the server
description: Need a simple module to handles sending the ajax requests to the server to get the calendar events. It should provide and API for retrieving calendar events by user in a given date range and by user in a specific course for a given date range. It also needs to support paginated responses (limit + offset).
34.summary: Create an AMD module for retrieving course progress
description: Need a simple module to handles sending the ajax requests to the server to get the course progress to render in the courses view of the block. It should provide and API for retrieving courses by date (in progress, future, past) and needs to support pagination (i.e. limit + offset). We may also want to allow you to embed the calendar events by request to allow us to skip doing multiple requests for the timeline view sorted by courses. Depends on the implementation.
35.summary: Trigger an event for when we show and hide calendar events
description: After removing the function calendar_event_hook() in 3.3 we should add events so the actions can still be acted on if a developer wishes.
36.summary: Remove the function calendar_event_hook()
description: This function should be removed, or at least a deprecation message should be shown if the $CFG->calendar file exists. Devs should be using the Moodle events system to achieve this behaviour, not use this hacky calendar specific implementation.
37.summary: Investigate current state of activity modules re: calendar events
description: For each module create an issue and check: Is the list of calendar events sensible Should the calendar events be restricted by role Consider how we will implement the TODO stuff for each calendar event
38.summary: Style timeline view to match the prototype
description: Add more styling to the timeline view so that it more closely matches the prototype. Both the desktop and mobile styling will need to be addressed. Things like vertically centering the action links, making the icon larger etc. Need to do both boost and clean themes. Also need to cover RTL styling.
39.summary: Create calendar class for action events
description: This can be located in calendar/classes/action_event.php.
40.summary: Write upgrade code for existing events
description: The issue altered the database table event to accommodate for our new action events. We should write some upgrade code to alter appropriate existing events so they appear on the My overview block. It was discussed a couple of times about ignoring existing events but I think this is a bad approach. Eg. Large university gets excited about Moodle 3.3 and the new block. Makes announcement to students etc. Does upgrade, nothing shown on block. Removes block.
41.summary: Investigate the calendar action events required for the assignment activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
42.summary: Investigate the calendar action events required for the chat activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
43.summary: Investigate the calendar action events required for the choice activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
44.summary: Investigate the calendar action events required for the database activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
45.summary: Investigate the calendar action events required for the external tool activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
46.summary: Investigate the calendar action events required for the feedback activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
47.summary: Investigate the calendar action events required for the forum activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
48.summary: Investigate the calendar action events required for the glossary activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
49.summary: Investigate the calendar action events required for the lesson activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
50.summary: Investigate the calendar action events required for the quiz activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
51.summary: Investigate the calendar action events required for the SCORM activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
52.summary: Investigate the calendar action events required for the survey activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
53.summary: Investigate the calendar action events required for the wiki activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
54.summary: Investigate the calendar action events required for the workshop activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
55.summary: Create the calendar action events for the assignment activity
description: . Events required: . Student - Create an action event if the "due date" is set. The time sort value should be based on the due date however the availability of the "add submission" link in the my overview block should be based on the "allow submissions from" value, if one is set. e.g. if an assignment is created with a due date 15 days in the future but only allows submissions from 10 days in the future then the event will appear in the list on the myoverview block with a disabled "add submission" link until the 10 days has passed. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. - Create an action event that when the user received a "user override" with the same rules as above - Create an action event that when the user received a "group override" with the same rules as above . Teacher - Add a new date option in the "availability" section when creating the activity that allows the teacher to specify the expected "grade by" date which can be enabled by default and use the default values specified in the admin settings. The default value will be the admin setting + the latest date between the "due date" and the "cut-off date" (if its specified). - Create a calendar event if the "grade by" date is set for assignment where the time sort value will be the specified "grade by" and the availability of the action will be based on the latest date between the "due date" and "cut-off date" (if its specified). The action item count should be equal to the number of submissions waiting to be graded. . Existing event behaviour (thanks Mark): Default. If you specify a Due date an event is created on that day. User override. If you specify an Allow submissions from date AND a Due date date an event is created that spans that length of time (assuming its length is less than or equal to ASSIGN_MAX_EVENT_LENGTH), if it exceeds this it will create two separate events. If you specify an Available from date an event is created on that day. If you specify a Deadline date an event is created on that day. Group override. If you specify an Allow submissions from date AND a Due date date an event is created that spans that length of time (assuming its length is less than or equal to ASSIGN_MAX_EVENT_LENGTH), if it exceeds this it will create two separate events. If you specify an Available from date an event is created on that day. If you specify a Deadline date an event is created on that day.
56.summary: Create the calendar action events required for the chat activity
description: It looks like there is already an existing event that will need to be modified to add the actions. . Required events: . Student - Create an action event where the "sort time" is set to the "next chat time" unless "dont publish any chat times" is set. The action url should appear disabled until after the "Next chat time" has past. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. - No user or group overrides . Teacher - Same action event as the student . Existing events (thanks Mark) Default. If you choose not to publish any chat times no event is created. If you choose to publish chat times (doesn t matter which other option as long as it is not Don t publish any chat times ) it creates one event for that day. User override. Not an option. Group override. Not an option.
57.summary: Create the calendar action events required for the choice activity
description: Add or modify the existing events to match the required events . Required events . Student - If the "allow responses from" date is set then create an action event where the sort time is set to the value of "allow responses from". The action url should appear disabled until after the "allow responses from" time has past. - If the "allow responses until" date is set then create an action event where the sort time is set to the value of "allow responses until". The action url should appear enabled for the period up until the "allow responses until" time has past. - If both the "allow responses from" and "allow responses until" values are set then an action event should be created where the sort time is the "allow responses until". The action url should appear enabled during the period between the "allow responses from" and the "allow responses until" times. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher - No events required. . Existing events (thanks Mark) Default. If you specify an Allow responses from date an event is created on that day. If you specify an Allow responses until date an event is created on that day. User override. Not an option. Group override. Not an option.
58.summary: Add a way to retrieve action events for pagination
description: Not all users enrolled in a module will have a action to complete for each action event created. We need a way to filter out events that a user shouldnt see prior to pulling the data from the database to allow the database to handle the pagination for us. Whether or not a user will see an action event is based on their capabilities within the module. One possible solution is to ask each module for the list of event types that user should see and then use those in the database query to make sure we only receive results that the user is guaranteed to see. We could even implement some caching to pre-fetch this information rather than needing to calculate it on the fly each time.
59.summary: Create the calendar action events required for the database activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Available to date an event is created on that day. The action url should appear enabled for the period up until the Available to time has passed. If both the Available from and Available to values are set then an action event should be created where the sort time is the Available to time. The action url should appear enabled during the period between the Available from and the Available to times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher If the setting Approval required is enabled then the teacher needs to have an action event when an entry is created. The action item count should be the number of entries that need approval. . Existing events . Default If you specify an Available from date an event is created on that day. If you specify an Available to date an event is created on that day. . User override Not an option. . Group override Not an option.
60.summary: Create the calendar action events required for activity completion
description: Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
61.summary: Create the calendar action events required for the feedback activity
description: . Required events . Student If you specify an Allow answers from date an event is created on that day. The action url should appear disabled until after the Allow answers from time has passed. If you specify an Allow answers to date an event is created on that day. The action url should appear enabled for the period up until the Allow answers to time has passed. If both the Allow answers from and Allow answers to values are set then an action event should be created where the sort time is the Allow answers to. The action url should appear enabled during the period between the Allow answers from and the Allow answers to times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher If the setting Enable notification of submissions (or maybe we can ignore this setting if it is strictly tied to notifications) is enabled then the teacher needs to have an action event when feedback is added. The action item count should be the number of entries that need approval. . Existing events . Default If you specify an Available from date an event is created on that day. If you specify an Available to date an event is created on that day. . User override Not an option. . Group override Not an option.
62.summary: Move existing functions from calendar/lib.php to calendar/classes/api.php
description: The API should be located in one place and to make it nice and neat we should locate it at calendar/classes/api.php. This will involve deprecating the functions in calendar/lib.php and having them call the new implementation.
63.summary: Migrate pubic calendar API to an API class
description: From : "we should not leave the calendar public api in lib.php - please move it to a static class \core_calendar::api so its super clear and obvious - but we dont have the bad effects of a massive lib.php file."
64.summary: Add new column to mod_assign for grading due date
description: We need to add this column so that a teacher can specify what date they expect to be marking the assignment so we can add this to their my overview block instance. We need to remember to include this in backup/restore.
65.summary: Add site-wide setting to be used by activities for default grading due date
description: We are going to be adding new dates to activities (eg. ) and we want to have a default time period after the end date that this will be set so that teachers do not need to touch the date for it to appear in their my overview block instance.
66.summary: Add new column to mod_quiz for grading due date
description: We need to add this column so that a teacher can specify what date they expect to be marking the activity so we can add this to their my overview block instance. We need to remember to include this in backup/restore.
67.summary: Add a mustache helper to shorten text
description: We need to add mustache helpers to shorten the course summary. At the moment we display the whole course summary, we need to short it to match the prototype. The mustache helper needs to be available in both JS and PHP and should work the same as the "shorten_text" function in Moodle.
68.summary: Allow component that created event to determine visibility
description: After is merged we should add another component callback which allows modules to determine if an event is visible or not.
69.summary: Add mustache helpers for user date
description: We need mustache helpers to properly format course start and end dates. Accordingly to the prototype, those dates must be formatted as Feb 15, 2017 (Mon Day, Year). Also the course-summary template needs to be updated to use this new helper.
70.summary: Create the calendar action events required for the forum module
description: At the moment, mod_forum does not create any calendar events, not even using ratings. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
71.summary: Create the calendar action events required for the glossary module
description: At the moment, mod_glossary does not create any calendar events. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
72.summary: Create the calendar action events required for the wiki module
description: At the moment, mod_wiki does not create any calendar events. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
73.summary: Create the calendar action events required for the lesson activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Deadline date an event is created on that day. The action url should appear enabled for the period up until the Deadline time has passed. If both the Available from and Deadline values are set then an action event should be created where the sort time is the Available from. The action url should appear enabled during the period between the Available from and the Deadline times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
74.summary: Create the calendar action events required for the workshop activity
description: . Required events . Student If you specify an Open for submissions from date an event is created on that day. The action url should appear disabled until after the Open for submissions from time has passed. If you specify an Submissions deadline date an event is created on that day. The action url should appear enabled for the period up until the Submissions deadline time has passed. If both the Open for submissions from and Submissions deadline values are set then an action event should be created where the sort time is the Submissions deadline. The action url should appear enabled during the period between the Open for submissions from and the Submissions deadline times. If you specify an Open for assessment from date an event is created on that day. The action url should appear disabled until after the Open for assessment from time has passed. If you specify an Deadline for assessment date an event is created on that day. The action url should appear enabled for the period up until the Deadline for assessment time has passed. If both the Open for assessment from and Deadline for assessment values are set then an action event should be created where the sort time is the Deadline for assessment. The action url should appear enabled during the period between the Open for assessment from and the Deadline for assessment times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
75.summary: Create the calendar action events required for the SCORM activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Deadline date an event is created on that day. The action url should appear enabled for the period up until the Deadline time has passed. If both the Available from and Deadline values are set then an action event should be created where the sort time is the Available from. The action url should appear enabled during the period between the Available from and the Deadline times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
76.summary: Create the calendar action events required for the quiz activity
description: . Events required: . Student If you specify a date+time for the Open the quiz field, an event is created on that day. The action url should appear disabled until this date+time has passed If you specify a date+time for the Close the quiz date an event is created on that day. The action url should appear enabled for the period up until this date+time has passed If both the Open the quiz and Close the quiz values are set then an action event should be created where the sort time is the Close the quiz field. The action url should appear enabled during the period between the Open the quiz and the Close the quiz times Standard activity completion event required (if activity completion is specified) unless any of the other events are created. Create an action event that when the user received a "user override" with the same rules as above Create an action event that when the user received a "group override" with the same rules as above . Teacher None as best I can tell
77.summary: Allow events to have an item count but not necessarily show them
description: In some cases we want 1 to be displayed (e.g., teacher looking at how many assignments to grade) but in other situations we dont (student looking at their assignment for example).
78.summary: In core_calendar\local\event\factories we use $coursecache but it isnt static
description: Every time we instantiate this class we create an empty array so get_course_cached appears useless. Fix this.
79.summary: Look at prototype for bulk completion for activities
description: Create issues to deal with this.
80.summary: Make sure event overrides (user, group) are obeyed on dashboard page
description: Ensure it displays the same events that are listed on the calendar block (using priority introduced by ).
81.summary: Display course progress chart
description: We need those circle things that show the percentage completed.
82.summary: Render courses view data on server side
description: As we have all courses the user is enrolled being loaded for the timeline view by courses, we should change the courses view rendering to happen on the server side. At the moment, both renderables (course_summary and courses_view) call enrol_get_my_courses() function. We need to change the way those renderables load the users courses to avoid unnecessary db calls.
83.summary: Display a message when there are no calendar events
description: If you go to timeline view, if there are no calendar events for that user, it simply does not display any message, besides it display View more buttons. Same for timeline view by courses.
84.summary: Ensure templates respect events actionability
description: We added an actionability characteristic in so that we can display an event on the my overview block but have the link greyed out (unactionable). This means the user can see that an event is happening in the future (and prepare for it) but currently can not action it (eg. submit an assignment due to submission date being in the future). This means users can see events in the future without them suddenly appearing when they become actionable.
85.summary: Change the defaults for completion so it is enabled by default for courses and activities with sensible defaults.
description: The dashboard course progress relys on completsion so if it is not enabled, the dashboard will be less useful.
86.summary: Format timestamps on myoverview block using mustache helper
description: Once gets integrated into core user it to format the dates for the myoverview block. Remember to remove the formatted dates from the renderables coming from the server, since they wont be needed any longer. The server should just return time stamps.
87.summary: Shorten course summaries on myoverview block using mustache helper
description: Once gets integrated to core use it to shorten the course summaries on the myoverview block.
88.summary: We should use the cm_info data before calling callbacks
description: The is_event_visible callback should perform the following (pseudo) code before implementing its own functionality. code $cm = get_fast_modinfo($event->courseid)->instancesscorm$event->instance; return $cm->visible code The code above does a bunch of checks including restrict access settings. We could remove this callback from most modules and have the event_factory perform this, saving duplicated code and third-party devs having to implement a function.
89.summary: Review changes in modules
description: With it may now not be necessary for some modules to contain this callback. We should also do general check to ensure consistency. It may end up that this issue requires no code as everything is fine.
90.summary: Only show the current courses on the "sort-by-courses" view of the myoverview block on the dashboard
description: The timeline -> sort by courses view should only display the current courses. All past and future courses should not be displayed here.
91.summary: Dont display the course icon at all if course progress is not enabled
description: If the course doesnt have progress enabled we currently just show a placeholder icon where the course progress doughnut would be displayed. Instead of the placeholder we should just show nothing if course progress isnt enabled.
92.summary: Change the wording for the "grading due date" setting in assignment
description: Something a bit softer that implies its used for the event on the dashboard would be nice. Perhaps "Remind me to grade by" or similar.
93.summary: Order the courses on the timeline -> sort by course and courses tab by name ascending
description: Need to order the courses in a consistent and predictable manner when they are displayed in the block. Currently (I think) it defaults to sorting by course id but it would be better to use course name ascending.
94.summary: Display course full name rather than short name
description: Short names arent very helpful (eg C101) and the prototype is using full names.
95.summary: Fixed incompatibility with PHP 5.x
description: This feature does not work in PHP 5.x due to usage of features that were introduced in 7.
96.summary: Events should not display if there is nothing to do
description: If you create an assignment activity with grading due date set, it displays in the overview for a teacher even when no students have submitted anything. There should probably be a check somewhere that stops events displaying if the actioncount is 0.
97.summary: Assign override is created with wrong eventtype
description: If you create an assignment with a due date, then create a user override for the due date, the original event is created with eventtype set to due, but the override has it set to close. They should both be due. Possibly there are other similar issues caused by the recent rebase. Probably best to compare our dev branchs behaviour with masters behaviour.
98.summary: Add placeholder when the user has no upcoming events
description: Add placeholder images for the event event lists in both the sort by dates and sort by courses views in the timeline. See UX-31 for details.
99.summary: Create behat step to take the user to course page
description: At the moment, a lot of behat tests were using the course overview block to get to the course. Now, that we removed that block we have to create a behat step to get to the course without having to go to the site home page first. Also, all following combination of steps needs to rewritten: noformat And I am on site homepage And I follow "Course 1" noformat
100.summary: Disable the pagination bar if there is only one page
description: Currently the pagination shows as if it is active even if there is only 1 page. It should disabled.
101.summary: Show overdue events
description: We need to display any overdue events to the user at the top of the Timeline (when sorted by date). !s2 timeline courses overdue.png|thumbnail! There is a cost/benefit decision to be made here. Unfortunately, in order to fetch the events, we need to fetch a number of events, and then filter out any events which are no longer relevant. Whilst fetching from the database has a relatively low fixed cost, the filtration can be expensive and is dependant upon the individual module, and activity completion criterion. In addition, it is not feasible to cache which events are or are not completed for a user (because there are many factors which determine whether an activity can be complete and not all of these stem from specific actions). Generally speaking, we expect a majority of past events to have been completed. If we were to go back and fetch all overdue events, we would have to process all past events to determine whether they have been completed or not. Therefore we feel it is sensible to limit the time period to go back for to a shorter period of around 7-14 days. One of the features of the timeline is to highlight the critical information first. Going too far back in time has a decreasing benefit as it could be argued the activity is less likely to be completed the more overdue it is. Theres also little benefit to increasing the total limit of events to show (currently 20) for the same reason.
102.summary: The courses shown on the Courses tab should be the same size
description: See screenshot. Try with long course names and descriptions.
103.summary: Make room for blocks on the dashboard for XL (Bootstrap)
description: Currently (in the latest prototype) the blocks always go under in the centre region. There are worries that this may upset users as they have to scroll down to use blocks they would often use.
104.summary: Ensure all data in myoverview block can be fetched by a webservice
description: The mobile team will need webservices to fetch all the data we use in the templates for myoverview. Most of them should be done already, but we will need at least one to fetch the list of users courses with their progress information.
105.summary: Events should not show up on the my overview dashboard when they have been completed by the user
description: Once the user has completed the required action for the event (e.g. submitted an assignment or what ever) the action event should no longer appear on the dashboard. This will need to be worked out per module in the callbacks. . mod_assign Changing this to only show the events if there is no submission. Drafts, new, and re-opened submissions are still shown . mod_chat Visibility Chats before _today_ are _not_ visible Chats today_ or in the future _are_ visible Actionable Chats which are at some point today _are_ actionable Chats after today (from midnight on) _are not_ actionable
106.summary: Bailout callback should use $cm->uservisible, not $cm->visible
description: If you override the view capability for a module to prevent a user from viewing it it is possible for it to still be shown in the dashboard (but wont for the calendar). This is because the modinfo cache performs the call to is_user_access_restricted_by_capability() which checks if the capability mod/xyz:view is present in the module, and if so performs a has_capability check on it. The course module attribute uservisible contains this logic, where as visible doesnt.
107.summary: Undefined constant when running unit tests separately
description: When running vendor/bin/phpunit mod/forum/tests/lib_test.php you get undefined constant errors.
108.summary: Event vault not properly filtering results
description: The event vault isnt properly filtering out non action events for the get_action blah blah function.
109.summary: Fix CiBoT complaints on dev branch
description: Fix CiBoT complaints on dev branch
110.summary: Move calendar/classes/event.php to calendar/lib.php
description: This file contains legacy code that we want to deprecate in the future. We have already deprecated the class calendar_event and are now using \core_calendar\event but if we then deprecate \core_calendar\event devs are going to get annoyed that after a few releases they have had to keep changing their code. Moving the file also means this namespace is reserved for the proper events class.
111.summary: Move calendar/classes/api.php to calendar/lib.php
description: This file contains legacy code that we want to deprecate in the future. We have already deprecated the functions in calendar/lib.php and are now using \core_calendar\api but if we then deprecate the functions in \core_calendar\api in near future release devs are going to get annoyed that after a few releases they have had to keep changing their code. Moving this also means this namespace is reserved for the proper API class.
112.summary: Add more details to blocks/upgrade.txt
description: Add more details so people know they need to add this block before performing site upgrade.
113.summary: Rename calendar event API interfaces, removing the _interface suffix
description: We have a bunch of interfaces in a namespace that already contains the word "interface", so the _interface suffix is not really needed. Also rename the core_container to simply container
114.summary: Improve core_container based on integration feedback
description: The core_ prefix is confusing and doesnt really add any value. It would be better to rename it simple container. The container should be well documented as its the place where all the building blocks are composed together to achieve the functionality we need. Since the container acts as a quasi-DI container, as well as deciding on concrete implementations to use, factories that are used only in the container are redundant. From the most recent IR: "Without dependency injection or similar systems, factories must serve a purpose to be useful; event_factory & event_abstract_factory together or separated make sense. I dont see though how action_event_factory serve any purpose, it is exactly the same to hardcode action_event_factory in core_container than to hardcode new action_event, without a purpose nor an extension point they are 100 redundant. Getting rid of them would also kill action_event_factory_interface"
| 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: My course overview improvements
description: This Epic is tracking all of the tasks related to completing the project MUA-26. "a redesign of the My Courses overview thats been used on My Dashboard" Here are the prototypes this work will be based on (quoting comment from UX-8| quote Prototype 6c Test plan: Course Overview Test Plan.rtf Desktop Scenario 1: Scenario 2: Mobile (WIP) Sort by dates Sort by courses Scenario 2: quote Developer documentation:
### Response:
1.summary: Add exporters for the new calendar classes
description: Exporters for classes created in .
2.summary: Respond to the MUA with a statement of work
description: Analyse the requirements and respond to the MUA with a statement of work for this project.
3.summary: Technical specification for My course overview improvements
description: Review the UI design for the My Course Overview improvements project and design the new APIs that are needed to support those screens.
4.summary: Remove block_course_overview block
description: There is another issue to add this to the plugins DB. See
5.summary: Deprecate xxx_print_overview() and related functions
description: They will no longer be used by core due to . Display debugging messages.
6.summary: Alter database table event to store more information
description: As components will _decorate_ the calendar events which are relevant to the myoverview block, not all of the information mentioned in the document below will need to be stored. We may want to use a separate table to store the information relevant to the completion of a calendar event. The functions to create the events must support the newly added persisted properties (sort date, etc...). See
7.summary: Add infrastructure for new block
description: Call it block_myoverview with pluginname being My overview.
8.summary: Write upgrade code to replace course overview with my overview
description: If the block_course_overview block is installed then do nothing. If the block_course_overview block is not installed then replace occurrences of it with block_myoverview.
9.summary: Design TODO API
description: This will allow us to create follow-up issues when developing the new API. List of classes. List of functions and what they do.
10.summary: Ability for calendar events and TODOs restricted by logic in component that created the event
description: Eg. Activity due date shown to students. Activity marking deadline shown to teachers.
11.summary: Component that created the calendar event needs to supply action details
description: How to phrase, link, count ... Is there a visibility override (e.g. can the user see this event?) Is the action completed by the user? Will most likely use _component_callback()_. Possibly multiple callbacks will be responsible for this (callback, closure, etc...). See
12.summary: Design course progress API
description: We need this to display those nice pie graphs. This solely uses the completion API. If courses do not use the completion API we do not give a progress estimate.
13.summary: Create timeline by date templates
description: See:
14.summary: Create timeline by courses templates
description: See
15.summary: Create courses templates
description: See:
16.summary: Create issues for the AMD modules needed to load data etc for templates
description: For fetching TODOs, and many more things. A bunch of small AMD modules will be needed, create issues for each.
17.summary: Create Behat tests for UI
description: This will need to be broken down in to smaller issues for each user story.
18.summary: Add function to calendar API to get all events for a user
description: This function accepts a from and to date. Ensure the function does not return duplicated events (example: overrides) - May be related to . This function will return a collection of events, and _myoverview_ events. (The callback transforming data to myoverview events should be done in )
19.summary: Create a function which returns the events relevant to the myoverview block timeline sort by dates view
description: This only returns the events which are _decorated_ with an action. The function needs to be comprehensive enough to return the calendar events required for the "sort by dates" view in the timeline of the myoverview block. However it doesnt necessarily need to be specific to that use (general is good). function needs to live in calendar/lib.php or potentially add calendar/classes/api.php and deprecate functions in calendar/lib.php
20.summary: Move the calendar_event class
description: We need to move this class so that it uses namespacing and allows us to further customise/extend it ready for myoverview events.
21.summary: Use the new classes across the calendar API
description: Backwards compatibility must be maintained.
22.summary: Functions to fetch courses per current, upcoming and completed
description: These are paginated. See prototype.
23.summary: Show course progress on myoverview block
description: Show the users course progress percentage in a doughnut chart on the myoverview block
24.summary: Create an external function to get myoverview events for the timeline sort by dates view
description: Create an external function that return the calendar events for the timeline sort by dates view (other external functions will be addressed in separate issues). The external function will likely use the API added in . The function is primarily for the sort by dates view however is not limited to that. A generic function would be nice.
25.summary: Create an external function to get myoverview events for a user grouped by courses
description: As the summary says.
26.summary: Create external functions to fetch courses and their progress
description: Those courses need to be filtered by upcoming, current and completed.
27.summary: Add context examples to the templates
description: Once the context for the templates is finalised add in some example contexts for the docs.
28.summary: Create an AMD module for the main myoverview block
description: Add an AMD module to manage the overall block view. Doing things like switching between the timeline view and courses view.
29.summary: Create an AMD module for the timeline view
description: Create an AMD module that manages the timeline view of the block. Doing stuff like switching between the date and courses view and triggering data load on the "view more" button press.
30.summary: Create an AMD module for the timeline dates view
description: Module to load all of the event data and render the correct templates and stuff.
31.summary: Create an AMD module for the timeline courses view
description: Needs to retrieve the correct information (has course information in this one) with the events and load more etc. Render the correct templates.
32.summary: Create an AMD module for the courses view
description: The module needs to handle switching between the in progress, future and past views. It also needs to use the course retrieval module to get the data from the server and then render the correct templates for it.
33.summary: Create an AMD module for retrieving the calendar events from the server
description: Need a simple module to handles sending the ajax requests to the server to get the calendar events. It should provide and API for retrieving calendar events by user in a given date range and by user in a specific course for a given date range. It also needs to support paginated responses (limit + offset).
34.summary: Create an AMD module for retrieving course progress
description: Need a simple module to handles sending the ajax requests to the server to get the course progress to render in the courses view of the block. It should provide and API for retrieving courses by date (in progress, future, past) and needs to support pagination (i.e. limit + offset). We may also want to allow you to embed the calendar events by request to allow us to skip doing multiple requests for the timeline view sorted by courses. Depends on the implementation.
35.summary: Trigger an event for when we show and hide calendar events
description: After removing the function calendar_event_hook() in 3.3 we should add events so the actions can still be acted on if a developer wishes.
36.summary: Remove the function calendar_event_hook()
description: This function should be removed, or at least a deprecation message should be shown if the $CFG->calendar file exists. Devs should be using the Moodle events system to achieve this behaviour, not use this hacky calendar specific implementation.
37.summary: Investigate current state of activity modules re: calendar events
description: For each module create an issue and check: Is the list of calendar events sensible Should the calendar events be restricted by role Consider how we will implement the TODO stuff for each calendar event
38.summary: Style timeline view to match the prototype
description: Add more styling to the timeline view so that it more closely matches the prototype. Both the desktop and mobile styling will need to be addressed. Things like vertically centering the action links, making the icon larger etc. Need to do both boost and clean themes. Also need to cover RTL styling.
39.summary: Create calendar class for action events
description: This can be located in calendar/classes/action_event.php.
40.summary: Write upgrade code for existing events
description: The issue altered the database table event to accommodate for our new action events. We should write some upgrade code to alter appropriate existing events so they appear on the My overview block. It was discussed a couple of times about ignoring existing events but I think this is a bad approach. Eg. Large university gets excited about Moodle 3.3 and the new block. Makes announcement to students etc. Does upgrade, nothing shown on block. Removes block.
41.summary: Investigate the calendar action events required for the assignment activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
42.summary: Investigate the calendar action events required for the chat activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
43.summary: Investigate the calendar action events required for the choice activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
44.summary: Investigate the calendar action events required for the database activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
45.summary: Investigate the calendar action events required for the external tool activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
46.summary: Investigate the calendar action events required for the feedback activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
47.summary: Investigate the calendar action events required for the forum activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
48.summary: Investigate the calendar action events required for the glossary activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
49.summary: Investigate the calendar action events required for the lesson activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
50.summary: Investigate the calendar action events required for the quiz activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
51.summary: Investigate the calendar action events required for the SCORM activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
52.summary: Investigate the calendar action events required for the survey activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
53.summary: Investigate the calendar action events required for the wiki activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
54.summary: Investigate the calendar action events required for the workshop activity
description: Look through the activity to determine which calendar action events (if any) need to be created. When deciding which action events need to be created consider: . Guides: All activities that have a completion criteria added (e.g. that completion section when creating an activity) with a completion date defined must have a corresponding action calendar event created If an activity allows you to specify any sort of date in the settings it should also create an action event for that date Create a different event based on the range of roles of the users enrolled in the activity, e.g. for assignment there should be a student event that says "submit assignment" but for a teacher there should be an event that says "mark assignments". . Project goals: on the status of activities/resources within a course A teacher progress overview without going into a course. A teachers overview on which activities still need graded. Showing course and/or activity progress within a course for students. See this doc for details about existing events:
55.summary: Create the calendar action events for the assignment activity
description: . Events required: . Student - Create an action event if the "due date" is set. The time sort value should be based on the due date however the availability of the "add submission" link in the my overview block should be based on the "allow submissions from" value, if one is set. e.g. if an assignment is created with a due date 15 days in the future but only allows submissions from 10 days in the future then the event will appear in the list on the myoverview block with a disabled "add submission" link until the 10 days has passed. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. - Create an action event that when the user received a "user override" with the same rules as above - Create an action event that when the user received a "group override" with the same rules as above . Teacher - Add a new date option in the "availability" section when creating the activity that allows the teacher to specify the expected "grade by" date which can be enabled by default and use the default values specified in the admin settings. The default value will be the admin setting + the latest date between the "due date" and the "cut-off date" (if its specified). - Create a calendar event if the "grade by" date is set for assignment where the time sort value will be the specified "grade by" and the availability of the action will be based on the latest date between the "due date" and "cut-off date" (if its specified). The action item count should be equal to the number of submissions waiting to be graded. . Existing event behaviour (thanks Mark): Default. If you specify a Due date an event is created on that day. User override. If you specify an Allow submissions from date AND a Due date date an event is created that spans that length of time (assuming its length is less than or equal to ASSIGN_MAX_EVENT_LENGTH), if it exceeds this it will create two separate events. If you specify an Available from date an event is created on that day. If you specify a Deadline date an event is created on that day. Group override. If you specify an Allow submissions from date AND a Due date date an event is created that spans that length of time (assuming its length is less than or equal to ASSIGN_MAX_EVENT_LENGTH), if it exceeds this it will create two separate events. If you specify an Available from date an event is created on that day. If you specify a Deadline date an event is created on that day.
56.summary: Create the calendar action events required for the chat activity
description: It looks like there is already an existing event that will need to be modified to add the actions. . Required events: . Student - Create an action event where the "sort time" is set to the "next chat time" unless "dont publish any chat times" is set. The action url should appear disabled until after the "Next chat time" has past. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. - No user or group overrides . Teacher - Same action event as the student . Existing events (thanks Mark) Default. If you choose not to publish any chat times no event is created. If you choose to publish chat times (doesn t matter which other option as long as it is not Don t publish any chat times ) it creates one event for that day. User override. Not an option. Group override. Not an option.
57.summary: Create the calendar action events required for the choice activity
description: Add or modify the existing events to match the required events . Required events . Student - If the "allow responses from" date is set then create an action event where the sort time is set to the value of "allow responses from". The action url should appear disabled until after the "allow responses from" time has past. - If the "allow responses until" date is set then create an action event where the sort time is set to the value of "allow responses until". The action url should appear enabled for the period up until the "allow responses until" time has past. - If both the "allow responses from" and "allow responses until" values are set then an action event should be created where the sort time is the "allow responses until". The action url should appear enabled during the period between the "allow responses from" and the "allow responses until" times. - Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher - No events required. . Existing events (thanks Mark) Default. If you specify an Allow responses from date an event is created on that day. If you specify an Allow responses until date an event is created on that day. User override. Not an option. Group override. Not an option.
58.summary: Add a way to retrieve action events for pagination
description: Not all users enrolled in a module will have a action to complete for each action event created. We need a way to filter out events that a user shouldnt see prior to pulling the data from the database to allow the database to handle the pagination for us. Whether or not a user will see an action event is based on their capabilities within the module. One possible solution is to ask each module for the list of event types that user should see and then use those in the database query to make sure we only receive results that the user is guaranteed to see. We could even implement some caching to pre-fetch this information rather than needing to calculate it on the fly each time.
59.summary: Create the calendar action events required for the database activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Available to date an event is created on that day. The action url should appear enabled for the period up until the Available to time has passed. If both the Available from and Available to values are set then an action event should be created where the sort time is the Available to time. The action url should appear enabled during the period between the Available from and the Available to times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher If the setting Approval required is enabled then the teacher needs to have an action event when an entry is created. The action item count should be the number of entries that need approval. . Existing events . Default If you specify an Available from date an event is created on that day. If you specify an Available to date an event is created on that day. . User override Not an option. . Group override Not an option.
60.summary: Create the calendar action events required for activity completion
description: Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
61.summary: Create the calendar action events required for the feedback activity
description: . Required events . Student If you specify an Allow answers from date an event is created on that day. The action url should appear disabled until after the Allow answers from time has passed. If you specify an Allow answers to date an event is created on that day. The action url should appear enabled for the period up until the Allow answers to time has passed. If both the Allow answers from and Allow answers to values are set then an action event should be created where the sort time is the Allow answers to. The action url should appear enabled during the period between the Allow answers from and the Allow answers to times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created. . Teacher If the setting Enable notification of submissions (or maybe we can ignore this setting if it is strictly tied to notifications) is enabled then the teacher needs to have an action event when feedback is added. The action item count should be the number of entries that need approval. . Existing events . Default If you specify an Available from date an event is created on that day. If you specify an Available to date an event is created on that day. . User override Not an option. . Group override Not an option.
62.summary: Move existing functions from calendar/lib.php to calendar/classes/api.php
description: The API should be located in one place and to make it nice and neat we should locate it at calendar/classes/api.php. This will involve deprecating the functions in calendar/lib.php and having them call the new implementation.
63.summary: Migrate pubic calendar API to an API class
description: From : "we should not leave the calendar public api in lib.php - please move it to a static class \core_calendar::api so its super clear and obvious - but we dont have the bad effects of a massive lib.php file."
64.summary: Add new column to mod_assign for grading due date
description: We need to add this column so that a teacher can specify what date they expect to be marking the assignment so we can add this to their my overview block instance. We need to remember to include this in backup/restore.
65.summary: Add site-wide setting to be used by activities for default grading due date
description: We are going to be adding new dates to activities (eg. ) and we want to have a default time period after the end date that this will be set so that teachers do not need to touch the date for it to appear in their my overview block instance.
66.summary: Add new column to mod_quiz for grading due date
description: We need to add this column so that a teacher can specify what date they expect to be marking the activity so we can add this to their my overview block instance. We need to remember to include this in backup/restore.
67.summary: Add a mustache helper to shorten text
description: We need to add mustache helpers to shorten the course summary. At the moment we display the whole course summary, we need to short it to match the prototype. The mustache helper needs to be available in both JS and PHP and should work the same as the "shorten_text" function in Moodle.
68.summary: Allow component that created event to determine visibility
description: After is merged we should add another component callback which allows modules to determine if an event is visible or not.
69.summary: Add mustache helpers for user date
description: We need mustache helpers to properly format course start and end dates. Accordingly to the prototype, those dates must be formatted as Feb 15, 2017 (Mon Day, Year). Also the course-summary template needs to be updated to use this new helper.
70.summary: Create the calendar action events required for the forum module
description: At the moment, mod_forum does not create any calendar events, not even using ratings. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
71.summary: Create the calendar action events required for the glossary module
description: At the moment, mod_glossary does not create any calendar events. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
72.summary: Create the calendar action events required for the wiki module
description: At the moment, mod_wiki does not create any calendar events. As we need to calculate the percentage of course completion for charts for example, my suggestion is just create a standard activity completion event (if activity completion is set), based on Expect completed on date.
73.summary: Create the calendar action events required for the lesson activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Deadline date an event is created on that day. The action url should appear enabled for the period up until the Deadline time has passed. If both the Available from and Deadline values are set then an action event should be created where the sort time is the Available from. The action url should appear enabled during the period between the Available from and the Deadline times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
74.summary: Create the calendar action events required for the workshop activity
description: . Required events . Student If you specify an Open for submissions from date an event is created on that day. The action url should appear disabled until after the Open for submissions from time has passed. If you specify an Submissions deadline date an event is created on that day. The action url should appear enabled for the period up until the Submissions deadline time has passed. If both the Open for submissions from and Submissions deadline values are set then an action event should be created where the sort time is the Submissions deadline. The action url should appear enabled during the period between the Open for submissions from and the Submissions deadline times. If you specify an Open for assessment from date an event is created on that day. The action url should appear disabled until after the Open for assessment from time has passed. If you specify an Deadline for assessment date an event is created on that day. The action url should appear enabled for the period up until the Deadline for assessment time has passed. If both the Open for assessment from and Deadline for assessment values are set then an action event should be created where the sort time is the Deadline for assessment. The action url should appear enabled during the period between the Open for assessment from and the Deadline for assessment times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
75.summary: Create the calendar action events required for the SCORM activity
description: . Required events . Student If you specify an Available from date an event is created on that day. The action url should appear disabled until after the Available from time has passed. If you specify an Deadline date an event is created on that day. The action url should appear enabled for the period up until the Deadline time has passed. If both the Available from and Deadline values are set then an action event should be created where the sort time is the Available from. The action url should appear enabled during the period between the Available from and the Deadline times. Standard activity completion event required (if activity completion is specified) unless any of the other events are created.
76.summary: Create the calendar action events required for the quiz activity
description: . Events required: . Student If you specify a date+time for the Open the quiz field, an event is created on that day. The action url should appear disabled until this date+time has passed If you specify a date+time for the Close the quiz date an event is created on that day. The action url should appear enabled for the period up until this date+time has passed If both the Open the quiz and Close the quiz values are set then an action event should be created where the sort time is the Close the quiz field. The action url should appear enabled during the period between the Open the quiz and the Close the quiz times Standard activity completion event required (if activity completion is specified) unless any of the other events are created. Create an action event that when the user received a "user override" with the same rules as above Create an action event that when the user received a "group override" with the same rules as above . Teacher None as best I can tell
77.summary: Allow events to have an item count but not necessarily show them
description: In some cases we want 1 to be displayed (e.g., teacher looking at how many assignments to grade) but in other situations we dont (student looking at their assignment for example).
78.summary: In core_calendar\local\event\factories we use $coursecache but it isnt static
description: Every time we instantiate this class we create an empty array so get_course_cached appears useless. Fix this.
79.summary: Look at prototype for bulk completion for activities
description: Create issues to deal with this.
80.summary: Make sure event overrides (user, group) are obeyed on dashboard page
description: Ensure it displays the same events that are listed on the calendar block (using priority introduced by ).
81.summary: Display course progress chart
description: We need those circle things that show the percentage completed.
82.summary: Render courses view data on server side
description: As we have all courses the user is enrolled being loaded for the timeline view by courses, we should change the courses view rendering to happen on the server side. At the moment, both renderables (course_summary and courses_view) call enrol_get_my_courses() function. We need to change the way those renderables load the users courses to avoid unnecessary db calls.
83.summary: Display a message when there are no calendar events
description: If you go to timeline view, if there are no calendar events for that user, it simply does not display any message, besides it display View more buttons. Same for timeline view by courses.
84.summary: Ensure templates respect events actionability
description: We added an actionability characteristic in so that we can display an event on the my overview block but have the link greyed out (unactionable). This means the user can see that an event is happening in the future (and prepare for it) but currently can not action it (eg. submit an assignment due to submission date being in the future). This means users can see events in the future without them suddenly appearing when they become actionable.
85.summary: Change the defaults for completion so it is enabled by default for courses and activities with sensible defaults.
description: The dashboard course progress relys on completsion so if it is not enabled, the dashboard will be less useful.
86.summary: Format timestamps on myoverview block using mustache helper
description: Once gets integrated into core user it to format the dates for the myoverview block. Remember to remove the formatted dates from the renderables coming from the server, since they wont be needed any longer. The server should just return time stamps.
87.summary: Shorten course summaries on myoverview block using mustache helper
description: Once gets integrated to core use it to shorten the course summaries on the myoverview block.
88.summary: We should use the cm_info data before calling callbacks
description: The is_event_visible callback should perform the following (pseudo) code before implementing its own functionality. code $cm = get_fast_modinfo($event->courseid)->instancesscorm$event->instance; return $cm->visible code The code above does a bunch of checks including restrict access settings. We could remove this callback from most modules and have the event_factory perform this, saving duplicated code and third-party devs having to implement a function.
89.summary: Review changes in modules
description: With it may now not be necessary for some modules to contain this callback. We should also do general check to ensure consistency. It may end up that this issue requires no code as everything is fine.
90.summary: Only show the current courses on the "sort-by-courses" view of the myoverview block on the dashboard
description: The timeline -> sort by courses view should only display the current courses. All past and future courses should not be displayed here.
91.summary: Dont display the course icon at all if course progress is not enabled
description: If the course doesnt have progress enabled we currently just show a placeholder icon where the course progress doughnut would be displayed. Instead of the placeholder we should just show nothing if course progress isnt enabled.
92.summary: Change the wording for the "grading due date" setting in assignment
description: Something a bit softer that implies its used for the event on the dashboard would be nice. Perhaps "Remind me to grade by" or similar.
93.summary: Order the courses on the timeline -> sort by course and courses tab by name ascending
description: Need to order the courses in a consistent and predictable manner when they are displayed in the block. Currently (I think) it defaults to sorting by course id but it would be better to use course name ascending.
94.summary: Display course full name rather than short name
description: Short names arent very helpful (eg C101) and the prototype is using full names.
95.summary: Fixed incompatibility with PHP 5.x
description: This feature does not work in PHP 5.x due to usage of features that were introduced in 7.
96.summary: Events should not display if there is nothing to do
description: If you create an assignment activity with grading due date set, it displays in the overview for a teacher even when no students have submitted anything. There should probably be a check somewhere that stops events displaying if the actioncount is 0.
97.summary: Assign override is created with wrong eventtype
description: If you create an assignment with a due date, then create a user override for the due date, the original event is created with eventtype set to due, but the override has it set to close. They should both be due. Possibly there are other similar issues caused by the recent rebase. Probably best to compare our dev branchs behaviour with masters behaviour.
98.summary: Add placeholder when the user has no upcoming events
description: Add placeholder images for the event event lists in both the sort by dates and sort by courses views in the timeline. See UX-31 for details.
99.summary: Create behat step to take the user to course page
description: At the moment, a lot of behat tests were using the course overview block to get to the course. Now, that we removed that block we have to create a behat step to get to the course without having to go to the site home page first. Also, all following combination of steps needs to rewritten: noformat And I am on site homepage And I follow "Course 1" noformat
100.summary: Disable the pagination bar if there is only one page
description: Currently the pagination shows as if it is active even if there is only 1 page. It should disabled.
101.summary: Show overdue events
description: We need to display any overdue events to the user at the top of the Timeline (when sorted by date). !s2 timeline courses overdue.png|thumbnail! There is a cost/benefit decision to be made here. Unfortunately, in order to fetch the events, we need to fetch a number of events, and then filter out any events which are no longer relevant. Whilst fetching from the database has a relatively low fixed cost, the filtration can be expensive and is dependant upon the individual module, and activity completion criterion. In addition, it is not feasible to cache which events are or are not completed for a user (because there are many factors which determine whether an activity can be complete and not all of these stem from specific actions). Generally speaking, we expect a majority of past events to have been completed. If we were to go back and fetch all overdue events, we would have to process all past events to determine whether they have been completed or not. Therefore we feel it is sensible to limit the time period to go back for to a shorter period of around 7-14 days. One of the features of the timeline is to highlight the critical information first. Going too far back in time has a decreasing benefit as it could be argued the activity is less likely to be completed the more overdue it is. Theres also little benefit to increasing the total limit of events to show (currently 20) for the same reason.
102.summary: The courses shown on the Courses tab should be the same size
description: See screenshot. Try with long course names and descriptions.
103.summary: Make room for blocks on the dashboard for XL (Bootstrap)
description: Currently (in the latest prototype) the blocks always go under in the centre region. There are worries that this may upset users as they have to scroll down to use blocks they would often use.
104.summary: Ensure all data in myoverview block can be fetched by a webservice
description: The mobile team will need webservices to fetch all the data we use in the templates for myoverview. Most of them should be done already, but we will need at least one to fetch the list of users courses with their progress information.
105.summary: Events should not show up on the my overview dashboard when they have been completed by the user
description: Once the user has completed the required action for the event (e.g. submitted an assignment or what ever) the action event should no longer appear on the dashboard. This will need to be worked out per module in the callbacks. . mod_assign Changing this to only show the events if there is no submission. Drafts, new, and re-opened submissions are still shown . mod_chat Visibility Chats before _today_ are _not_ visible Chats today_ or in the future _are_ visible Actionable Chats which are at some point today _are_ actionable Chats after today (from midnight on) _are not_ actionable
106.summary: Bailout callback should use $cm->uservisible, not $cm->visible
description: If you override the view capability for a module to prevent a user from viewing it it is possible for it to still be shown in the dashboard (but wont for the calendar). This is because the modinfo cache performs the call to is_user_access_restricted_by_capability() which checks if the capability mod/xyz:view is present in the module, and if so performs a has_capability check on it. The course module attribute uservisible contains this logic, where as visible doesnt.
107.summary: Undefined constant when running unit tests separately
description: When running vendor/bin/phpunit mod/forum/tests/lib_test.php you get undefined constant errors.
108.summary: Event vault not properly filtering results
description: The event vault isnt properly filtering out non action events for the get_action blah blah function.
109.summary: Fix CiBoT complaints on dev branch
description: Fix CiBoT complaints on dev branch
110.summary: Move calendar/classes/event.php to calendar/lib.php
description: This file contains legacy code that we want to deprecate in the future. We have already deprecated the class calendar_event and are now using \core_calendar\event but if we then deprecate \core_calendar\event devs are going to get annoyed that after a few releases they have had to keep changing their code. Moving the file also means this namespace is reserved for the proper events class.
111.summary: Move calendar/classes/api.php to calendar/lib.php
description: This file contains legacy code that we want to deprecate in the future. We have already deprecated the functions in calendar/lib.php and are now using \core_calendar\api but if we then deprecate the functions in \core_calendar\api in near future release devs are going to get annoyed that after a few releases they have had to keep changing their code. Moving this also means this namespace is reserved for the proper API class.
112.summary: Add more details to blocks/upgrade.txt
description: Add more details so people know they need to add this block before performing site upgrade.
113.summary: Rename calendar event API interfaces, removing the _interface suffix
description: We have a bunch of interfaces in a namespace that already contains the word "interface", so the _interface suffix is not really needed. Also rename the core_container to simply container
114.summary: Improve core_container based on integration feedback
description: The core_ prefix is confusing and doesnt really add any value. It would be better to rename it simple container. The container should be well documented as its the place where all the building blocks are composed together to achieve the functionality we need. Since the container acts as a quasi-DI container, as well as deciding on concrete implementations to use, factories that are used only in the container are redundant. From the most recent IR: "Without dependency injection or similar systems, factories must serve a purpose to be useful; event_factory & event_abstract_factory together or separated make sense. I dont see though how action_event_factory serve any purpose, it is exactly the same to hardcode action_event_factory in core_container than to hardcode new action_event, without a purpose nor an extension point they are 100 redundant. Getting rid of them would also kill action_event_factory_interface"
|
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 overhaul to improve course creation
description: This epic is part of the planned UX improvements for Moodle 4.0. Primary aim: to improve the user experience of creating and editing courses in Moodle. Primary target user: instructional designers, course creators and teachers. Status: currently in UX research & design, as well a technical feasibility assessment and specification. Prototype & Design| Prototype walkthrough Journey 1: View-mode Can show/hide sidebars Hover effect for course index>World cinema forum Hover effects for activity>glossary of character activity link + completion button + activity icon Fixed floating action button (FAB) footer (UX WIP) Journey 2: Edit-mode hover states Hover effect on course index>World cinema forum + drag&drop icon Hover effect on activity>glossary of character activity link + drag&drop icon + activity icon + Hover effect on activity>add activity or resources button Hover effect on activity>add sections below Show/hide blocks Hover effect on block>chapter + drag&drop icon Click on block>chapter>settings dropdown Journey 3: Edit section Click on section title>general>pencil to edit section name Click on section > general > edit section Click back on course index and display exit modal Journey 4: Activity (Glossary of character) Click on activity>Glossary of character Click on activity settings through 2^nd^ level nav Glossary of characters > hover add new entry Glossary of characters > click add new entry Click back on course index and display exit modal Prototype link: Design link:
| Unsolvable | 1.summary: Enable drag & drop from course index to course content and viceversa.
description: The new moodle 4.0 Course editor implements a course index that has drag&drop features. However, the content drag&drop and the course Index use incompatible JS modules and cannot communicate. This implementation will replace the current YUI drag and drop module in all formats compatible with the new UI components and the course state. Course formats that do not override "$format->supports_components" wont be able to use drag&drop in the course index and will continue using the YUI drag and drop module.
2.summary: Lock activities and sections when a course state mutation is ongoing
description: The UI components of the course should be locked while a mutation is affecting it. The user should not be able to manipulate an element while it is mutating. This will be implemented as a new "locked" attribute in the cm and section state. Components can watch this attribute to enable or disable the element actions.
3.summary: Cover state classes with direct unit tests
description: In , several state classes were added to cm_format, section_format and course_format. Their behaviour is currently covered by unit tests in core_course_get_state external method but Eloy mentioned that it would be better to have separate unit tests for them. So that issue is for adding them.
4.summary: Make section collapsable in the course index
description: As a user I want to be able to collapse and expand sections so I can focus on the section Im working on Users will be able to toggle sections to expand/collapse. The way to toggling will be an icon besides section title. Collapsing and expanding sections wont affect section status in the course main content. !image-2021-04-12-12-35-22-564.png! Prototype: No specific prototype for collapsing section, so linked to general prototype Check the video attached for the desired effect of expand-collapse as described in the screenshot above click on chevron : expand or collapse only click on title: goto + expand or collapse (optional) hover on the element : tooltip with expand or collapse Acceptance criteria: When the section is collapsed, no activity will be shown. When the section is expanded, all activities except those with no title into the section will be shown. The title of a section is a link to the section in the main content. Clicking/tapping in the section title doesn t expand/collapse the section. Beside the section title there is an icon to expand/collapse the section. Expanding and collapsing actions are available both via mouse and keyboard. By default all sections are collapsed except section 0.
5.summary: Keep the status of the course index collapsed and expanded sections per user and course
description: As a user I want to be able to keep the status of the collapsed and expanded sections so I can have a consistent view of the course every time Im back to it Sections status should be stored and used when the same user visits the course back. Prototype: No specific prototype for collapsing section, so linked to general prototype Acceptance criteria: Users can expand and collapse the sections in the course index. The status of sections will be the same if the user visits a different course and comes back to the current course. The status of sections will be the same if the user log outs and comes back to the current course in a different session. Only actions made actively by user will be kept. If a user expands or collapses a section using mouse or keyboard, that action and new section status should be kept. If a section is expanded because contains the current activity, but has not been expanded actively by user, that section status change shouldnt be kept.
6.summary: Implement section links behavior in course index
description: As a user I want to use the course index to collapse and expand sections and to navigate to them So I can handle the course index easily and navigate to course sections quickly . Acceptance criteria: Clicking on the chevron of a collapsed section, will expand the section in the course index. Clicking on the chevron of a expanded section, will colapse the section in the course index. Clicking on the title of a collapsed section, will expand the section in the course index and navigate to the section in the course main area: as an anchor for "Show all sections on one page" course layout; as a link to a new page for "Show one section per page" course layout. Clicking on the title of a expanded section, will keep the section expanded in the course index and navigate to the section in the course main area: as an anchor for "Show all sections on one page" course layout; as a link to a new page for "Show one section per page" course layout.
7.summary: Course index on activity view page
description: As a user I want to be able to see the whole structure of a course while working on an activity so I can get a better overview of the course. Course index will be available in activity view pages for all users in view mode. !image-2021-05-28-09-15-05-813.png! Prototype: Acceptance criteria: The course index is available for all users in all activity pages for all users. The section contains the current activity is expanded in the course index. If the section was collapsed in the course index when the user visits the activity, the section will be expanded while the user works with the activity, but will be collapsed when the user goes back to course page. If the section has not been expanded actively by the user, the status of that section is not saved as user preference. The activity is marked as active in the course index. The course index is always on view mode. Drag&drop options are not available for teachers in any of the activity pages.
8.summary: Create a new activity UI component
description: EDIT: replaced by Moodle 4 activity design spec: -As a course creator / editor- -I want to easily move activity, resources and sections within a course- -So I can quickly build & organise my course- - - -As a course viewer- -I want to easily access activity, resources and sections within a course- -So I can easily complete my course- . -color:4653b4Acceptance criteria:color- -color:172b4dWhen editing mode is turned oncolor- -When Editor hover the card, it changes the background color+stroke colours of the card as per design (also reveal drag & drop icon)- -Editor can drag & drop activities by doing a longpress anywhere on the activity card- -Editor can open a dropdown menu when clicking on the kebab menu- -Editor can go the activity itself by clicking anywhere on the card except, the kebab icon or drag & drop icon - -When editing mode is turned off- -Student can only access to the activity by clicking on- -activity name link or activity icon- -When student hover the card, nothing happens- -When student hover the activity link, it shows an underline- . -Out of scope:- . -Figma Designs:- - -- -View mode : No hover effect on card, just on the link- -!Activity-hover_viewMode.png|thumbnail!- -- -Edit mode : Hover on card- -!Activity-hover_editMode.png|thumbnail!- -Edit mode: drag & drop when long press (from anywhere in the card)- -!Activity-LongPress_editMode.png|thumbnail!- Edit mode: when hovering + clicking the more button (opens dropdown) !Activity-hoverDropdown_editMode.png|thumbnail!
9.summary: Add missing core renderers and clarify deprecation for legacy_format_renderer
description: In , the course/classes/output/course_format/legacy_renderer.php was added because, since Moodle 4.0, renderer.php file was optional (although highly recommended) for course formats but from Moodle 4.0 onwards renderer is required to support the new course editor implementation. This legacy class was created for backward compatibility, to avoid some errors with course formats (such as social) without this renderer.php file. This issue has been created to add missing core renderers (i.e. social) and to clarify the deprecation process for this legacy_format_renderer class.
10.summary: Improve course index accessibility following ARIA tree pattern guidelines
description: As discuss in , course index looks like an ARIA tree view, and so will be good to respect the navigation guidelines of one. Namely, we need to have arrow key expansion and navigation support, such as we do in the navigation block.
11.summary: Add highlighted label to course index
description: As a user I want to see the highlighted section in the course index So I can locate in the most important section of the course quickly . Acceptance criteria: If there is any highlighted section in the course, a highlighted label is shown beside the section title in the course index for Boost theme. The current week is marked with a current label in the course index for the Weeks format. The UI and design of the labels would be similar to the design added as screenshot, but this issue is not about styling them. Making the design exact to the prototype could be done in or any further issue. !image-2021-09-02-11-23-26-311.png!
12.summary: Add activity completion indicators to the course index
description: For Moodle 4.0 course index: To help learners track their progress and have an easy overview of which activities have been completed and which are still outstanding we will add activity completion indicators to the course index (the green or empty circles in front of the activity names as shown below). !Screen Shot 2021-09-23 at 5.20.01 pm.png|thumbnail! In the course index we want to reflect only 3 states of activity completion to reduce complexity. Below is the mapping of what the course index activity completion indicators should show for existing activity completion statuses. |New course index completion indicator|Corresponding activity completion report indicator |Meaning| |!image-2021-09-23-17-21-20-005.png|thumbnail!|! ! not complete.| |!image-2021-09-23-17-21-20-100.png|thumbnail!|! ! completed and no passing grade applies. For example: passing grade does not apply to this activity type, or passing grade has not been set as part of the activitys completion criteria.| |!image-2021-09-23-17-21-20-100.png|thumbnail!|! activity has passing grade which was achieved.| |!image-2021-09-23-17-21-20-184.png|thumbnail!|! not completed and completion not possible. For example: all quiz attempts have been used without achieving the passing grade.|
13.summary: New setting for enrolling admin as a teacher when adding a new course
description: Currently when an admin of a new Moodle site adds a new course, they cant easily find the course when they next log in. If they are automatically enrolled as a teacher in the new course via a new setting Auto-enrol admin in new courses, then they can easily find the course as it will then be shown in My courses. They can always choose later to unenrol themselves from the course. As an admin I want to decide if I am enrolled in every course I create so its one less thing for me to do when creating a course and also I can find the newly created course easily. Currently, based on "Creators role in new courses" setting (Site administration > Users > Permissions > User policies) course creators are enrolled by default in every course they create. But admins are never enrolled by default. This new setting allows admins to decide if they want to be automatically enrolled and assigned the creators role in new courses. Default value of this setting for new installations will be Yes (for admins to be enrolled). For existing Moodle sites default value of the setting will be No to keep the current behavior. Acceptance criteria: There is a new admin setting in Site administration > Users > Permissions > User policies called Auto-enrol admin in new courses with description When an admin adds a new course, should they be automatically enrolled and assigned the creators role in new courses? In a new Moodle installation the default value for the setting is Yes. When an existing Moodle site upgrades the default value of the setting is No. When the setting is Yes if an admin creates a new course, the admin will be enrolled in the course using the role selected in the "Creators role in new courses" setting. When the setting is No if an admin creates a new course, the admin wont be enrolled in the course.
14.summary: Create a new "move" option in the sections and activity cog menu in the course editor
description: With the new Moodle 4.0 course editor the "move activity" and "move section" will be part of the standard tools men . This new option will replace the current accessibility workaround of doing a simple click of the draggable move icon that appears to the left of the activity icon. _Designs_ !image-2021-06-10-06-58-23-473.png! !image-2021-06-10-08-25-24-717.png!
15.summary: Create editor, mutations AMD modules to suport the new course editor
description: Create the main AMD modules structure to support the new course editor for Moodle 4.0. The new architecture will be the base for implementing the new course editor, allowing teachers to edit the course from both course index or course content. It will consist of two main AMD modules: core_course/courseeditor: the main reactive object the rest of the editor components will interact with core_course/local/courseeditor/mutations: the main class to interact with the backend course edit Webservices However, those 2 modules will extend some new generic libraries to built basic reactive interfaces: core/reactive: a wrapper any plugin can import to create both state instances and UI components. core/local/reactive/reactive: the generic class to register single state reactive applications in vanilla JS core/local/reactive/statemanager: a basic state manager to track changes in the data structures core/local/reactive/basecomponent: a component class any UI component can extend to create new reactive components. Those new libraries will be incorporated into the core and could be used by any plugin. Those new components are based on the proof of concept developed here: Once finished, we could start implementing the new editor components that will replace the existing YUI and AMD modules used to edit the course. The following diagram summarizes the main editor elements and workflows: !Course creation project.jpg|thumbnail!
16.summary: The option to create a new topic in all of the existing topics on Topics format
description: As a teacher I want to be able to add a new section between 2 existing sections So I dont need to move the sections created at the end of the course to the right position This issue only applies to Topic format. . Acceptance criteria: Teachers could see a new Add topic below option at the end of each topic. The new topic will be added below the current topic. The changes wont be done client-side. That means the page needs to be reloaded to apply the changes. The new section added will be shown also in the course index. UX design: !addsectionbelow.png!
17.summary: Create core_course_get_state webservice
description: Create an ajax webservice to load the initial state of the current course. This is a web service needed for the new course editor of Moodle 4.0. The web service will get the course id as param and will return a structure containing all the needed information the UI components needs to operate. This will include: course: edition mode (bool) and section order (array of ids) (sample code| section: an array with all the sections data (sample code| cm: an array of the course-modules data (sample code| This information will conform the initial course state each component will receive and interact with. The state will only contain information that the user can see in the course (regardless its visibility). So, for instance, hidden sections wont be returned for students. A sample code of that web service can be checked at this proof of concept : More information about this approach with the general architecture and how this external method will be used can be found in the section "External Interface Requirements" of the course creation document|
18.summary: Create core_course_update_course webservice
description: Create an ajax webservice to be the course edition base for the new course editor in Moodle 4.0. This web service should be able to execute both core and format plugin edition functions and it will be invoked as a Ajax request by the new course UI components. The minimum arguments for this webservice are: action (string): to identify which update must be performed. This string is used to identify the method to call internally. courseid (int): the course where the action takes place. ids (array) an array of section or cm ids (depending on the action) (optional) targetsectionid(int): in case the action require a target section. For example "cm_moveto", "cm_copyto", "section_moveto" and "section_copyto" actions can require it. (optional) targetcmid(int): in case the action requires a target course-module. For example "cm_moveto", "cm_copyto", "section_moveto" and "section_copyto" can require it. This webservice will delegate any action to core_course\stateactions| class, or to format_xxx\course\stateactions if provided. Theres a sample implementation of this plugin here: The return structure of any action will a be a "stateupdates" object. A stateupdates is a list of changes that must be executed at a frontend level in order to keep the UI updated. A sample code of the stateupdates class can be found here: For now, phpunit test should fake a course format because no state actions will be provided yet. More information about this approach with the general architecture and how this external method will be used can be found in the section "External Interface Requirements" of the course creation document|
19.summary: Create core_courseformat subsystem
description: With the new course formats structrue (output components, templates, and modules and classes) a new core_courseformat subsystem appears to group all the functionalities related to course formats. The new subsystem will be located in the same "course/format" folder with the rest of the plugins. For now, the new sub system will have: All templates and output renderers to render the course content A replace for the base course_format class all format plugins must extend The base format_renderer and the specific site and legacy renderers. All the AMD modules for the reactive course interface The course index code and API The external services to serve the new course frontend All the course format plugins
20.summary: Create the new course index list. View mode with no edit options.
description: As a user I want to be able to see the whole structure of a course so I can manage it in a better way. Course index will be available in the course for all users. The main aim of the course index is to offer an easy way for learners to navigate through the course and activities, and for content editors to manage/edit sections and activities. !image-2021-03-31-20-23-13-653.png|width=240,height=569! In this issue we will implement a renderer method to display the course index. !image-2021-04-12-11-39-35-411.png|width=538,height=550! Designs: Note that the CI header is sticky (would be same with blocks header) as per the screenshot !image-2021-05-06-13-36-31-022.png! Also added a desktop screenshot for the in-situ view of the CI. !image-2021-05-06-13-36-24-410.png! Prototype: Desktop prototype: Mobile view-mode: Acceptance criteria: There is a course header with Course index" in the header. All the section titles (visible for the user) are listed and linked to section page. All the activity titles (visible for the user) are listed in in the proper section linked to activity view page. Only sections and activities that are visible for the user will be listed based on defined visibility, capabilities, access restrictions, etc. Course index will be loaded once the page is ready (lazy load)
21.summary: Implement drag and drop option for sections and activities in the course index
description: As a teacher I want to be able to move an existing activity or section to another position in the same course so I can order course content Designs: Note that the CI header is sticky (would be same with blocks header) as per the screenshot !EditCourse Page -- xl.png|thumbnail! Also added a desktop screenshot for the in-situ view of the CI. !CI Drag _ in-context.png|thumbnail! Acceptance criteria: When dragging an activity or section it will only be droppable in the course index, not in the course main area. The visibility of an activity could change when moving to a different section based on the visibility of the source and destination sections. Moving from visible to hidden section: Show on course page -> Available but not shown on course page Moving form hidden to visible section: Available but not shown on course page -> Show on course page. As per current behavior, no notification will be shown once the action has been completed. Technical tasks: New drag and drop component Add drag and drop to the course index
22.summary: Make sections collapsable for Topics and Weekly course formats.
description: As a student I want to collapse sections in the course main content area So I can focus on the most important section for me . Acceptance criteria: All users with access to the course will have the option to collapse/expand sections. All sections (section 0 included) could be collapsed. This new feature should work for both Topics and Weekly course formats. By default all sections are expanded. . Out of scope: Sections will be collapsable/expandable one by one. Adding an option to collapse/expand all sections is not part of this issue. Saving section collapsed/expanded status per user is not part of this issue. This improvement will help us to build the course index and synchronize section status with course main content area.
23.summary: Improve "move to" tool accessibility following ARIA tree pattern guidelines
description: In a new "move" option has been added to the current section and activities tool men . The new option replaces the previous YUI move modal and offers a much clear view of the element destination thanks to the similarity to the course index structure. However, as happens with the course index in , its missing an aria-tree implementation to make it more accessible. The code needed to add aria-tree logic to the move option is quite similar to the solution proposed should be applied as well.
24.summary: Make Add a new topic/week option client side on Topics and Weekly formats
description: As a teacher I want to be able to add a new sections without reloading the page So adding a new option is easier and quicker . Acceptance criteria (applies for both Topic and Weekly formats): Teachers could see a new Add topic below option at the end of each topic for Topic format. Teachers could see a new Add week below option at the end of the course for Weekly format. The new topic/week will be added below the current topic. The changes will be done client-side. That means the page doesnt need to be reloaded to apply the changes. The new section added will be shown also in the course index. As a teacher I want to be able to add a new section between 2 existing sections in a topics format So I dont need to move the sections created at the end of the course to the right position . Acceptance criteria: (only applies on Topic format) Teachers could see a new Add topic below option at the end of each topic. The new topic will be added below the current topic. The new section added will be shown also in the course index. (Waiting for the final design by UX)
25.summary: Show/hide course index option for view mode
description: As a user I want to be able to hide and show the course index so I can manage course index navigation options By default, the course index is always displayed on breakpoints lg !image-2021-03-30-12-07-42-055.png|width=421,height=334! !image-2021-03-30-12-08-30-810.png|width=312,height=323! Prototype: Acceptance criteria: Course index could be shown/hidden by the user. We store the last status of course index visibility per user (whatever the course is). That means if a user hides the course index in a course index will keep the same visibility as the last time a course was visited. Course index is available in view mode for all course main page, activity pages, edit activity pages, but not for course settings page and rest of course pages (such as Participants, Grades, Reports, Question Bank, etc.). Course index will be on the left side of the main course content for LTR languages, and on the right side for RTL languages. An icon will allow users to open/toggle/show the course index in view mode.
26.summary: Synchronize activity inline rename edition with course index
description: As a teacher I want to be able to inline rename an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Activity names are synchronized between Course index and course main content area. When an activity is renamed using inline rename option in the course main content area the name is also changed in the course index.
27.summary: Synchronize section inline rename edition with course index
description: As a teacher I want to be able to inline rename a section and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Section names are synchronized between Course index and course main content area. When a section is renamed using inline rename option in the course main content area the name is also changed in the course index.
28.summary: Make section Highlight/Remove highlight option compatible/synchronize with course index
description: As a teacher I want to be able to highlight and remove highlight sections and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: For Topic core format: Highlighted section is styled differently in the course index Highlighted section is synchronized between Course index and course main content area. When section is highlighted in the course main content area is also marked as highlighted in the course index. When highlight is removed for a section in the course main content area is not marked as highlighted in the course index anymore.
29.summary: Make section Hide/Show option compatible/synchronize with course index
description: As a teacher I want to be able to hide and show sections and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Hidden section is styled differently in the course index Section visibility is synchronized between Course index and course main content area. When a section is shown in the course main content area is also marked as visible in the course index. When a section is hidden in the course main content area is also marked as hidden in the course index.
30.summary: Make activity Hide/show option compatible/synchronize with course index
description: As a teacher I want to be able to hide and show activities and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Hidden activities are styled differently in the course index Activity visibility is synchronized between Course index and course main content area. When an activity is shown in the course main content area is also marked as visible in the course index. When an activity is hidden in the course main content area is also marked as hidden in the course index.
31.summary: Make activity duplication compatible/synchronize with course index
description: As a teacher I want to be able to duplicate an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: All activities whit title are shown in both course index and course main content area for view mode. Labels with no title are only shown in the course main content area for view mode. All activities are shown in both course index and course main content area for edit mode. 1), 2) and 3) acceptance criteria should be consistence when an activity is duplicated on the course main content area.
32.summary: Make activity deletion compatible/synchronize with course index
description: As a teacher I want to be able to delete an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: When an activity is deleted in the course main content area should be removed also from the course index.
33.summary: Make section Move to course edition option compatible/synchronize with course index
description: As a teacher I want to be able to move a section and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Changes on course main content area: Add a new Move to option to section Edit men . This new Move to option should behave in the same way as the current Move to option when user clicks on Move section x icon ( !image-2021-04-27-12-51-56-339.png! ): Opens a modal with a list of all course section to choose where to move the section. Remove the option Move to from the Move section x icon ( !image-2021-04-27-12-52-46-110.png! ). Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. There is a new Move to option in section Edit menu for all the sections except first Section 0. This option shows a modal where the user could choose where to move activities in the section (follow current behavior for Move to section option. When clicking on Move section x icon ( !image-2021-04-27-12-57-40-225.png! ) is not opening any modal. User could still drag and drop sections using Move section x icon ( !image-2021-04-27-12-58-08-247.png! ) When a section is moved to another position using the Move to option acceptance criteria 1) and 2) should be consistent.
34.summary: Make activity Move to course edition option compatible/synchronize with course index
description: !image-2021-04-27-13-06-56-021.png! s a teacher I want to be able to move an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Changes on course main content area: Add a new Move to option to activity Edit men . This new Move to option should behave in the same way as the current Move to option when user clicks on Move resource icon ( !image-2021-04-27-13-06-57-726.png! ): Opens a modal with a list of sections an positions to choose where to move the activity. Remove the option Move to from the Move resource icon ( !image-2021-04-27-13-06-58-872.png! ). Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. There is a new Move to option in activity Edit menu for all the activities. This option shows a modal where the user could choose where to move the activity (follow current behavior for Move to activity option. When clicking on Move resource icon ( !image-2021-04-27-13-07-00-348.png! ) is not opening any modal. User could still drag and drop activities using Move resource icon ( !image-2021-04-27-13-07-01-811.png! ) When an activity is moved to another position using the Move to option acceptance criteria 1) and 2) should be consistent.
35.summary: Make section drag&drop in course main content area compatible/synchronize with course index
description: As a teacher I want to be able to move a section using drag and drop and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. When a section is dragged in course main content area and moved to another position in course main area content acceptance criteria 1) and 2) should be consistent.
36.summary: Make activity drag&drop in course main content area compatible/synchronize with course index
description: As a teacher I want to be able to move an activity using drag and drop and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. When n activity is dragged in course main content area and moved to another position in course main area content acceptance criteria 1) and 2) should be consistent.
37.summary: Changes to add activity and add section design
description: As a course creator / editor I want to easily add new activities, resources and sections to a course So I can quickly build my course This issue is about UI changes for Add activity or resource and Add topics/weeks designs to improve the user experience and look&feel. . color:4653b4Acceptance criteria:color Only available when editing mode is turned on. Add activity or resource link should look as in the designs above. Add topics/weeks link should look as in the designs above. . Out of scope: This issue does not cover any changes to how the course description/summary works . Figma prototype: Designs: !Screenshot 2021-08-18 at 16.07.16.png|width=513,height=330!
38.summary: Expand all course index sections
description: As a user I want to be able to see the whole structure of a course in the course index so I can manage it in a better way. Acceptance criteria: All the section in the course index are listed and expanded first time a user goes into course. The activities are listed. Only sections and activities that are visible for the user will be listed based on defined visibility, capabilities, access restrictions, etc.
39.summary: Proceed straight to course content when creating a new course
description: As a course creator I want to be able to see the course content as soon as I create a new course so I can add new activities to the course. Drop the participant page step when creating a new course and jump straight to course content. Acceptance criteria: When creating a new course manually first settings page is shown, with a Save and display button. Saving the new course settings the user will land in the course content page.
40.summary: Move activity UI component to output classes and templates
description: Since all course templates must be moved to mustache+outpuc components. However, because the activity card will be implemented in this issue, most elements of the module rendering are still done by course renderer methods. Those are some of the methods that should be moved to output components course_section_cm_name ( and course_section_cm_name_title?) -> core_courseformat\output\local\content\cm\title course_section_cm_text -> core_courseformat\output\local\content\cm\innercontent course_section_cm_availability -> core_courseformat\output\local\content\cm\availability course_section_cm_edit_actions -> core_courseformat\output\local\content\cm\controlmenu And templates should be located in the equivalent location path in course/format/templates/local/content/section/cm !Renderers structure - courseformat subsystem.jpg|thumbnail!
41.summary: Add legacy indentation for third course format plugins
description: In 4.0 we have removed the indentation for Topics and Weekly formats. While the existing indentation options are powerful, it also creates the potential for overuse and creating a cluttered course appearance. This is not consistent with the 4.0 design approach of displaying activities in a card-like format. For Moodle 4.0 recommended approaches to bring some hierarchy in the course are by using sections and using some recommended strategies to streamline course pages| (this page will also be updated for 4.0). Further strategies to create different levels of hierarchy in a course will be explored for following releases. In the meantime, we are preserving the indentation options for 3rd party course formats, so that they can continue to utilise these as desired. In order to keep the indentation for third course format plugins, we should add a new public function in course/format/classes/base.php which would be easy to overwrite to set if our course format has an indentation or not. code:javapublic function uses_indentation() return false; code Also, to make life easier for community developers, this public function returns a true default value. This way, only community developers have to overwrite the function if they wont keep the indentation. So, topics and weekly formats will overwrite this function to set to false.
42.summary: Mark the current section in the course index.
description: In course formats with course index, the current section should be marked. The format should be the same as the activity name in the course index when the user is at an activity page (darker gray). About detecting the current section there are two scenarios: In multiple sections per page, the main region scroll should determine the active section. Something similar to what bootstrap scrollspy| does. In a single section per page, the selected section is the displayed one. If the user clicks on an element of the course index, it will be marked as the active element until the user move the content scroll This issue is also about the course index scroll position. There are several possibilities here: If the user is on an activity page: the course index scrolls to the activity item. This way the next and previous activities are visible without scrolling. If the user is in the course page depends: In view mode: the course index scrolls to the current position so the content scroll position changes also the course index scroll and the current element is always visible. In edit mode: in edit mode the course index is important to drag and drop items from one section to another (even if they are several sections away from one another). For this reason, in edit mode, scrolling the content wont affect the course index.
43.summary: Change the hidden activity links behaviour in the course index
description: In the course index, if an activity is hidden it can be displayed in two ways: If the user has access to the activity (teachers mainly) it is a link to the activity If the user does not have access, it is a regular span element that is not clickable The 1st Case works is as expected. However, the new course index design requires the 2nd case to behave differently: If the user does not have access to the activity but the activity is displayed on the course page, the element should be a link to scroll to that specific element location. Especially if it has availability conditions. If the user does not have access to the activity but the activity is NOT displayed on the course page (in one section per page, for example), then it can remain as a non-clickable element.
44.summary: Refactor course index and course content preference names
description: In the current version, the course state uses the following variables to indicate the section collapsed/expanded values: bool contentexpanded: indicate the section is expanded in the course content bool isactive: indicate the section is expanded in the course index Those variables are used in the mustache files to decide if the section is expanded or collapsed. However, when a section is collapsed or expanded, the course preferences saved are: bool contentcollapsed: if the section is collapsed in the content bool indexcollapsed: if the section is collapsed in the course index This way of saving the preference is convenient because sections are expanded by default and the result JSON is smaller. The main problem is that the code for converting preferences to state can be confusing because they are antagonistic. Apart, "isactive" does not help to understand that affects only the course index (in the beginning only the course index was expandable). The code should be refactored to unify criteria: State and mustache files should work with "contentcollapsed" and "indexcollapsed" instead of "contentexpanded" and "isactive". Section preferences should not be modified as they are optimal this way and the names are clearer.
45.summary: Course index should be opened by default first time a user access the course
description: This is what was decided together with UX team: On a large screen (desktop), the course index will be EXPANDED by default, so it will be expanded the first time the users access a course On large screens, the drawer state will be saved in the user preferences, so if the user collapses it, it should remain collapsed In small screens, the course index is always collapsed by default even if the user expands it and reloads the page, despite the user preference In small screens, the state of the drawer is not saved in the user preference
46.summary: New quick access to create a new course from My courses page when there is no course available
description: Sites with no courses dont show a link to create new ones. This makes much harder for new teacher/admin users to complete their most basic flow, which is to create a new course. There s a high risk of them pivoting to other solutions if they are not able to create a course when using Moodle for the first time. Mockup (outdated see below): !image-2021-12-10-13-38-28-593.png! . Acceptance criteria: For users with capability to create courses as site level on My courses page: There is a link to "Create a new course" if there is no course to show in the main page. There is no link to "Create a new course" if there is at least one course to show. Wether there is any course to show or not, there is a New course link to create a course on the kebab menu . Update The "My courses" page content is actually the same as the block "Course overview". The follow image illustrate a more realistic version of the mockup above (its based on the current QA site state): !Screenshot 2021-12-14 at 10.14.02.png|width=625,height=404!
| 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 overhaul to improve course creation
description: This epic is part of the planned UX improvements for Moodle 4.0. Primary aim: to improve the user experience of creating and editing courses in Moodle. Primary target user: instructional designers, course creators and teachers. Status: currently in UX research & design, as well a technical feasibility assessment and specification. Prototype & Design| Prototype walkthrough Journey 1: View-mode Can show/hide sidebars Hover effect for course index>World cinema forum Hover effects for activity>glossary of character activity link + completion button + activity icon Fixed floating action button (FAB) footer (UX WIP) Journey 2: Edit-mode hover states Hover effect on course index>World cinema forum + drag&drop icon Hover effect on activity>glossary of character activity link + drag&drop icon + activity icon + Hover effect on activity>add activity or resources button Hover effect on activity>add sections below Show/hide blocks Hover effect on block>chapter + drag&drop icon Click on block>chapter>settings dropdown Journey 3: Edit section Click on section title>general>pencil to edit section name Click on section > general > edit section Click back on course index and display exit modal Journey 4: Activity (Glossary of character) Click on activity>Glossary of character Click on activity settings through 2^nd^ level nav Glossary of characters > hover add new entry Glossary of characters > click add new entry Click back on course index and display exit modal Prototype link: Design link:
### Response:
1.summary: Enable drag & drop from course index to course content and viceversa.
description: The new moodle 4.0 Course editor implements a course index that has drag&drop features. However, the content drag&drop and the course Index use incompatible JS modules and cannot communicate. This implementation will replace the current YUI drag and drop module in all formats compatible with the new UI components and the course state. Course formats that do not override "$format->supports_components" wont be able to use drag&drop in the course index and will continue using the YUI drag and drop module.
2.summary: Lock activities and sections when a course state mutation is ongoing
description: The UI components of the course should be locked while a mutation is affecting it. The user should not be able to manipulate an element while it is mutating. This will be implemented as a new "locked" attribute in the cm and section state. Components can watch this attribute to enable or disable the element actions.
3.summary: Cover state classes with direct unit tests
description: In , several state classes were added to cm_format, section_format and course_format. Their behaviour is currently covered by unit tests in core_course_get_state external method but Eloy mentioned that it would be better to have separate unit tests for them. So that issue is for adding them.
4.summary: Make section collapsable in the course index
description: As a user I want to be able to collapse and expand sections so I can focus on the section Im working on Users will be able to toggle sections to expand/collapse. The way to toggling will be an icon besides section title. Collapsing and expanding sections wont affect section status in the course main content. !image-2021-04-12-12-35-22-564.png! Prototype: No specific prototype for collapsing section, so linked to general prototype Check the video attached for the desired effect of expand-collapse as described in the screenshot above click on chevron : expand or collapse only click on title: goto + expand or collapse (optional) hover on the element : tooltip with expand or collapse Acceptance criteria: When the section is collapsed, no activity will be shown. When the section is expanded, all activities except those with no title into the section will be shown. The title of a section is a link to the section in the main content. Clicking/tapping in the section title doesn t expand/collapse the section. Beside the section title there is an icon to expand/collapse the section. Expanding and collapsing actions are available both via mouse and keyboard. By default all sections are collapsed except section 0.
5.summary: Keep the status of the course index collapsed and expanded sections per user and course
description: As a user I want to be able to keep the status of the collapsed and expanded sections so I can have a consistent view of the course every time Im back to it Sections status should be stored and used when the same user visits the course back. Prototype: No specific prototype for collapsing section, so linked to general prototype Acceptance criteria: Users can expand and collapse the sections in the course index. The status of sections will be the same if the user visits a different course and comes back to the current course. The status of sections will be the same if the user log outs and comes back to the current course in a different session. Only actions made actively by user will be kept. If a user expands or collapses a section using mouse or keyboard, that action and new section status should be kept. If a section is expanded because contains the current activity, but has not been expanded actively by user, that section status change shouldnt be kept.
6.summary: Implement section links behavior in course index
description: As a user I want to use the course index to collapse and expand sections and to navigate to them So I can handle the course index easily and navigate to course sections quickly . Acceptance criteria: Clicking on the chevron of a collapsed section, will expand the section in the course index. Clicking on the chevron of a expanded section, will colapse the section in the course index. Clicking on the title of a collapsed section, will expand the section in the course index and navigate to the section in the course main area: as an anchor for "Show all sections on one page" course layout; as a link to a new page for "Show one section per page" course layout. Clicking on the title of a expanded section, will keep the section expanded in the course index and navigate to the section in the course main area: as an anchor for "Show all sections on one page" course layout; as a link to a new page for "Show one section per page" course layout.
7.summary: Course index on activity view page
description: As a user I want to be able to see the whole structure of a course while working on an activity so I can get a better overview of the course. Course index will be available in activity view pages for all users in view mode. !image-2021-05-28-09-15-05-813.png! Prototype: Acceptance criteria: The course index is available for all users in all activity pages for all users. The section contains the current activity is expanded in the course index. If the section was collapsed in the course index when the user visits the activity, the section will be expanded while the user works with the activity, but will be collapsed when the user goes back to course page. If the section has not been expanded actively by the user, the status of that section is not saved as user preference. The activity is marked as active in the course index. The course index is always on view mode. Drag&drop options are not available for teachers in any of the activity pages.
8.summary: Create a new activity UI component
description: EDIT: replaced by Moodle 4 activity design spec: -As a course creator / editor- -I want to easily move activity, resources and sections within a course- -So I can quickly build & organise my course- - - -As a course viewer- -I want to easily access activity, resources and sections within a course- -So I can easily complete my course- . -color:4653b4Acceptance criteria:color- -color:172b4dWhen editing mode is turned oncolor- -When Editor hover the card, it changes the background color+stroke colours of the card as per design (also reveal drag & drop icon)- -Editor can drag & drop activities by doing a longpress anywhere on the activity card- -Editor can open a dropdown menu when clicking on the kebab menu- -Editor can go the activity itself by clicking anywhere on the card except, the kebab icon or drag & drop icon - -When editing mode is turned off- -Student can only access to the activity by clicking on- -activity name link or activity icon- -When student hover the card, nothing happens- -When student hover the activity link, it shows an underline- . -Out of scope:- . -Figma Designs:- - -- -View mode : No hover effect on card, just on the link- -!Activity-hover_viewMode.png|thumbnail!- -- -Edit mode : Hover on card- -!Activity-hover_editMode.png|thumbnail!- -Edit mode: drag & drop when long press (from anywhere in the card)- -!Activity-LongPress_editMode.png|thumbnail!- Edit mode: when hovering + clicking the more button (opens dropdown) !Activity-hoverDropdown_editMode.png|thumbnail!
9.summary: Add missing core renderers and clarify deprecation for legacy_format_renderer
description: In , the course/classes/output/course_format/legacy_renderer.php was added because, since Moodle 4.0, renderer.php file was optional (although highly recommended) for course formats but from Moodle 4.0 onwards renderer is required to support the new course editor implementation. This legacy class was created for backward compatibility, to avoid some errors with course formats (such as social) without this renderer.php file. This issue has been created to add missing core renderers (i.e. social) and to clarify the deprecation process for this legacy_format_renderer class.
10.summary: Improve course index accessibility following ARIA tree pattern guidelines
description: As discuss in , course index looks like an ARIA tree view, and so will be good to respect the navigation guidelines of one. Namely, we need to have arrow key expansion and navigation support, such as we do in the navigation block.
11.summary: Add highlighted label to course index
description: As a user I want to see the highlighted section in the course index So I can locate in the most important section of the course quickly . Acceptance criteria: If there is any highlighted section in the course, a highlighted label is shown beside the section title in the course index for Boost theme. The current week is marked with a current label in the course index for the Weeks format. The UI and design of the labels would be similar to the design added as screenshot, but this issue is not about styling them. Making the design exact to the prototype could be done in or any further issue. !image-2021-09-02-11-23-26-311.png!
12.summary: Add activity completion indicators to the course index
description: For Moodle 4.0 course index: To help learners track their progress and have an easy overview of which activities have been completed and which are still outstanding we will add activity completion indicators to the course index (the green or empty circles in front of the activity names as shown below). !Screen Shot 2021-09-23 at 5.20.01 pm.png|thumbnail! In the course index we want to reflect only 3 states of activity completion to reduce complexity. Below is the mapping of what the course index activity completion indicators should show for existing activity completion statuses. |New course index completion indicator|Corresponding activity completion report indicator |Meaning| |!image-2021-09-23-17-21-20-005.png|thumbnail!|! ! not complete.| |!image-2021-09-23-17-21-20-100.png|thumbnail!|! ! completed and no passing grade applies. For example: passing grade does not apply to this activity type, or passing grade has not been set as part of the activitys completion criteria.| |!image-2021-09-23-17-21-20-100.png|thumbnail!|! activity has passing grade which was achieved.| |!image-2021-09-23-17-21-20-184.png|thumbnail!|! not completed and completion not possible. For example: all quiz attempts have been used without achieving the passing grade.|
13.summary: New setting for enrolling admin as a teacher when adding a new course
description: Currently when an admin of a new Moodle site adds a new course, they cant easily find the course when they next log in. If they are automatically enrolled as a teacher in the new course via a new setting Auto-enrol admin in new courses, then they can easily find the course as it will then be shown in My courses. They can always choose later to unenrol themselves from the course. As an admin I want to decide if I am enrolled in every course I create so its one less thing for me to do when creating a course and also I can find the newly created course easily. Currently, based on "Creators role in new courses" setting (Site administration > Users > Permissions > User policies) course creators are enrolled by default in every course they create. But admins are never enrolled by default. This new setting allows admins to decide if they want to be automatically enrolled and assigned the creators role in new courses. Default value of this setting for new installations will be Yes (for admins to be enrolled). For existing Moodle sites default value of the setting will be No to keep the current behavior. Acceptance criteria: There is a new admin setting in Site administration > Users > Permissions > User policies called Auto-enrol admin in new courses with description When an admin adds a new course, should they be automatically enrolled and assigned the creators role in new courses? In a new Moodle installation the default value for the setting is Yes. When an existing Moodle site upgrades the default value of the setting is No. When the setting is Yes if an admin creates a new course, the admin will be enrolled in the course using the role selected in the "Creators role in new courses" setting. When the setting is No if an admin creates a new course, the admin wont be enrolled in the course.
14.summary: Create a new "move" option in the sections and activity cog menu in the course editor
description: With the new Moodle 4.0 course editor the "move activity" and "move section" will be part of the standard tools men . This new option will replace the current accessibility workaround of doing a simple click of the draggable move icon that appears to the left of the activity icon. _Designs_ !image-2021-06-10-06-58-23-473.png! !image-2021-06-10-08-25-24-717.png!
15.summary: Create editor, mutations AMD modules to suport the new course editor
description: Create the main AMD modules structure to support the new course editor for Moodle 4.0. The new architecture will be the base for implementing the new course editor, allowing teachers to edit the course from both course index or course content. It will consist of two main AMD modules: core_course/courseeditor: the main reactive object the rest of the editor components will interact with core_course/local/courseeditor/mutations: the main class to interact with the backend course edit Webservices However, those 2 modules will extend some new generic libraries to built basic reactive interfaces: core/reactive: a wrapper any plugin can import to create both state instances and UI components. core/local/reactive/reactive: the generic class to register single state reactive applications in vanilla JS core/local/reactive/statemanager: a basic state manager to track changes in the data structures core/local/reactive/basecomponent: a component class any UI component can extend to create new reactive components. Those new libraries will be incorporated into the core and could be used by any plugin. Those new components are based on the proof of concept developed here: Once finished, we could start implementing the new editor components that will replace the existing YUI and AMD modules used to edit the course. The following diagram summarizes the main editor elements and workflows: !Course creation project.jpg|thumbnail!
16.summary: The option to create a new topic in all of the existing topics on Topics format
description: As a teacher I want to be able to add a new section between 2 existing sections So I dont need to move the sections created at the end of the course to the right position This issue only applies to Topic format. . Acceptance criteria: Teachers could see a new Add topic below option at the end of each topic. The new topic will be added below the current topic. The changes wont be done client-side. That means the page needs to be reloaded to apply the changes. The new section added will be shown also in the course index. UX design: !addsectionbelow.png!
17.summary: Create core_course_get_state webservice
description: Create an ajax webservice to load the initial state of the current course. This is a web service needed for the new course editor of Moodle 4.0. The web service will get the course id as param and will return a structure containing all the needed information the UI components needs to operate. This will include: course: edition mode (bool) and section order (array of ids) (sample code| section: an array with all the sections data (sample code| cm: an array of the course-modules data (sample code| This information will conform the initial course state each component will receive and interact with. The state will only contain information that the user can see in the course (regardless its visibility). So, for instance, hidden sections wont be returned for students. A sample code of that web service can be checked at this proof of concept : More information about this approach with the general architecture and how this external method will be used can be found in the section "External Interface Requirements" of the course creation document|
18.summary: Create core_course_update_course webservice
description: Create an ajax webservice to be the course edition base for the new course editor in Moodle 4.0. This web service should be able to execute both core and format plugin edition functions and it will be invoked as a Ajax request by the new course UI components. The minimum arguments for this webservice are: action (string): to identify which update must be performed. This string is used to identify the method to call internally. courseid (int): the course where the action takes place. ids (array) an array of section or cm ids (depending on the action) (optional) targetsectionid(int): in case the action require a target section. For example "cm_moveto", "cm_copyto", "section_moveto" and "section_copyto" actions can require it. (optional) targetcmid(int): in case the action requires a target course-module. For example "cm_moveto", "cm_copyto", "section_moveto" and "section_copyto" can require it. This webservice will delegate any action to core_course\stateactions| class, or to format_xxx\course\stateactions if provided. Theres a sample implementation of this plugin here: The return structure of any action will a be a "stateupdates" object. A stateupdates is a list of changes that must be executed at a frontend level in order to keep the UI updated. A sample code of the stateupdates class can be found here: For now, phpunit test should fake a course format because no state actions will be provided yet. More information about this approach with the general architecture and how this external method will be used can be found in the section "External Interface Requirements" of the course creation document|
19.summary: Create core_courseformat subsystem
description: With the new course formats structrue (output components, templates, and modules and classes) a new core_courseformat subsystem appears to group all the functionalities related to course formats. The new subsystem will be located in the same "course/format" folder with the rest of the plugins. For now, the new sub system will have: All templates and output renderers to render the course content A replace for the base course_format class all format plugins must extend The base format_renderer and the specific site and legacy renderers. All the AMD modules for the reactive course interface The course index code and API The external services to serve the new course frontend All the course format plugins
20.summary: Create the new course index list. View mode with no edit options.
description: As a user I want to be able to see the whole structure of a course so I can manage it in a better way. Course index will be available in the course for all users. The main aim of the course index is to offer an easy way for learners to navigate through the course and activities, and for content editors to manage/edit sections and activities. !image-2021-03-31-20-23-13-653.png|width=240,height=569! In this issue we will implement a renderer method to display the course index. !image-2021-04-12-11-39-35-411.png|width=538,height=550! Designs: Note that the CI header is sticky (would be same with blocks header) as per the screenshot !image-2021-05-06-13-36-31-022.png! Also added a desktop screenshot for the in-situ view of the CI. !image-2021-05-06-13-36-24-410.png! Prototype: Desktop prototype: Mobile view-mode: Acceptance criteria: There is a course header with Course index" in the header. All the section titles (visible for the user) are listed and linked to section page. All the activity titles (visible for the user) are listed in in the proper section linked to activity view page. Only sections and activities that are visible for the user will be listed based on defined visibility, capabilities, access restrictions, etc. Course index will be loaded once the page is ready (lazy load)
21.summary: Implement drag and drop option for sections and activities in the course index
description: As a teacher I want to be able to move an existing activity or section to another position in the same course so I can order course content Designs: Note that the CI header is sticky (would be same with blocks header) as per the screenshot !EditCourse Page -- xl.png|thumbnail! Also added a desktop screenshot for the in-situ view of the CI. !CI Drag _ in-context.png|thumbnail! Acceptance criteria: When dragging an activity or section it will only be droppable in the course index, not in the course main area. The visibility of an activity could change when moving to a different section based on the visibility of the source and destination sections. Moving from visible to hidden section: Show on course page -> Available but not shown on course page Moving form hidden to visible section: Available but not shown on course page -> Show on course page. As per current behavior, no notification will be shown once the action has been completed. Technical tasks: New drag and drop component Add drag and drop to the course index
22.summary: Make sections collapsable for Topics and Weekly course formats.
description: As a student I want to collapse sections in the course main content area So I can focus on the most important section for me . Acceptance criteria: All users with access to the course will have the option to collapse/expand sections. All sections (section 0 included) could be collapsed. This new feature should work for both Topics and Weekly course formats. By default all sections are expanded. . Out of scope: Sections will be collapsable/expandable one by one. Adding an option to collapse/expand all sections is not part of this issue. Saving section collapsed/expanded status per user is not part of this issue. This improvement will help us to build the course index and synchronize section status with course main content area.
23.summary: Improve "move to" tool accessibility following ARIA tree pattern guidelines
description: In a new "move" option has been added to the current section and activities tool men . The new option replaces the previous YUI move modal and offers a much clear view of the element destination thanks to the similarity to the course index structure. However, as happens with the course index in , its missing an aria-tree implementation to make it more accessible. The code needed to add aria-tree logic to the move option is quite similar to the solution proposed should be applied as well.
24.summary: Make Add a new topic/week option client side on Topics and Weekly formats
description: As a teacher I want to be able to add a new sections without reloading the page So adding a new option is easier and quicker . Acceptance criteria (applies for both Topic and Weekly formats): Teachers could see a new Add topic below option at the end of each topic for Topic format. Teachers could see a new Add week below option at the end of the course for Weekly format. The new topic/week will be added below the current topic. The changes will be done client-side. That means the page doesnt need to be reloaded to apply the changes. The new section added will be shown also in the course index. As a teacher I want to be able to add a new section between 2 existing sections in a topics format So I dont need to move the sections created at the end of the course to the right position . Acceptance criteria: (only applies on Topic format) Teachers could see a new Add topic below option at the end of each topic. The new topic will be added below the current topic. The new section added will be shown also in the course index. (Waiting for the final design by UX)
25.summary: Show/hide course index option for view mode
description: As a user I want to be able to hide and show the course index so I can manage course index navigation options By default, the course index is always displayed on breakpoints lg !image-2021-03-30-12-07-42-055.png|width=421,height=334! !image-2021-03-30-12-08-30-810.png|width=312,height=323! Prototype: Acceptance criteria: Course index could be shown/hidden by the user. We store the last status of course index visibility per user (whatever the course is). That means if a user hides the course index in a course index will keep the same visibility as the last time a course was visited. Course index is available in view mode for all course main page, activity pages, edit activity pages, but not for course settings page and rest of course pages (such as Participants, Grades, Reports, Question Bank, etc.). Course index will be on the left side of the main course content for LTR languages, and on the right side for RTL languages. An icon will allow users to open/toggle/show the course index in view mode.
26.summary: Synchronize activity inline rename edition with course index
description: As a teacher I want to be able to inline rename an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Activity names are synchronized between Course index and course main content area. When an activity is renamed using inline rename option in the course main content area the name is also changed in the course index.
27.summary: Synchronize section inline rename edition with course index
description: As a teacher I want to be able to inline rename a section and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Section names are synchronized between Course index and course main content area. When a section is renamed using inline rename option in the course main content area the name is also changed in the course index.
28.summary: Make section Highlight/Remove highlight option compatible/synchronize with course index
description: As a teacher I want to be able to highlight and remove highlight sections and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: For Topic core format: Highlighted section is styled differently in the course index Highlighted section is synchronized between Course index and course main content area. When section is highlighted in the course main content area is also marked as highlighted in the course index. When highlight is removed for a section in the course main content area is not marked as highlighted in the course index anymore.
29.summary: Make section Hide/Show option compatible/synchronize with course index
description: As a teacher I want to be able to hide and show sections and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Hidden section is styled differently in the course index Section visibility is synchronized between Course index and course main content area. When a section is shown in the course main content area is also marked as visible in the course index. When a section is hidden in the course main content area is also marked as hidden in the course index.
30.summary: Make activity Hide/show option compatible/synchronize with course index
description: As a teacher I want to be able to hide and show activities and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: Hidden activities are styled differently in the course index Activity visibility is synchronized between Course index and course main content area. When an activity is shown in the course main content area is also marked as visible in the course index. When an activity is hidden in the course main content area is also marked as hidden in the course index.
31.summary: Make activity duplication compatible/synchronize with course index
description: As a teacher I want to be able to duplicate an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: All activities whit title are shown in both course index and course main content area for view mode. Labels with no title are only shown in the course main content area for view mode. All activities are shown in both course index and course main content area for edit mode. 1), 2) and 3) acceptance criteria should be consistence when an activity is duplicated on the course main content area.
32.summary: Make activity deletion compatible/synchronize with course index
description: As a teacher I want to be able to delete an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: When an activity is deleted in the course main content area should be removed also from the course index.
33.summary: Make section Move to course edition option compatible/synchronize with course index
description: As a teacher I want to be able to move a section and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Changes on course main content area: Add a new Move to option to section Edit men . This new Move to option should behave in the same way as the current Move to option when user clicks on Move section x icon ( !image-2021-04-27-12-51-56-339.png! ): Opens a modal with a list of all course section to choose where to move the section. Remove the option Move to from the Move section x icon ( !image-2021-04-27-12-52-46-110.png! ). Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. There is a new Move to option in section Edit menu for all the sections except first Section 0. This option shows a modal where the user could choose where to move activities in the section (follow current behavior for Move to section option. When clicking on Move section x icon ( !image-2021-04-27-12-57-40-225.png! ) is not opening any modal. User could still drag and drop sections using Move section x icon ( !image-2021-04-27-12-58-08-247.png! ) When a section is moved to another position using the Move to option acceptance criteria 1) and 2) should be consistent.
34.summary: Make activity Move to course edition option compatible/synchronize with course index
description: !image-2021-04-27-13-06-56-021.png! s a teacher I want to be able to move an activity and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Changes on course main content area: Add a new Move to option to activity Edit men . This new Move to option should behave in the same way as the current Move to option when user clicks on Move resource icon ( !image-2021-04-27-13-06-57-726.png! ): Opens a modal with a list of sections an positions to choose where to move the activity. Remove the option Move to from the Move resource icon ( !image-2021-04-27-13-06-58-872.png! ). Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. There is a new Move to option in activity Edit menu for all the activities. This option shows a modal where the user could choose where to move the activity (follow current behavior for Move to activity option. When clicking on Move resource icon ( !image-2021-04-27-13-07-00-348.png! ) is not opening any modal. User could still drag and drop activities using Move resource icon ( !image-2021-04-27-13-07-01-811.png! ) When an activity is moved to another position using the Move to option acceptance criteria 1) and 2) should be consistent.
35.summary: Make section drag&drop in course main content area compatible/synchronize with course index
description: As a teacher I want to be able to move a section using drag and drop and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. When a section is dragged in course main content area and moved to another position in course main area content acceptance criteria 1) and 2) should be consistent.
36.summary: Make activity drag&drop in course main content area compatible/synchronize with course index
description: As a teacher I want to be able to move an activity using drag and drop and see the change applied in the course index so I dont need to reload the page to confirm the changes were properly applied. Acceptance criteria: The order of the sections is synchronized between Course index and course main content area. The order of the activities in each section is synchronized between Course index and course main content area. When n activity is dragged in course main content area and moved to another position in course main area content acceptance criteria 1) and 2) should be consistent.
37.summary: Changes to add activity and add section design
description: As a course creator / editor I want to easily add new activities, resources and sections to a course So I can quickly build my course This issue is about UI changes for Add activity or resource and Add topics/weeks designs to improve the user experience and look&feel. . color:4653b4Acceptance criteria:color Only available when editing mode is turned on. Add activity or resource link should look as in the designs above. Add topics/weeks link should look as in the designs above. . Out of scope: This issue does not cover any changes to how the course description/summary works . Figma prototype: Designs: !Screenshot 2021-08-18 at 16.07.16.png|width=513,height=330!
38.summary: Expand all course index sections
description: As a user I want to be able to see the whole structure of a course in the course index so I can manage it in a better way. Acceptance criteria: All the section in the course index are listed and expanded first time a user goes into course. The activities are listed. Only sections and activities that are visible for the user will be listed based on defined visibility, capabilities, access restrictions, etc.
39.summary: Proceed straight to course content when creating a new course
description: As a course creator I want to be able to see the course content as soon as I create a new course so I can add new activities to the course. Drop the participant page step when creating a new course and jump straight to course content. Acceptance criteria: When creating a new course manually first settings page is shown, with a Save and display button. Saving the new course settings the user will land in the course content page.
40.summary: Move activity UI component to output classes and templates
description: Since all course templates must be moved to mustache+outpuc components. However, because the activity card will be implemented in this issue, most elements of the module rendering are still done by course renderer methods. Those are some of the methods that should be moved to output components course_section_cm_name ( and course_section_cm_name_title?) -> core_courseformat\output\local\content\cm\title course_section_cm_text -> core_courseformat\output\local\content\cm\innercontent course_section_cm_availability -> core_courseformat\output\local\content\cm\availability course_section_cm_edit_actions -> core_courseformat\output\local\content\cm\controlmenu And templates should be located in the equivalent location path in course/format/templates/local/content/section/cm !Renderers structure - courseformat subsystem.jpg|thumbnail!
41.summary: Add legacy indentation for third course format plugins
description: In 4.0 we have removed the indentation for Topics and Weekly formats. While the existing indentation options are powerful, it also creates the potential for overuse and creating a cluttered course appearance. This is not consistent with the 4.0 design approach of displaying activities in a card-like format. For Moodle 4.0 recommended approaches to bring some hierarchy in the course are by using sections and using some recommended strategies to streamline course pages| (this page will also be updated for 4.0). Further strategies to create different levels of hierarchy in a course will be explored for following releases. In the meantime, we are preserving the indentation options for 3rd party course formats, so that they can continue to utilise these as desired. In order to keep the indentation for third course format plugins, we should add a new public function in course/format/classes/base.php which would be easy to overwrite to set if our course format has an indentation or not. code:javapublic function uses_indentation() return false; code Also, to make life easier for community developers, this public function returns a true default value. This way, only community developers have to overwrite the function if they wont keep the indentation. So, topics and weekly formats will overwrite this function to set to false.
42.summary: Mark the current section in the course index.
description: In course formats with course index, the current section should be marked. The format should be the same as the activity name in the course index when the user is at an activity page (darker gray). About detecting the current section there are two scenarios: In multiple sections per page, the main region scroll should determine the active section. Something similar to what bootstrap scrollspy| does. In a single section per page, the selected section is the displayed one. If the user clicks on an element of the course index, it will be marked as the active element until the user move the content scroll This issue is also about the course index scroll position. There are several possibilities here: If the user is on an activity page: the course index scrolls to the activity item. This way the next and previous activities are visible without scrolling. If the user is in the course page depends: In view mode: the course index scrolls to the current position so the content scroll position changes also the course index scroll and the current element is always visible. In edit mode: in edit mode the course index is important to drag and drop items from one section to another (even if they are several sections away from one another). For this reason, in edit mode, scrolling the content wont affect the course index.
43.summary: Change the hidden activity links behaviour in the course index
description: In the course index, if an activity is hidden it can be displayed in two ways: If the user has access to the activity (teachers mainly) it is a link to the activity If the user does not have access, it is a regular span element that is not clickable The 1st Case works is as expected. However, the new course index design requires the 2nd case to behave differently: If the user does not have access to the activity but the activity is displayed on the course page, the element should be a link to scroll to that specific element location. Especially if it has availability conditions. If the user does not have access to the activity but the activity is NOT displayed on the course page (in one section per page, for example), then it can remain as a non-clickable element.
44.summary: Refactor course index and course content preference names
description: In the current version, the course state uses the following variables to indicate the section collapsed/expanded values: bool contentexpanded: indicate the section is expanded in the course content bool isactive: indicate the section is expanded in the course index Those variables are used in the mustache files to decide if the section is expanded or collapsed. However, when a section is collapsed or expanded, the course preferences saved are: bool contentcollapsed: if the section is collapsed in the content bool indexcollapsed: if the section is collapsed in the course index This way of saving the preference is convenient because sections are expanded by default and the result JSON is smaller. The main problem is that the code for converting preferences to state can be confusing because they are antagonistic. Apart, "isactive" does not help to understand that affects only the course index (in the beginning only the course index was expandable). The code should be refactored to unify criteria: State and mustache files should work with "contentcollapsed" and "indexcollapsed" instead of "contentexpanded" and "isactive". Section preferences should not be modified as they are optimal this way and the names are clearer.
45.summary: Course index should be opened by default first time a user access the course
description: This is what was decided together with UX team: On a large screen (desktop), the course index will be EXPANDED by default, so it will be expanded the first time the users access a course On large screens, the drawer state will be saved in the user preferences, so if the user collapses it, it should remain collapsed In small screens, the course index is always collapsed by default even if the user expands it and reloads the page, despite the user preference In small screens, the state of the drawer is not saved in the user preference
46.summary: New quick access to create a new course from My courses page when there is no course available
description: Sites with no courses dont show a link to create new ones. This makes much harder for new teacher/admin users to complete their most basic flow, which is to create a new course. There s a high risk of them pivoting to other solutions if they are not able to create a course when using Moodle for the first time. Mockup (outdated see below): !image-2021-12-10-13-38-28-593.png! . Acceptance criteria: For users with capability to create courses as site level on My courses page: There is a link to "Create a new course" if there is no course to show in the main page. There is no link to "Create a new course" if there is at least one course to show. Wether there is any course to show or not, there is a New course link to create a course on the kebab menu . Update The "My courses" page content is actually the same as the block "Course overview". The follow image illustrate a more realistic version of the mockup above (its based on the current QA site state): !Screenshot 2021-12-14 at 10.14.02.png|width=625,height=404!
|
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: Implement front-end framework(s) (client app SDK)
description: See issues included in this epic.
| Solvable | 1.summary: Develop/Implement front-end SDK
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: Implement front-end framework(s) (client app SDK)
description: See issues included in this epic.
### Response:
1.summary: Develop/Implement front-end SDK
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: Improve the user experience in Gradebook -part 1
description: This project aims to modernize Moodles gradebook interface and make its usage more intuitive. The proposed changes for 4.1 will be generally centered around improving the gradebook experience for teachers and students. There are two main goals: make it easier and more intuitive for teachers to view and manage the existing course grades. make it easier and more intuitive for students to view their grades. . MVP The key tasks related to the teacher persona are: New "Grades summary" page which provides a summary of the grade averages for each course activity. Improved "User report" report with a more modern design and make it easier to use. Improved "Single view report" report with a more modern design and make it easier to use. Improve and modernize the user interface of the "Import" and "Export" grades pages Revamp the styling of the tertiary navigation in the gradebook. The key tasks related to the student persona will be added soon. . Prototype links: Teacher view| Student view| . Future work (out of scope for 4.1) There are some out-of-scope goals for teachers that may be aimed in the future releases, including: Improved "Grader report" with a more modern design and make it easier to use. Revamp the "Gradebook setup" page styling with a more modern design and make it easier to use. Improved search and filter functionality in the grades report pages. Extend the information that is provided in the "Grades summary" page. Introduce drag-and-drop reordering of rows and columns in the gradebook reports. Build a new structure and functionality similar to the "course index" in the "Gradebook setup" page to create a better visual representation of the grade categories and items and make it easier to manage them. Introduce overlays instead of physical pages to display certain content or forms in the gradebook.
| Solvable | 1.summary: Create data sources for gradebook report builder instances
description: . Summary: Based on the feedback and outcome of well now need to identify and create datasources for various aspects of the upcoming gradebook changes. Until has been resolved, this issue is functionally blocked. This is due to us still needing to decide upon the skeleton we ll be crafting the gradebook changes upon. . Scope: Identify items in the gradebook prototypes thatll likely require datasources Implement said datasources backed by any appropriate automated testing . Out of scope: Frontend implementation of created datasources . TODO before closing Document new datasources on this issue for future reference
2.summary: Implement editing functionality in the Single view report
description: . Summary Given the Figma prototype ( we want to add editing functionality in the Single view report that would utilize the existing Edit mode switch. We want to enable users to quickly edit either single cell within the report or multiple cells when the Turn editing mode switch is enabled. The editing functionality should be implemented in both User and Grade item view. . Scope Edit mode hooked up to the Edit mode switch at the top of the page Editing grade(s) functionality Editing feedback functionality Overriding grade(s) and revert overrides Excluding grade(s) and revert exclusions Unified save action Automated testing . Bonus goals Empty action dropdown menu within the tertiary navigation (will be populated with bulk actions in separate issues) . Out of scope Bulk grade overrides. Bulk grade exclusions Bulk grade insert.
3.summary: Implement bulk grade exclusion functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade exclusion functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly exclude all grades or revert all grade exclusions. The bulk grade exclusion functionality should be implemented in both User and Grade item view. . Scope Exclude All and Exclude None options in the actions dropdown menu Exclude all grades functionality Revert all grade exclusions functionality Automated testing
4.summary: Scoping interation pre 0.1 sprint
description: . Summary: In the attached document Only open to HQ for time being| is the observations made by the team in previous iterations of scoping sessions. Given the above, we have collated various questions and tasks into a spreadsheet ready for UX review and decision. . Scope: This MDL can be closed once all items on the attached sheet have been answered . Out of scope: New questions in regards to current designs . TODO before closing: A new MDL should be created in its place if / when another scoping session occurs that contains actionables
5.summary: Investigate feasibility of utilising the report builder within gradebook redesign
description: . Summary: Given that the current grade book styling is inspired by the report builder and we have it as a component available to us, we should look into the feasibility of utilising it to prevent more bespoke report implementations within Moodle core. After a brief discussion with the Workplace team (Moodle internal URL to meeting| it is looking positive that we may be able to use this feature and extend functionality as required. The bulk of this investigation is expected to be done within where we will attempt to create the new "Grades summary" page . Scope: Investigate if the Reportbuilder plugin is fit for purpose with our expected use cases . Out of scope: Implementation of Reportbuilder . TODO before closing: Report findings on this issue to share with the team so we may collectively decide if thisll be our approach
6.summary: Update tertiary dropdown into a future generic component
description: . Summary: During the 4.0 navigation work due to the nature of the project we did not create a base component that all plugins could easily implement. This creates a problem with both maintainability and extensibility as our displays may not be consistent. Whilst this MDL can be seen as not being a part of the core gradebook project, itll be addressed here and well also be laying some foundation work for the 4.1 Gradebook changes to make our lives easier in the sprints to come. . Scope: Review existing tertiary navigation implementations Either adopt / adapt or implement a new easily extendable tertiary component Implement the new tertiary component within the gradebook Ensure the navigation is ready for styling i.e. simple templates etc in Implement Reasonable automated testing Modify / alter existing behat steps to utilise the new component . Out of scope: Implementing the new component across Moodle . TODO before closing Document the new component within the component library Create meeting to cover the new component and decide if is still required
7.summary: Update import/export pages within the gradebook
description: . Summary: Given the designs with the Figma prototype| we need to update the import / export pages within the gradebook and update the import/export options selector element. . Scope: Create a new reusable dropdown selector component based on the following criteria: Styling closely matches the one in the prototype. Accessible. Behat support (step definitions), if applicable. Replace the current url selector element with the new dropdown selector component in the grade import/export pages . Out of scope: Floating footer sticky navigation ()
8.summary: Implement gradebook zero states for user & singleview reports
description: . Summary: With the current Figma prototype| we want to create a new Single view report. To aid in this goal we need to create the zero state and intermediary pages to the incoming reports. . Assumptions: Upon selecting the Single view report at any point, you ll hit the landing page Upon selecting a report type to view, The page should not have to refresh to change the state Something like the reactive component or Activity chooser can be examples of this Once a report type has been selected, The user will then search using the basic search component then be redirected . Scope: Creation of a new Single view report type Basic user / grade search Landing page with links to both of the new intermediary pages for Users and Grade items Zero state pages for both of the Users and Grade items intermediary pages where specific search can be done Dummy zero state images (Link to existing MRKT-XXXXX issue) Automated testing . Bonus goals: Have the selector / search show inline with the button in the middle of the page . Out of scope: Either of the two new reports within the single view report Complete reusable search component For now only basic search is enough as we ll look to make this a generic component used across the new reporting infrastructure within a new task
9.summary: Create a new "Grades summary" report in gradebook
description: . Summary: Given the designs on the Gradebook figma| Create a new "Grades summary" report which provides a summary of the grade averages for each course activity. This issue is expected to be worked in tandem with where we are investigating the usage of the report builder within the gradebook project. . Scope: Creation of a new gradebook report with all the standard capability checks used elsewhere Creation of System report required for the table Outputting above data into the new page . Bonus goals: Data table is searchable via a search bar (hopefully reportbuilder has this functionality) Does not need to be in the correct place just on page is good enough at the moment Data table can be filtered on activity type Data can be paginated within the page . Out of scope: Tertiary navigation changes Separate course average node . TODO before closing: Create MDL for either adding the course average node / relocating the node to become inline with the existing tertiary navigation If any of the bonus goals are not handled here, Created respective MDLs
10.summary: Implement the xxxx Average: xx Gradebook feature
description: . Summary: Given the Gradebook figma| We have a lot of different places that appear to have a common component. This component essentially takes the entire average across the presented dataset within a page and includes it near the top of the page within the Page header / Tertiary navigation area. Instead of leaving this requirement inside of each gradebook issue as a bonus goal, we ll have it all handled here. These averages should be within each table as we currently display such information within existing report types. What we want to do here is replicate that information at the top of the page. Across the different gradebook reports and pages. These averages can be anything from Course average which is an average of course averages, Course total or a users average grade across modules within a course. . Scope: Implement the appropriate grade average calculation that will be used later on Grader report and User report pages Document this functionality in case third party requests to make similar plugins Unit testing of the new component that passes . Out of scope: Creation of each report that this average is being added to Implementation not required within each modules grade page Frontend rendering of the new component
11.summary: Implement the User report page shell (Zero state)
description: . Summary: Given the Gradebook figma| we need to investigate if using the existing user report is feasible or if we deprecate/rename it and replace it with the newly designed page which will likely be based on the reportbuilder. . Scope: Create a new User report plugin Zero state page created Iconography implemented Click to select user(s) button aka start button created User switcher implemented which ll be used to retrieve the selected users data in the blocked issue Start button and User switcher use the same switching/searching component . Out of scope: Output and manipulation of user data which ll be handled in the blocked issue Average functionality ()
12.summary: Group selector tied into User selector
description: . Summary: Given the base implementation created within the Single view report zero state issue () we will need to implement similar functionality for grouping. It is likely changes will be required in the base implementation of the user widget to optionally take in a group ID to filter down enrolled users. . Scope: Migrate the user widget into a generic component Implement group functionality Fetch groups within the course Filter groups based on name Pass a default group ID if no group is selected If a group is selected, Pass that to the user selector Automated testing Document the user & group widget
13.summary: Implement "Singleview report" functionality
description: . Summary: Using the new zero state of the single view report as a base, we want to create a view only mode in the grade Single view report for both User and Grade item view. Given the Figma prototype| we want to create a connection between the report Edit mode switch and when Edit mode is disabled provide the user a view only state of the Single view report where there is no editable fields. When Edit mode is enabled we want same functionality as old singleview report . Scope: Update any dummy links in the zero state to refer to this new report Note: this may not required as the zero state issue will make those intermediary pages and this issue can be worked on assuming the predecessor page will pass a user ID to this report Information pills if a user has overridden or excluded grades Grade item navigation at the bottom of the page for the Previous & Next grade items Presumed due to lack of design Automated testing Implement a view only mode of the report (when edit switch is turned off) where: there is no editable fields within the report table bulk actions (override, exclude, grade insert) are not available to the user Edit mode - Bulk Actions as per design
14.summary: Investigate the html table class and its potential use in Gradebook 4.1
description: . Summary: Given the Gradebook figma| We may need to create a new Grader report page. This page should contain a table detailing enrolled students grades across a course and any additional loose grade items. Here we want to see if using the existing report may be easier than reimplementing a report using the report builder. The idea here is to duplicate one of the existing reports that this page draws inspiration from and modify the styling and functionality to fit the design. If the above proves unwieldy, large and overly engineered then we also have the option of implementing this into a report builder framework . Scope: Investigate if gradebook reports can be disabled from use . Out of scope: Any implementation of either decided option
15.summary: Improve the styling of the tertiary navigation on the gradebook pages
description: . Summary: Depending on the results of , well need to further improve the styling of the base tertiary navigation. The designs can be found here in the gradebook figma| . Scope: Ensure the styling of tertiary navigation area more closely matches the provided designs (borders and dividers)
16.summary: Editing mode for both single view gradebook reports
description: . Summary: Given the Figma prototype| we to we want to create a connection between the report and the Edit mode switch. When Edit mode is enabled the user should be able to modify certain grade information. In addition to that we want the users to be able to quickly override all grades, exclude all grades and bulk insert grades. . Scope: The following requirements should be available when Editing mode is enabled The table cells under the following columns should be editable: Grade (input) Feedback (input) Override (checkbox) Exclude (checkbox) Ability to save the changes to the grades. Actions dropdown menu in the tertiary navigation area. This dropdown should contain the following options and functionality: Bulk override grades (Override all/Override none) Bulk exclude grades (Exclude all/ Exclude none) Bulk insert grades Create a modal for the Bulk insert grades action with the following requirements notification about the risks of the action with a confirmation checkbox Option (radio) to select which grade should be updated (All grades or Empty grades) Grade value input Cancel action Save action - applies the new grades and saves all the existing changes in the report/ Automated testing
17.summary: Implement bulk grade override functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade override functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly override all grades or revert all grade overrides. The bulk grade override functionality should be implemented in both User and Grade item view. . Scope Override all and Override none options in the actions dropdown menu Override all grades functionality Revert all grade overrides functionality Exclude All and Exclude None options in the actions dropdown menu Exclude all grades functionality Revert all grade exclusions functionality Automated testing
18.summary: Implement bulk grade insert functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade insert functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly insert a single grade for multiple users. The bulk grade insert functionality should be implemented in both User and Grade item view. . Scope Bulk insert option in the actions dropdown menu Bulk insert modal Update table with new value without grade recalculation when clicking Apply button (data is only stored when Save button is clicked) Bulk insert grade functionality Automated testing
19.summary: Replace the modals with dropdowns in the search widgets in the grade reports
description: Given the prototypes| for the gradebook, we need to migrate away from my initial work within modals to a new dropdown type of factory. I purposefully built the current implementation based upon modals so that we had something working and so that we could migrate it easier into a new factory. Within this issue, we are aiming on creating the initial factory and perhaps migrating the gradebook work. If not thisll be a followup.
20.summary: Implement "User report" functionality
description: . Summary: -- Note this issue needs further writing. Given the Gradebook figma| and status of the blocking issue, We want to now implement the user report. This will use existing user repot plugin as a base - we just tweak the output to match the design. The main difference with existing report is collapsible categories. User report is only way for student to see their grades so not interfering with single view report Single user owner . Scope: Create a new user report base on old user report (done as part of ?) Create custom css for the table to match the figma prtototype Enable categories/subcategories to be collapsible in report table Next previous user navigation links . Out of scope: Zero state page creation () User average across courses DOM Node () Floating footer sticky navigation () . Bonus Goals Activity search similar to user search in
21.summary: Secondary navigation bar changes
description: . Summary: Within the Gradebook figma| We have noticed that there are discrepancies between both it and the current implementation of the Secondary navigation. Whilst these changes are not specific to the gradebook we ll aim to handle them within this project. . Scope: Update Secondary navigation styling Top border removed Bottom border is full width of parent div Ensure the styling changes do not break the rest of Moodle core . Out of scope:
22.summary: make categories collapsible on grade User report page
description: According to Figma prototype| grade categories should be collapsible on user report page . Scope User is able to collapse/uncollapse grade categories . Out of scope Saving a state of category
| 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 user experience in Gradebook -part 1
description: This project aims to modernize Moodles gradebook interface and make its usage more intuitive. The proposed changes for 4.1 will be generally centered around improving the gradebook experience for teachers and students. There are two main goals: make it easier and more intuitive for teachers to view and manage the existing course grades. make it easier and more intuitive for students to view their grades. . MVP The key tasks related to the teacher persona are: New "Grades summary" page which provides a summary of the grade averages for each course activity. Improved "User report" report with a more modern design and make it easier to use. Improved "Single view report" report with a more modern design and make it easier to use. Improve and modernize the user interface of the "Import" and "Export" grades pages Revamp the styling of the tertiary navigation in the gradebook. The key tasks related to the student persona will be added soon. . Prototype links: Teacher view| Student view| . Future work (out of scope for 4.1) There are some out-of-scope goals for teachers that may be aimed in the future releases, including: Improved "Grader report" with a more modern design and make it easier to use. Revamp the "Gradebook setup" page styling with a more modern design and make it easier to use. Improved search and filter functionality in the grades report pages. Extend the information that is provided in the "Grades summary" page. Introduce drag-and-drop reordering of rows and columns in the gradebook reports. Build a new structure and functionality similar to the "course index" in the "Gradebook setup" page to create a better visual representation of the grade categories and items and make it easier to manage them. Introduce overlays instead of physical pages to display certain content or forms in the gradebook.
### Response:
1.summary: Create data sources for gradebook report builder instances
description: . Summary: Based on the feedback and outcome of well now need to identify and create datasources for various aspects of the upcoming gradebook changes. Until has been resolved, this issue is functionally blocked. This is due to us still needing to decide upon the skeleton we ll be crafting the gradebook changes upon. . Scope: Identify items in the gradebook prototypes thatll likely require datasources Implement said datasources backed by any appropriate automated testing . Out of scope: Frontend implementation of created datasources . TODO before closing Document new datasources on this issue for future reference
2.summary: Implement editing functionality in the Single view report
description: . Summary Given the Figma prototype ( we want to add editing functionality in the Single view report that would utilize the existing Edit mode switch. We want to enable users to quickly edit either single cell within the report or multiple cells when the Turn editing mode switch is enabled. The editing functionality should be implemented in both User and Grade item view. . Scope Edit mode hooked up to the Edit mode switch at the top of the page Editing grade(s) functionality Editing feedback functionality Overriding grade(s) and revert overrides Excluding grade(s) and revert exclusions Unified save action Automated testing . Bonus goals Empty action dropdown menu within the tertiary navigation (will be populated with bulk actions in separate issues) . Out of scope Bulk grade overrides. Bulk grade exclusions Bulk grade insert.
3.summary: Implement bulk grade exclusion functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade exclusion functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly exclude all grades or revert all grade exclusions. The bulk grade exclusion functionality should be implemented in both User and Grade item view. . Scope Exclude All and Exclude None options in the actions dropdown menu Exclude all grades functionality Revert all grade exclusions functionality Automated testing
4.summary: Scoping interation pre 0.1 sprint
description: . Summary: In the attached document Only open to HQ for time being| is the observations made by the team in previous iterations of scoping sessions. Given the above, we have collated various questions and tasks into a spreadsheet ready for UX review and decision. . Scope: This MDL can be closed once all items on the attached sheet have been answered . Out of scope: New questions in regards to current designs . TODO before closing: A new MDL should be created in its place if / when another scoping session occurs that contains actionables
5.summary: Investigate feasibility of utilising the report builder within gradebook redesign
description: . Summary: Given that the current grade book styling is inspired by the report builder and we have it as a component available to us, we should look into the feasibility of utilising it to prevent more bespoke report implementations within Moodle core. After a brief discussion with the Workplace team (Moodle internal URL to meeting| it is looking positive that we may be able to use this feature and extend functionality as required. The bulk of this investigation is expected to be done within where we will attempt to create the new "Grades summary" page . Scope: Investigate if the Reportbuilder plugin is fit for purpose with our expected use cases . Out of scope: Implementation of Reportbuilder . TODO before closing: Report findings on this issue to share with the team so we may collectively decide if thisll be our approach
6.summary: Update tertiary dropdown into a future generic component
description: . Summary: During the 4.0 navigation work due to the nature of the project we did not create a base component that all plugins could easily implement. This creates a problem with both maintainability and extensibility as our displays may not be consistent. Whilst this MDL can be seen as not being a part of the core gradebook project, itll be addressed here and well also be laying some foundation work for the 4.1 Gradebook changes to make our lives easier in the sprints to come. . Scope: Review existing tertiary navigation implementations Either adopt / adapt or implement a new easily extendable tertiary component Implement the new tertiary component within the gradebook Ensure the navigation is ready for styling i.e. simple templates etc in Implement Reasonable automated testing Modify / alter existing behat steps to utilise the new component . Out of scope: Implementing the new component across Moodle . TODO before closing Document the new component within the component library Create meeting to cover the new component and decide if is still required
7.summary: Update import/export pages within the gradebook
description: . Summary: Given the designs with the Figma prototype| we need to update the import / export pages within the gradebook and update the import/export options selector element. . Scope: Create a new reusable dropdown selector component based on the following criteria: Styling closely matches the one in the prototype. Accessible. Behat support (step definitions), if applicable. Replace the current url selector element with the new dropdown selector component in the grade import/export pages . Out of scope: Floating footer sticky navigation ()
8.summary: Implement gradebook zero states for user & singleview reports
description: . Summary: With the current Figma prototype| we want to create a new Single view report. To aid in this goal we need to create the zero state and intermediary pages to the incoming reports. . Assumptions: Upon selecting the Single view report at any point, you ll hit the landing page Upon selecting a report type to view, The page should not have to refresh to change the state Something like the reactive component or Activity chooser can be examples of this Once a report type has been selected, The user will then search using the basic search component then be redirected . Scope: Creation of a new Single view report type Basic user / grade search Landing page with links to both of the new intermediary pages for Users and Grade items Zero state pages for both of the Users and Grade items intermediary pages where specific search can be done Dummy zero state images (Link to existing MRKT-XXXXX issue) Automated testing . Bonus goals: Have the selector / search show inline with the button in the middle of the page . Out of scope: Either of the two new reports within the single view report Complete reusable search component For now only basic search is enough as we ll look to make this a generic component used across the new reporting infrastructure within a new task
9.summary: Create a new "Grades summary" report in gradebook
description: . Summary: Given the designs on the Gradebook figma| Create a new "Grades summary" report which provides a summary of the grade averages for each course activity. This issue is expected to be worked in tandem with where we are investigating the usage of the report builder within the gradebook project. . Scope: Creation of a new gradebook report with all the standard capability checks used elsewhere Creation of System report required for the table Outputting above data into the new page . Bonus goals: Data table is searchable via a search bar (hopefully reportbuilder has this functionality) Does not need to be in the correct place just on page is good enough at the moment Data table can be filtered on activity type Data can be paginated within the page . Out of scope: Tertiary navigation changes Separate course average node . TODO before closing: Create MDL for either adding the course average node / relocating the node to become inline with the existing tertiary navigation If any of the bonus goals are not handled here, Created respective MDLs
10.summary: Implement the xxxx Average: xx Gradebook feature
description: . Summary: Given the Gradebook figma| We have a lot of different places that appear to have a common component. This component essentially takes the entire average across the presented dataset within a page and includes it near the top of the page within the Page header / Tertiary navigation area. Instead of leaving this requirement inside of each gradebook issue as a bonus goal, we ll have it all handled here. These averages should be within each table as we currently display such information within existing report types. What we want to do here is replicate that information at the top of the page. Across the different gradebook reports and pages. These averages can be anything from Course average which is an average of course averages, Course total or a users average grade across modules within a course. . Scope: Implement the appropriate grade average calculation that will be used later on Grader report and User report pages Document this functionality in case third party requests to make similar plugins Unit testing of the new component that passes . Out of scope: Creation of each report that this average is being added to Implementation not required within each modules grade page Frontend rendering of the new component
11.summary: Implement the User report page shell (Zero state)
description: . Summary: Given the Gradebook figma| we need to investigate if using the existing user report is feasible or if we deprecate/rename it and replace it with the newly designed page which will likely be based on the reportbuilder. . Scope: Create a new User report plugin Zero state page created Iconography implemented Click to select user(s) button aka start button created User switcher implemented which ll be used to retrieve the selected users data in the blocked issue Start button and User switcher use the same switching/searching component . Out of scope: Output and manipulation of user data which ll be handled in the blocked issue Average functionality ()
12.summary: Group selector tied into User selector
description: . Summary: Given the base implementation created within the Single view report zero state issue () we will need to implement similar functionality for grouping. It is likely changes will be required in the base implementation of the user widget to optionally take in a group ID to filter down enrolled users. . Scope: Migrate the user widget into a generic component Implement group functionality Fetch groups within the course Filter groups based on name Pass a default group ID if no group is selected If a group is selected, Pass that to the user selector Automated testing Document the user & group widget
13.summary: Implement "Singleview report" functionality
description: . Summary: Using the new zero state of the single view report as a base, we want to create a view only mode in the grade Single view report for both User and Grade item view. Given the Figma prototype| we want to create a connection between the report Edit mode switch and when Edit mode is disabled provide the user a view only state of the Single view report where there is no editable fields. When Edit mode is enabled we want same functionality as old singleview report . Scope: Update any dummy links in the zero state to refer to this new report Note: this may not required as the zero state issue will make those intermediary pages and this issue can be worked on assuming the predecessor page will pass a user ID to this report Information pills if a user has overridden or excluded grades Grade item navigation at the bottom of the page for the Previous & Next grade items Presumed due to lack of design Automated testing Implement a view only mode of the report (when edit switch is turned off) where: there is no editable fields within the report table bulk actions (override, exclude, grade insert) are not available to the user Edit mode - Bulk Actions as per design
14.summary: Investigate the html table class and its potential use in Gradebook 4.1
description: . Summary: Given the Gradebook figma| We may need to create a new Grader report page. This page should contain a table detailing enrolled students grades across a course and any additional loose grade items. Here we want to see if using the existing report may be easier than reimplementing a report using the report builder. The idea here is to duplicate one of the existing reports that this page draws inspiration from and modify the styling and functionality to fit the design. If the above proves unwieldy, large and overly engineered then we also have the option of implementing this into a report builder framework . Scope: Investigate if gradebook reports can be disabled from use . Out of scope: Any implementation of either decided option
15.summary: Improve the styling of the tertiary navigation on the gradebook pages
description: . Summary: Depending on the results of , well need to further improve the styling of the base tertiary navigation. The designs can be found here in the gradebook figma| . Scope: Ensure the styling of tertiary navigation area more closely matches the provided designs (borders and dividers)
16.summary: Editing mode for both single view gradebook reports
description: . Summary: Given the Figma prototype| we to we want to create a connection between the report and the Edit mode switch. When Edit mode is enabled the user should be able to modify certain grade information. In addition to that we want the users to be able to quickly override all grades, exclude all grades and bulk insert grades. . Scope: The following requirements should be available when Editing mode is enabled The table cells under the following columns should be editable: Grade (input) Feedback (input) Override (checkbox) Exclude (checkbox) Ability to save the changes to the grades. Actions dropdown menu in the tertiary navigation area. This dropdown should contain the following options and functionality: Bulk override grades (Override all/Override none) Bulk exclude grades (Exclude all/ Exclude none) Bulk insert grades Create a modal for the Bulk insert grades action with the following requirements notification about the risks of the action with a confirmation checkbox Option (radio) to select which grade should be updated (All grades or Empty grades) Grade value input Cancel action Save action - applies the new grades and saves all the existing changes in the report/ Automated testing
17.summary: Implement bulk grade override functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade override functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly override all grades or revert all grade overrides. The bulk grade override functionality should be implemented in both User and Grade item view. . Scope Override all and Override none options in the actions dropdown menu Override all grades functionality Revert all grade overrides functionality Exclude All and Exclude None options in the actions dropdown menu Exclude all grades functionality Revert all grade exclusions functionality Automated testing
18.summary: Implement bulk grade insert functionality in the Single view report
description: Given the Figma prototype ( we want to add bulk grade insert functionality in the Single view report when Edit mode is enabled. We want to enable users to quickly insert a single grade for multiple users. The bulk grade insert functionality should be implemented in both User and Grade item view. . Scope Bulk insert option in the actions dropdown menu Bulk insert modal Update table with new value without grade recalculation when clicking Apply button (data is only stored when Save button is clicked) Bulk insert grade functionality Automated testing
19.summary: Replace the modals with dropdowns in the search widgets in the grade reports
description: Given the prototypes| for the gradebook, we need to migrate away from my initial work within modals to a new dropdown type of factory. I purposefully built the current implementation based upon modals so that we had something working and so that we could migrate it easier into a new factory. Within this issue, we are aiming on creating the initial factory and perhaps migrating the gradebook work. If not thisll be a followup.
20.summary: Implement "User report" functionality
description: . Summary: -- Note this issue needs further writing. Given the Gradebook figma| and status of the blocking issue, We want to now implement the user report. This will use existing user repot plugin as a base - we just tweak the output to match the design. The main difference with existing report is collapsible categories. User report is only way for student to see their grades so not interfering with single view report Single user owner . Scope: Create a new user report base on old user report (done as part of ?) Create custom css for the table to match the figma prtototype Enable categories/subcategories to be collapsible in report table Next previous user navigation links . Out of scope: Zero state page creation () User average across courses DOM Node () Floating footer sticky navigation () . Bonus Goals Activity search similar to user search in
21.summary: Secondary navigation bar changes
description: . Summary: Within the Gradebook figma| We have noticed that there are discrepancies between both it and the current implementation of the Secondary navigation. Whilst these changes are not specific to the gradebook we ll aim to handle them within this project. . Scope: Update Secondary navigation styling Top border removed Bottom border is full width of parent div Ensure the styling changes do not break the rest of Moodle core . Out of scope:
22.summary: make categories collapsible on grade User report page
description: According to Figma prototype| grade categories should be collapsible on user report page . Scope User is able to collapse/uncollapse grade categories . Out of scope Saving a state of category
|
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: Refactor downloading of csv, ods, excel etc files in reports and exports across moodle to stream progressively
description: I made a patch for which seems to be the tip of the iceberg in a bunch of potential improvements and refactoring around file downloading scalability and performance. csv, ods, excel file downloads in Moodle are almost universally bad at scale, the solution in is an improvement to the csvlib to stream from a DB RecordSet or Iterator, through an optional transforming function, and then encoded as csv line by line and flushed continually over the network giving it a fixed memory footprint and almost instantaneous download start. But this is just one download option in one module. Almost every large client of ours has been burnt by this bug in different places depending on what parts of moodle they happen to be using massively. Id like to take this solution further and also add streaming download support for the other download types, eg .ods and excel which will be a fairly major refactor of many places in moodle as its a fundamental change in API. But if were going to do this, then I think we could go an extra extra step and abstract away the various formats into a new plugin type. ie a module like mod_feedback, or the grade book just says I have a RecordSet or an Iterator, please present this as a bunch of alternative downloads to the user. Then if I install a new format like say RDF, or JSON, then every report or export in moodle gets this new format for free. So a new api something this which renders the dropdown with all the different export options: report.php: $OUTPUT->download_as_chooser( get_string(exportgrades, feedback), // Name on button dropdown new moodle_url(export.php, array(id => $id)), // base url type, // optional name of query param which will have download format export.php: $format = required_param(type, PARAM_ALPHANUM); $rs = $DB->get_record_set(...); $download = new downloader(); $download->set_filename(feedback); $download->set_key_names(array(name => get_string(name) ...... ); // eg human readable csv header names $download->download_from_resultset($rs, $callback, $type); Under the hood wed have a core set of formats something like: /format/csv/ /format/ods/ /format/xls/ These would either wrap existing APIs or reimplement as needed. In particular I am thinking of pulling in Spout as a dependency which does streaming ods, csv, and excel: And then as bonus points Id also do a json and rdf export but these would probably only go into the plugin dir and not into core. There are probably other considerations: would a format also potentially provide a parse to accept incoming uploads? Ideally yes, but this would be optional for each format. The core ones should implement this. Is there any grade export / import code to consider or align with? each format would generally be content agnostic, but wed still pass the type into the callback so the module has an opportunity to transform the data if needed for a particular format. some downloads, eg the feedback excel, are special snowflakes with text formatting and worksheets. These would need a case by case decision to keep or refactor. Mentioning the big commiters around this: timhunt skodak nicolasconnault
| Solvable | 1.summary: Improve bulk user export performance
description: Running a bulk export of users will fail for larger sites, due to memory or time limit. It turns out that about 4 db queries are made for each user so the number of roundtrips is a significant barrier to performance. Most of this problem comes from the custom profile fields, which several queries are made to determine what the fields exist on every call. The following changes can greatly help: Cache list of custom profile fields Add option to bulk-preload data for a group of users into memory This can ultimately benefit any area of core that deals with user profiles. All up my changes improve the performance of this function about 10x, allowing a CSV download for a site with over 100k user accounts to complete in seconds.
| 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: Refactor downloading of csv, ods, excel etc files in reports and exports across moodle to stream progressively
description: I made a patch for which seems to be the tip of the iceberg in a bunch of potential improvements and refactoring around file downloading scalability and performance. csv, ods, excel file downloads in Moodle are almost universally bad at scale, the solution in is an improvement to the csvlib to stream from a DB RecordSet or Iterator, through an optional transforming function, and then encoded as csv line by line and flushed continually over the network giving it a fixed memory footprint and almost instantaneous download start. But this is just one download option in one module. Almost every large client of ours has been burnt by this bug in different places depending on what parts of moodle they happen to be using massively. Id like to take this solution further and also add streaming download support for the other download types, eg .ods and excel which will be a fairly major refactor of many places in moodle as its a fundamental change in API. But if were going to do this, then I think we could go an extra extra step and abstract away the various formats into a new plugin type. ie a module like mod_feedback, or the grade book just says I have a RecordSet or an Iterator, please present this as a bunch of alternative downloads to the user. Then if I install a new format like say RDF, or JSON, then every report or export in moodle gets this new format for free. So a new api something this which renders the dropdown with all the different export options: report.php: $OUTPUT->download_as_chooser( get_string(exportgrades, feedback), // Name on button dropdown new moodle_url(export.php, array(id => $id)), // base url type, // optional name of query param which will have download format export.php: $format = required_param(type, PARAM_ALPHANUM); $rs = $DB->get_record_set(...); $download = new downloader(); $download->set_filename(feedback); $download->set_key_names(array(name => get_string(name) ...... ); // eg human readable csv header names $download->download_from_resultset($rs, $callback, $type); Under the hood wed have a core set of formats something like: /format/csv/ /format/ods/ /format/xls/ These would either wrap existing APIs or reimplement as needed. In particular I am thinking of pulling in Spout as a dependency which does streaming ods, csv, and excel: And then as bonus points Id also do a json and rdf export but these would probably only go into the plugin dir and not into core. There are probably other considerations: would a format also potentially provide a parse to accept incoming uploads? Ideally yes, but this would be optional for each format. The core ones should implement this. Is there any grade export / import code to consider or align with? each format would generally be content agnostic, but wed still pass the type into the callback so the module has an opportunity to transform the data if needed for a particular format. some downloads, eg the feedback excel, are special snowflakes with text formatting and worksheets. These would need a case by case decision to keep or refactor. Mentioning the big commiters around this: timhunt skodak nicolasconnault
### Response:
1.summary: Improve bulk user export performance
description: Running a bulk export of users will fail for larger sites, due to memory or time limit. It turns out that about 4 db queries are made for each user so the number of roundtrips is a significant barrier to performance. Most of this problem comes from the custom profile fields, which several queries are made to determine what the fields exist on every call. The following changes can greatly help: Cache list of custom profile fields Add option to bulk-preload data for a group of users into memory This can ultimately benefit any area of core that deals with user profiles. All up my changes improve the performance of this function about 10x, allowing a CSV download for a site with over 100k user accounts to complete in seconds.
|
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: LTI: Update tool provider feature to support 1.3
description: Moodle can already provide courses and modules as LTI tools. This epic is about updating this feature to support the 1.3 specification - the only currently recommended standard. At a high level this might include: Ability for a shared course/module to be launched from a another Moodle acting as a 1.3 platform Grade sync update to 1.3 Member sync update to 1.3 Consider how deep linking might be used to select individual modules from a shared course (currently deep linking isnt supported in the provider)
| Unsolvable | 1.summary: LTI: Provide account provisioning options for LTI Advantage launches
description: This one is part bug and part planned improvement to solve said bug. Its a must fix 4.0 issue as instructors will almost certainly run into this problem without a process in place to handle it. The bug occurs only for users allowed to perform both types of launches: deep linking (content selection) and resource link launches (launching a shared module in the tool). I.e. Admins and instructors are affected. . Description of the problem: When the instructor makes a deep link launch, they must be authenticated with the tool site. This is so that we can find content which they have the capability to see (shared in courses where they both have access and can share content themselves). The instructor will thus log in to their preexisting account on the tool site. Lets call this one the real account. So, the user logs in and can browser a selection of resources to use. All fine so far. Once the user selects a resource (or several) and sets up some resource links (these are the mod_lti instances in a Moodle platform), they probably want to launch said resource to see what the view looks like, etc. THIS is where the problem arises. Because of the way the enrol_lti code works now, they will be logged in as a user account which belongs to the auth_lti auth method, and which IS NOT their real account. Lets call this one the lti account. So, we have real and lti accounts in the tool site. Now, lets assume the user goes back to add some more content and performs another deep linking launch. This time, since theyre already authenticated as the lti user, theyll be allowed to view the content listing, but it will be empty because that lti user doesnt have the necessary caps to see the published content. The instructor will have no idea whats happened and will create a bug report or a forum post. What we want is for the same account to be used when launching as an instructor, whether that be a deep linking launch or a resource link launch. Some instructors will have an existing tool account and will want to link that. Other instructors may only be given access to certain published resources, such as if theyre emailed the launch URL and uuid of the resource. These users will want to have an account auto-provisioned for them as they will not necessarily have an existing account on the tool. . Solution The solution to this problem is to provide an account binding (or "Linked login" to use existing Moodle terminology) which would essentially link the platform user (identified by their LTI launch credentials) with the respective user in the tool site. The way this would be achieved is via a one-time prompt for instructors when launching for the first time. They will be asked what theyd like to do and can select from two options: Create a new account - have the Moodle tool site automatically provision an LTI account for me Use an existing account - the user can log in with their preferred account. Regardless of which option the user chooses, it will result in the creation of an LTI Linked Login on the tool site, allowing us to find this user in future during any launch as part of authenticating them. This change must not impact student/learner launches. Student accounts in the tool will remain auto-provisioned for the time being. This change must also take into account migrated tools (those tools being launched with a valid LTI migration claim). We need to carefully document how instructor launches will behave in such cases as: a) when migration claim is sent and a preexisting user was found b) when migration claim was sent and there was no preexisting user found (i.e. the teacher is a new user to the tool)
2.summary: Investigate deep linking options
description: This is just an issue to summarize discussions about deep linking, and how it might be used to pick course modules from a shared course and any other potential uses in the Moodle tool case.
3.summary: Update tool enrolment code so that a user is automatically created and enrolled when launching via 1.3
description: This builds upon , adding/linking up the user login code.
4.summary: Return line item information during content selection
description: In addition to being able to select which activities theyd like to create a resource link to, wed also like teachers to be able to specify whether or not the platform will create a grade book column at the time of resource link creation (where supported by the tool activity). This should be an additional option for each content item in the existing picker flow.
5.summary: Provide upgrade path for 1.1 preconfigured tools
description: This deals with adding support, if possible, for the 1.1 migration claim described here: This should allow us to have continuity for users who have already used a tool/resource over 1.1, as we can now map their original user (created based on consumer) after verification of the consumer details in the migration claim. Note that this will include work for both platform (to make sure Moodle sends the claim in upgraded tools) and tool (to process it).
6.summary: Add dynamic registration support to the tool
description: See , which adds support for dynamic registration to the platform side of things, in mod/lti. This issue is about implementing the tool side, allowing the Moodle tool to be registered via one action in any dynamic-registration-compliant platforms. The IMS spec is not yet public, however if/when it becomes available, I will link it here.
7.summary: Update library and model code to support issuer+clientid uniqueness on registrations
description: Right now, the library treats each issuer as unique, whereas the spec allows issuer+clientid to be unique. I.e. multiple clients can register from the one issuer/platformid. This issue is scoped with making changes to the upstream and to the model (DB schema and any validation code in the model, or in dynamic registrations register.php) to allow registration of several clients under the same issuer for a given tool site. This issue should also check whether the dynamic registration flow can be used to add deployments for existing \issuer, clientid\ tuples. For example, if I were to use a dynamic registration URL again in another platform context (such as registering the tool in another category, etc) and this result in a new deployment for the same issuer+clientid, would the tool be able to resolve this without trying to create a new registration and failing on the uniqueness clause.
8.summary: Update tool to support 1.3 OAut/OIDC launch flow
description: Per the specs: Reference library from IMS (requires php7.3 iirc) This will involve adding several new fields to store relevant platform information in the tool as well as to store keys needed for the auth flow. Dynamic registration does not need to be supported at this time as support is not present in cores platform implementation yet. At the end of this work, we should be able to launch a tool via the OIDC third party initiated login flow and provide basic user information to the tool via JWT. This issue deals with primarily the auth flow. Another issue will be created to deal with user enrolments/auth of the specific user launching the tool () Some work has been done on this, so this will be about formalising that solution and working through any blockers.
9.summary: Update user sync task to support 1.3 messages
description: This issue deals with updating the user sync task in: enrol/lti/classes/task/sync_users.php User sync should use names and roles provisioning service 2: More detail will be added here as the project progresses
10.summary: Update grade sync task to support 1.3 messages
description: This issue deals with updating the grade sync task in: enrol/lti/classes/task/sync_grades.php Grade sync should use assignment grade services 2: This task should use the AGS score publish service to set the learners score in the platform. This should also work in conjunction with , in that a prior declared line item should be updated if created during the resource link creation process.
| 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: LTI: Update tool provider feature to support 1.3
description: Moodle can already provide courses and modules as LTI tools. This epic is about updating this feature to support the 1.3 specification - the only currently recommended standard. At a high level this might include: Ability for a shared course/module to be launched from a another Moodle acting as a 1.3 platform Grade sync update to 1.3 Member sync update to 1.3 Consider how deep linking might be used to select individual modules from a shared course (currently deep linking isnt supported in the provider)
### Response:
1.summary: LTI: Provide account provisioning options for LTI Advantage launches
description: This one is part bug and part planned improvement to solve said bug. Its a must fix 4.0 issue as instructors will almost certainly run into this problem without a process in place to handle it. The bug occurs only for users allowed to perform both types of launches: deep linking (content selection) and resource link launches (launching a shared module in the tool). I.e. Admins and instructors are affected. . Description of the problem: When the instructor makes a deep link launch, they must be authenticated with the tool site. This is so that we can find content which they have the capability to see (shared in courses where they both have access and can share content themselves). The instructor will thus log in to their preexisting account on the tool site. Lets call this one the real account. So, the user logs in and can browser a selection of resources to use. All fine so far. Once the user selects a resource (or several) and sets up some resource links (these are the mod_lti instances in a Moodle platform), they probably want to launch said resource to see what the view looks like, etc. THIS is where the problem arises. Because of the way the enrol_lti code works now, they will be logged in as a user account which belongs to the auth_lti auth method, and which IS NOT their real account. Lets call this one the lti account. So, we have real and lti accounts in the tool site. Now, lets assume the user goes back to add some more content and performs another deep linking launch. This time, since theyre already authenticated as the lti user, theyll be allowed to view the content listing, but it will be empty because that lti user doesnt have the necessary caps to see the published content. The instructor will have no idea whats happened and will create a bug report or a forum post. What we want is for the same account to be used when launching as an instructor, whether that be a deep linking launch or a resource link launch. Some instructors will have an existing tool account and will want to link that. Other instructors may only be given access to certain published resources, such as if theyre emailed the launch URL and uuid of the resource. These users will want to have an account auto-provisioned for them as they will not necessarily have an existing account on the tool. . Solution The solution to this problem is to provide an account binding (or "Linked login" to use existing Moodle terminology) which would essentially link the platform user (identified by their LTI launch credentials) with the respective user in the tool site. The way this would be achieved is via a one-time prompt for instructors when launching for the first time. They will be asked what theyd like to do and can select from two options: Create a new account - have the Moodle tool site automatically provision an LTI account for me Use an existing account - the user can log in with their preferred account. Regardless of which option the user chooses, it will result in the creation of an LTI Linked Login on the tool site, allowing us to find this user in future during any launch as part of authenticating them. This change must not impact student/learner launches. Student accounts in the tool will remain auto-provisioned for the time being. This change must also take into account migrated tools (those tools being launched with a valid LTI migration claim). We need to carefully document how instructor launches will behave in such cases as: a) when migration claim is sent and a preexisting user was found b) when migration claim was sent and there was no preexisting user found (i.e. the teacher is a new user to the tool)
2.summary: Investigate deep linking options
description: This is just an issue to summarize discussions about deep linking, and how it might be used to pick course modules from a shared course and any other potential uses in the Moodle tool case.
3.summary: Update tool enrolment code so that a user is automatically created and enrolled when launching via 1.3
description: This builds upon , adding/linking up the user login code.
4.summary: Return line item information during content selection
description: In addition to being able to select which activities theyd like to create a resource link to, wed also like teachers to be able to specify whether or not the platform will create a grade book column at the time of resource link creation (where supported by the tool activity). This should be an additional option for each content item in the existing picker flow.
5.summary: Provide upgrade path for 1.1 preconfigured tools
description: This deals with adding support, if possible, for the 1.1 migration claim described here: This should allow us to have continuity for users who have already used a tool/resource over 1.1, as we can now map their original user (created based on consumer) after verification of the consumer details in the migration claim. Note that this will include work for both platform (to make sure Moodle sends the claim in upgraded tools) and tool (to process it).
6.summary: Add dynamic registration support to the tool
description: See , which adds support for dynamic registration to the platform side of things, in mod/lti. This issue is about implementing the tool side, allowing the Moodle tool to be registered via one action in any dynamic-registration-compliant platforms. The IMS spec is not yet public, however if/when it becomes available, I will link it here.
7.summary: Update library and model code to support issuer+clientid uniqueness on registrations
description: Right now, the library treats each issuer as unique, whereas the spec allows issuer+clientid to be unique. I.e. multiple clients can register from the one issuer/platformid. This issue is scoped with making changes to the upstream and to the model (DB schema and any validation code in the model, or in dynamic registrations register.php) to allow registration of several clients under the same issuer for a given tool site. This issue should also check whether the dynamic registration flow can be used to add deployments for existing \issuer, clientid\ tuples. For example, if I were to use a dynamic registration URL again in another platform context (such as registering the tool in another category, etc) and this result in a new deployment for the same issuer+clientid, would the tool be able to resolve this without trying to create a new registration and failing on the uniqueness clause.
8.summary: Update tool to support 1.3 OAut/OIDC launch flow
description: Per the specs: Reference library from IMS (requires php7.3 iirc) This will involve adding several new fields to store relevant platform information in the tool as well as to store keys needed for the auth flow. Dynamic registration does not need to be supported at this time as support is not present in cores platform implementation yet. At the end of this work, we should be able to launch a tool via the OIDC third party initiated login flow and provide basic user information to the tool via JWT. This issue deals with primarily the auth flow. Another issue will be created to deal with user enrolments/auth of the specific user launching the tool () Some work has been done on this, so this will be about formalising that solution and working through any blockers.
9.summary: Update user sync task to support 1.3 messages
description: This issue deals with updating the user sync task in: enrol/lti/classes/task/sync_users.php User sync should use names and roles provisioning service 2: More detail will be added here as the project progresses
10.summary: Update grade sync task to support 1.3 messages
description: This issue deals with updating the grade sync task in: enrol/lti/classes/task/sync_grades.php Grade sync should use assignment grade services 2: This task should use the AGS score publish service to set the learners score in the platform. This should also work in conjunction with , in that a prior declared line item should be updated if created during the resource link creation process.
|
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: Implement ORM and back-end framework(s)
description: See issues included in this epic.
| Solvable | 1.summary: Develop/Implement back-end language(s)/framework(s)
description: WIP
2.summary: Implement ORM
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: Implement ORM and back-end framework(s)
description: See issues included in this epic.
### Response:
1.summary: Develop/Implement back-end language(s)/framework(s)
description: WIP
2.summary: Implement ORM
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: META: New event system - stage 2
description: New event system - stage 2
| Unsolvable | 1.summary: Replace add_to_log with an event trigger - mod_data
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/data (9 calls) /mod/data/templates.php:76: add_to_log($course->id, data, templates view, "templates.php?id=$cm->id&d=$data->id", $data->id, $cm->id); /mod/data/templates.php:141: add_to_log($course->id, data, templates saved, "templates.php?id=$cm->id&d=$data->id", $data->id, $cm->id); /mod/data/index.php:42: add_to_log($course->id, "data", "view all", "index.php?id=$course->id", ""); /mod/data/field.php:124: add_to_log($course->id, data, fields add, /mod/data/field.php:166: add_to_log($course->id, data, fields update, /mod/data/field.php:197: add_to_log($course->id, data, fields delete, /mod/data/edit.php:189: add_to_log($course->id, data, update, "view.php?d=$data->id&rid=$rid", $data->id, $cm->id); /mod/data/edit.php:239: add_to_log($course->id, data, add, "view.php?d=$data->id&rid=$recordid", $data->id, $cm->id); /mod/data/view.php:255: add_to_log($course->id, data, view, "view.php?id=$cm->id", $data->id, $cm->id); /mod/data/view.php:377: add_to_log($course->id, data, record delete, "view.php?id=$cm->id", $data->id, $cm->id); Please also check /mod/data/lib.php data_delete_record() add_to_log call (if is integrated) add_to_log($courseid, data, record delete, "view.php?id=$cmid", $data->id, $cmid);
2.summary: Replace add_to_log with an event trigger - mod_lesson
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/lesson (9 calls) /mod/lesson/index.php:42: add_to_log($course->id, "lesson", "view all", "index.php?id=$course->id", ""); /mod/lesson/essay.php:133: add_to_log($course->id, lesson, update grade, "essay.php?id=$cm->id", $lesson->name, $cm->id); /mod/lesson/essay.php:247: add_to_log($course->id, lesson, update email essay grade, "essay.php?id=$cm->id", format_string($pages$attempt->pageid->title,true).: .fullname($users$attempt->userid), $cm->id); /mod/lesson/essay.php:303: add_to_log($course->id, lesson, view grade, "essay.php?id=$cm->id", get_string(manualgrading, lesson), $cm->id); /mod/lesson/highscores.php:149: add_to_log($course->id, lesson, update highscores, "highscores.php?id=$cm->id", $name, $cm->id); /mod/lesson/highscores.php:160: add_to_log($course->id, lesson, view highscores, "highscores.php?id=$cm->id", $lesson->name, $cm->id); /mod/lesson/view.php:182: add_to_log($course->id, lesson, start, view.php?id=. $cm->id, $lesson->id, $cm->id); /mod/lesson/view.php:286: add_to_log($PAGE->course->id, lesson, view, view.php?id=. $PAGE->cm->id, $page->id, $PAGE->cm->id); /mod/lesson/view.php:417: add_to_log($course->id, "lesson", "end", "view.php?id=".$PAGE->cm->id, "$lesson->id", $PAGE->cm->id);
3.summary: Replace add_to_log with an event trigger - mod_scorm
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/scorm (11 calls) /mod/scorm/loadSCO.php:159: add_to_log($course->id, scorm, launch, view.php?id=.$cm->id, $result, $cm->id); /mod/scorm/report.php:62: add_to_log($course->id, scorm, report, report.php?id=.$cm->id, $scorm->id, $cm->id); /mod/scorm/index.php:35: add_to_log($course->id, "scorm", "view all", "index.php?id=$course->id", ""); /mod/scorm/report/objectives/report.php:53: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/report/basic/report.php:46: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/report/interactions/report.php:47: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/userreport.php:70: add_to_log($course->id, scorm, userreport, userreport.php?id=.$cm->id, $scorm->id, $cm->id); /mod/scorm/player.php:160: add_to_log($course->id, scorm, view, "player.php?cm=$cm->id&scoid=$sco->id", "$scorm->id", $cm->id); /mod/scorm/view.php:107: add_to_log($course->id, scorm, pre-view, view.php?id=.$cm->id, "$scorm->id", $cm->id); report/userreportinteractions.php:add_to_log($course->id, scorm, userreportinteractions, userreportinteractions.php?id=.$cm->id, $scorm->id, $cm->id) report/userreporttracks.php:add_to_log($course->id, scorm, userreporttracks, userreporttracks.php?id=.$id, $scorm->id, $id);
4.summary: Replace Legacy events - Blogs
description: Replace all legacy events related to blogs. blog/locallib.php: events_trigger(blog_entry_added, $this); blog/locallib.php: events_trigger(blog_entry_edited, $entry); blog/locallib.php: events_trigger(blog_entry_deleted, $this);
5.summary: Replace add_to_log with an event trigger - User
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. /user/index.php:89: add_to_log($course->id, user, view all, index.php?id=.$course->id, ); /user/view.php:191: add_to_log($course->id, "user", "view", "view.php?id=$user->id&course=$course->id", "$user->id"); /auth/ldap/auth.php:1739: add_to_log(SITEID, user, login, "view.php?id=$USER->id&course=".SITEID, /auth/shibboleth/index.php:65: add_to_log(SITEID, user, login, "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id); /login/change_password.php:123: add_to_log($course->id, user, change password, "view.php?id=$USER->id&course=$course->id", "$USER->id");
6.summary: Replace Legacy events - Cohort
description: Replace all legacy events related to cohort. cohort/lib.php: events_trigger(cohort_added, $cohort); cohort/lib.php: events_trigger(cohort_updated, $cohort); cohort/lib.php: events_trigger(cohort_deleted, $cohort); cohort/lib.php: events_trigger(cohort_member_added, (object)array(cohortid=>$cohortid, userid=>$userid)); cohort/lib.php: events_trigger(cohort_member_removed, (object)array(cohortid=>$cohortid, userid=>$userid));
7.summary: Replace add_to_log with an event trigger - notes
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. notes /notes/index.php:64: add_to_log($courseid, notes, view, index.php?course=.$courseid.&user=.$userid, view notes); /notes/lib.php:107: add_to_log($note->courseid, notes, add, $logurl, add note); /notes/lib.php:114: add_to_log($note->courseid, notes, update, $logurl , update note); /notes/lib.php:134: add_to_log($note->courseid, notes, delete, $logurl, delete note);
8.summary: Replace add_to_log with an event trigger - mod_book
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/book (17 calls) /mod/book/show.php:67: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/show.php:68: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/tool/exportimscp/index.php:46: add_to_log($course->id, book, exportimscp, tool/exportimscp/index.php?id=.$cm->id, $book->id, $cm->id); /mod/book/tool/importhtml/locallib.php:87: add_to_log($book->course, book, add chapter, view.php?id=.$context->instanceid.&chapterid=.$chapter->id, $chapter->id, $context->instanceid); /mod/book/tool/importhtml/locallib.php:151: add_to_log($book->course, course, update mod, ../mod/book/view.php?id=.$context->instanceid, book .$book->id); /mod/book/tool/print/index.php:80: add_to_log($course->id, book, print chapter, tool/print/index.php?id=.$cm->id.&chapterid=.$chapter->id, $chapter->id, $cm->id); /mod/book/tool/print/index.php:123: add_to_log($course->id, book, print, tool/print/index.php?id=.$cm->id, $book->id, $cm->id); /mod/book/index.php:51: add_to_log($course->id, book, view all, index.php?id=.$course->id, ); /mod/book/delete.php:71: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/delete.php:72: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/edit.php:78: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/edit.php:79: add_to_log($course->id, book, update chapter, view.php?id=.$cm->id.&chapterid=.$data->id, $data->id, $cm->id); /mod/book/edit.php:104: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/edit.php:105: add_to_log($course->id, book, add chapter, view.php?id=.$cm->id.&chapterid=.$data->id, $data->id, $cm->id); /mod/book/move.php:180: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/move.php:181: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/view.php:78: add_to_log($course->id, book, view, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/view.php:113: add_to_log($course->id, book, view chapter, view.php?id=.$cm->id.&chapterid=.$chapter->id, $chapter->id, $cm->id);
9.summary: Replace Legacy events - Assessable content
description: Replace all legacy events related to Assessable content. mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/submission/file/locallib.php: events_trigger(assessable_file_uploaded, $eventdata); mod/assign/submission/onlinetext/locallib.php: events_trigger(assessable_content_uploaded, $eventdata); mod/assignment/type/online/assignment.class.php: events_trigger(assessable_content_uploaded, $eventdata); mod/assignment/type/upload/assignment.class.php: events_trigger(assessable_file_uploaded, $eventdata); mod/assignment/type/upload/assignment.class.php: events_trigger(assessable_files_done, $eventdata); mod/assignment/type/uploadsingle/assignment.class.php: events_trigger(assessable_file_uploaded, $eventdata); mod/forum/lib.php: events_trigger(assessable_content_uploaded, $eventdata); mod/workshop/submission.php: events_trigger(assessable_content_uploaded, $eventdata);
10.summary: Replace Legacy events - Completion
description: Replace all legacy events related to completion. lib/completionlib.php: events_trigger(activity_completion_changed, $data); completion/completion_completion.php: events_trigger(course_completed, $this->get_record_data());
11.summary: Replace Legacy events - Course
description: Replace all legacy events related to course. course/lib.php: events_trigger(course_created, $course); course/lib.php: events_trigger(course_updated, $course); lib/moodlelib.php: events_trigger(course_deleted, $course); lib/moodlelib.php: events_trigger(course_content_removed, $course); lib/coursecatlib.php: events_trigger(course_category_deleted, $this); lib/coursecatlib.php: events_trigger(course_category_deleted, $this); backup/util/plan/restore_plan.class.php: events_trigger(course_restored, (object) array(
12.summary: Replace Legacy events - role
description: Replace all legacy events related to role. lib/accesslib.php: events_trigger(role_assigned, $ra); lib/accesslib.php: events_trigger(role_unassigned, $ra); lib/accesslib.php: events_trigger(role_unassigned, $ra);
13.summary: Replace Legacy events - Mixed
description: Replace all legacy events related to lti,workshop. workshop_viewed lti_unknown_service_api_call Replace event handlers with event observers. mod/workshop/allocation/scheduled/db/events.php workshopallocation_scheduled_workshop_viewed Edit - quiz events moved to a separate issue. portfolio_send also moved to a separate issue.
14.summary: Replace add_to_log with an event trigger - Course
description: Replace the add_to_log calls in the following directory, with new events which contains the same information: course/ (21 calls)
15.summary: Replace add_to_log with an event trigger - completion
description: Replace the add_to_log calls in the following directories, with new events which contains the same information: Completion /course/completion.php:138: add_to_log($course->id, course, completion updated, completion.php?id=.$course->id); /report/completion/user.php:53: add_to_log($course->id, course, report completion, "report/completion/user.php?id=$user->id&course=$course->id", $course->id);
16.summary: Replace add_to_log with an event trigger - course reports
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. course / reports /report/participation/index.php:66: add_to_log($course->id, "course", "report participation", "report/participation/index.php?id=$course->id", $course->id); /report/log/index.php:118: add_to_log($course->id, "course", "report log", "report/log/index.php?id=$course->id", $course->id); /report/log/graph.php:70: add_to_log($course->id, course, report log, "report/log/graph.php?user=$user->id&id=$course->id&type=$type&date=$date", $course->id); /report/log/user.php:65: add_to_log($course->id, course, report log, "report/log/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id); /report/loglive/index.php:51: add_to_log($course->id, course, report live, "report/loglive/index.php?id=$course->id", $course->id); /report/stats/index.php:70: add_to_log($course->id, "course", "report stats", "report/stats/index.php?course=$course->id", $course->id); /report/stats/graph.php:65: add_to_log($course->id, course, report stats, "report/stats/graph.php?userid=$userid&id=$course->id&mode=$mode&roleid=$roleid", $course->id); /report/stats/user.php:52: add_to_log($course->id, course, report stats, "report/stats/user.php?id=$user->id&course=$course->id", $course->id); /report/outline/index.php:40: add_to_log($course->id, course, report outline, "report/outline/index.php?id=$course->id", $course->id); /report/outline/user.php:56: add_to_log($course->id, course, report outline, "report/outline/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id);
17.summary: Replace add_to_log with an event trigger - course
description: Replace the add_to_log calls in the following directories, with new events which contains the same information: Course /course/recent.php:41: add_to_log($course->id, "course", "recent", "recent.php?id=$course->id", $course->id); /course/delete.php:68: add_to_log(SITEID, "course", "delete", "view.php?id=$course->id", "$course->fullname (ID $course->id)"); /course/manage.php:252: add_to_log($course->id, "course", ($visible ? show : hide), "edit.php?id=$course->id", $course->id); /course/manage.php:280: add_to_log($movecourse->id, "course", "move", "edit.php?id=$movecourse->id", $movecourse->id); /course/lib.php:2041: add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id); /course/lib.php:2291: add_to_log(SITEID, course, new, view.php?id=.$course->id, $data->fullname. (ID .$course->id.)); /course/lib.php:2380: add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id); /course/user.php:108: add_to_log($course->id, "course", "user report", "user.php?id=$course->id&user=$user->id&mode=$mode", "$user->id"); /course/editsection.php:72: add_to_log($course->id, "course", "editsection", "editsection.php?id=$id", "$sectionnum"); /course/view.php:117: add_to_log($course->id, course, $loglabel, "view.php?". $logparam, $infoid); /course/loginas.php:70: add_to_log($course->id, "course", "loginas", "../user/view.php?id=$course->id&user=$userid", "$oldfullname -> $newfullname"); /index.php:79: add_to_log(SITEID, course, view, view.php?id=.SITEID, SITEID);
18.summary: Replace add_to_log with an event trigger - mod_assign
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/assign (26 calls) /mod/assign/index.php:35: add_to_log($course->id, assign, view all, index.php?id=$course->id, ); /mod/assign/locallib.php:2416: add_to_log($this->get_course()->id, investigate this function /mod/assign/locallib.php:2408: public function add_to_log($action = , $info = , $url=) And these lines: /mod/assign/feedback/offline/locallib.php:167: $this->assignment->add_to_log(grade submission, $this->assignment->format_grade_for_log($grade)); /mod/assign/feedback/offline/locallib.php:195: $this->assignment->add_to_log(save grading feedback, $logdesc); /mod/assign/locallib.php:2110: $this->add_to_log(view submission, $logmessage); /mod/assign/locallib.php:2133: $this->add_to_log(view feedback, $logmessage); /mod/assign/locallib.php:2392: $this->add_to_log(download all submissions, get_string(downloadall, assign)); /mod/assign/locallib.php:2810: $this->add_to_log(view grading form, $msg); /mod/assign/locallib.php:2846: $this->add_to_log(view, get_string(viewrevealidentitiesconfirm, assign)); /mod/assign/locallib.php:3059: $this->add_to_log(view submission grading table, $logmessage); /mod/assign/locallib.php:3146: $this->add_to_log(view submit assignment form, get_string(viewownsubmissionform, assign)); /mod/assign/locallib.php:3367: $this->add_to_log(view batch set marking workflow state, get_string(viewbatchsetmarkingworkflowstate, assign)); /mod/assign/locallib.php:3428: $this->add_to_log(view batch set marker allocation, get_string(viewbatchmarkingallocation, assign)); /mod/assign/locallib.php:3481: $this->add_to_log(view confirm submit assignment form, $logmessage); /mod/assign/locallib.php:3828: $this->add_to_log(view, get_string(viewownsubmissionstatus, assign)); /mod/assign/locallib.php:4493: $this->add_to_log(submission statement accepted, $logmessage); /mod/assign/locallib.php:4495: $this->add_to_log(submit for grading, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:4529: $this->add_to_log(grant extension, $userid); /mod/assign/locallib.php:4762: $this->add_to_log(grade submission, $this->format_grade_for_log($grade)); /mod/assign/locallib.php:4811: $this->add_to_log(reveal identities, get_string(revealidentities, assign)); /mod/assign/locallib.php:4999: $this->add_to_log(submissioncopied, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:5105: $this->add_to_log(submission statement accepted, $logmessage); /mod/assign/locallib.php:5107: $this->add_to_log(submit, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:5613: $this->add_to_log(revert submission to draft, $logmessage); /mod/assign/locallib.php:5652: $this->add_to_log(lock submission, $logmessage); /mod/assign/locallib.php:5692: $this->add_to_log(set marking workflow state, $message); /mod/assign/locallib.php:5734: $this->add_to_log(set marking allocation, $message); /mod/assign/locallib.php:5774: $this->add_to_log(unlock submission, $logmessage); /mod/assign/locallib.php:5831: $this->add_to_log(grade submission, $this->format_grade_for_log($grade));
19.summary: Replace add_to_log with an event trigger - role
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. role /admin/roles/manage.php:93: add_to_log(SITEID, role, delete, admin/roles/manage.php, $roles$roleid->localname, , $USER->id); /admin/roles/override.php:128: add_to_log($course->id, role, override, admin/roles/override.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/assign.php:114: add_to_log($course->id, role, assign, admin/roles/assign.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/assign.php:134: add_to_log($course->id, role, unassign, admin/roles/assign.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/define.php:199: add_to_log(SITEID, role, $action, admin/roles/define.php?action=view&roleid= . /admin/roles/allow.php:49: add_to_log(SITEID, role, edit allow . $mode, str_replace($CFG->wwwroot . /, , $baseurl), , , $USER->id); /lib/accesslib.php:1524: add_to_log(SITEID, role, delete, admin/roles/action=delete&roleid=.$roleid, $rolename, );
20.summary: Replace Legacy events - Groups
description: Replace all legacy events related to Groups. group/lib.php: events_trigger(groups_member_added, $eventdata); group/lib.php: events_trigger(groups_member_removed, $eventdata); group/lib.php: events_trigger(groups_group_created, $group); group/lib.php: events_trigger(groups_grouping_created, $data); group/lib.php: events_trigger(groups_group_updated, $group); group/lib.php: events_trigger(groups_grouping_updated, $data); group/lib.php: events_trigger(groups_group_deleted, $group); group/lib.php: events_trigger(groups_grouping_deleted, $grouping); Plurals: group/lib.php: events_trigger(groups_members_removed, $eventdata); group/lib.php: events_trigger(groups_groupings_groups_removed, $courseid); group/lib.php: events_trigger(groups_groups_deleted, $courseid); group/lib.php: events_trigger(groups_groupings_deleted, $courseid);
21.summary: Replace Legacy events - module
description: Replace all legacy events related to module. course/dnduploadlib.php: events_trigger(mod_created, $eventdata); course/lib.php: events_trigger(mod_deleted, $eventdata); All places where course modules are created, updated(?) or deleted.
22.summary: Replace Legacy events - User
description: Replace all legacy events related to User. admin/tool/uploaduser/index.php: events_trigger(user_updated, $existinguser); admin/tool/uploaduser/index.php: events_trigger(user_created, $user); admin/user.php: events_trigger(user_updated, $user); admin/user.php: events_trigger(user_updated, $user); auth/email/auth.php: events_trigger(user_created, $user); auth/ldap/auth.php: events_trigger(user_created, $user); lib/enrollib.php: events_trigger(user_enrolled, $ue); lib/enrollib.php: events_trigger(user_enrol_modified, $ue); lib/enrollib.php: events_trigger(user_enrol_modified, $ue); lib/enrollib.php: events_trigger(user_unenrolled, $ue); lib/enrollib.php: events_trigger(user_unenrolled, $ue); lib/eventslib.php:function events_trigger($eventname, $eventdata) lib/moodlelib.php: events_trigger(user_logout, $params); lib/moodlelib.php: events_trigger(user_created, $DB->get_record(user, array(id=>$user->id))); lib/moodlelib.php: events_trigger(user_updated, $DB->get_record(user, array(id=>$oldinfo->id))); lib/moodlelib.php: events_trigger(user_deleted, $user); enrol/manual/locallib.php: events_trigger(user_enrol_modified, $enrolment); user/edit.php: events_trigger(user_updated, $usernew); user/editadvanced.php: events_trigger(user_created, $usernew); user/editadvanced.php: events_trigger(user_updated, $usernew); user/emailupdate.php: events_trigger(user_updated, $user); user/lib.php: events_trigger(user_created, $newuser); user/lib.php: events_trigger(user_updated, $updateduser); Please also check user/lib.php user_update_users() from (if it has been integrated) events_trigger(user_updated, $user);
23.summary: Replace add_to_log with an event trigger - mod_page
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/page /mod/page/index.php:36:add_to_log($course->id, page, view all, "index.php?id=$course->id", ); /mod/page/view.php:54:add_to_log($course->id, page, view, view.php?id=.$cm->id, $page->id, $cm->id);
24.summary: Replace add_to_log with an event trigger - mod_feedback
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/feedback (6 calls) /mod/feedback/complete_guest.php:213: add_to_log($course->id,feedback, startcomplete, view.php?id=.$cm->id, $feedback->id); /mod/feedback/index.php:43: add_to_log($course->id, feedback, view all, $url->out(false), $course->id); /mod/feedback/delete_completed.php:79: add_to_log($course->id, feedback, delete, view.php?id=.$cm->id, $feedback->id, $cm->id); /mod/feedback/complete.php:269: add_to_log($course->id, feedback, submit, view.php?id=.$cm->id, $feedback->id, $cm->id, $userid); /mod/feedback/complete.php:213: add_to_log($course->id, feedback, startcomplete, view.php?id=.$cm->id, $feedback->id, $cm->id, $userid); /mod/feedback/view.php:100: add_to_log($course->id, feedback, view, view.php?id=.$cm->id, $feedback->id, $cm->id);
25.summary: Replace add_to_log with an event trigger - mod_chat
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/chat (6 calls) /mod/chat/chat_ajax.php:94: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/report.php:50: add_to_log($course->id, chat, report, "report.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/index.php:17: add_to_log($course->id, chat, view all, "index.php?id=$course->id", ); /mod/chat/gui_header_js/insert.php:61: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/gui_basic/index.php:108: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/view.php:73: add_to_log($course->id, chat, view, "view.php?id=$cm->id", $chat->id, $cm->id);
26.summary: Replace add_to_log with an event trigger - mod_choice
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/choice (5 calls) /mod/choice/report.php:46: add_to_log($course->id, "choice", "report", "report.php?id=$cm->id", "$choice->id",$cm->id); /mod/choice/index.php:17: add_to_log($course->id, "choice", "view all", "index.php?id=$course->id", ""); /mod/choice/lib.php:296: add_to_log($course->id, "choice", "choose again", "view.php?id=$cm->id", $choice->id, $cm->id); /mod/choice/lib.php:310: add_to_log($course->id, "choice", "choose", "view.php?id=$cm->id", $choice->id, $cm->id); /mod/choice/view.php:79: add_to_log($course->id, "choice", "view", "view.php?id=$cm->id", $choice->id, $cm->id);
27.summary: Replace add_to_log with an event trigger - webservices
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. webservices /webservice/lib.php:74: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(invalidtimedtoken, webservice), 0); /webservice/lib.php:81: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice) . ": " . getremoteaddr(), 0); /webservice/lib.php:145: add_to_log(SITEID, webservice, user unconfirmed, , $user->username); /webservice/lib.php:151: add_to_log(SITEID, webservice, user suspended, , $user->username); /webservice/lib.php:157: add_to_log(SITEID, webservice, nologin auth attempt with web service, , $user->username); /webservice/lib.php:166: add_to_log(SITEID, webservice, expired password, , $user->username); /webservice/lib.php:850: add_to_log(SITEID, webservice, get_string(simpleauthlog, webservice), , get_string(failedtolog, webservice).": ".$this->username."/".$this->password." - ".getremoteaddr() , 0); /webservice/lib.php:870: add_to_log(SITEID, , , , get_string(wsaccessuserdeleted, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:876: add_to_log(SITEID, , , , get_string(wsaccessuserunconfirmed, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:882: add_to_log(SITEID, , , , get_string(wsaccessusersuspended, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:895: add_to_log(SITEID, , , , get_string(wsaccessuserexpired, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:902: add_to_log(SITEID, , , , get_string(wsaccessusernologin, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:929: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice).": ".$this->token. " - ".getremoteaddr() , 0); /webservice/lib.php:947: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice).": ".getremoteaddr() , 0); /webservice/lib.php:1061: add_to_log(SITEID, webservice, , , $this->zend_class." ".getremoteaddr() , 0, $this->userid); /webservice/lib.php:1522: add_to_log(SITEID, webservice, $this->functionname, , getremoteaddr() , 0, $this->userid); /admin/webservice/service.php:61: add_to_log(SITEID, webservice, delete, $returnurl, get_string(deleteservice, webservice, $service)); /admin/webservice/service.php:78: add_to_log(SITEID, webservice, add, $returnurl, get_string(addservice, webservice, $servicedata)); /admin/webservice/service.php:88: add_to_log(SITEID, webservice, edit, $returnurl, get_string(editservice, webservice, $servicedata)); /admin/webservice/service_users.php:60: add_to_log(SITEID, core, assign, $CFG->admin . /webservice/service_users.php?id= /admin/webservice/service_users.php:74: add_to_log(SITEID, core, assign, $CFG->admin . /webservice/service_users.php?id= webservice (login) /login/token.php:164: add_to_log(SITEID, webservice, automatically create user token, , User ID: . $user->id); /login/token.php:174: add_to_log(SITEID, webservice, sending requested user token, , User ID: . $user->id);
28.summary: Replace add_to_log with an event trigger - Blog
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. blog/ (6 calls) /blog/index.php:227: add_to_log($courseid, blog, view, index.php?entryid=.$entryid.&tagid=. view blog entry); /blog/locallib.php:262: add_to_log(SITEID, blog, add, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject); /blog/locallib.php:299: add_to_log(SITEID, blog, update, index.php?userid=.$USER->id.&entryid=.$entry->id, $entry->subject); /blog/locallib.php:317: add_to_log(SITEID, blog, delete, index.php?userid=. $this->userid, deleted blog entry with entry id . $this->id); /blog/locallib.php:356: add_to_log($courseid, blog, $action, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject); /blog/locallib.php:360: add_to_log($cm->course, blog, $action, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject, $cm->id, $this->userid);
29.summary: Replace add_to_log with an event trigger - misc
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. lib /lib/uploadlib.php:772: add_to_log($courseid, upload, upload, ((!$nourl) ? substr($_SERVERHTTP_REFERER, 0, 100) : ), $newfilepath); /lib/uploadlib.php:786: add_to_log(0, upload, infected, $_SERVERHTTP_REFERER, $oldfilepath, 0, $userid); /lib/moodlelib.php:5791: add_to_log(SITEID, library, mailer, qualified_me(), ERROR: . $mail->ErrorInfo); mnet /mnet/lib.php:446: add_to_log(SITEID, admin/mnet, update, admin/mnet/access_control.php, /mnet/lib.php:455: add_to_log(SITEID, admin/mnet, add, admin/mnet/access_control.php, report /report/questioninstances/index.php:38: add_to_log(SITEID, "admin", "report questioninstances", "report/questioninstances/index.php?qtype=$requestedqtype", $requestedqtype); admin/tool /admin/tool/capability/index.php:95: add_to_log(SITEID, "admin", "tool capability", "tool/capability/index.php", count($capabilities));
30.summary: Replace add_to_log with an event trigger - mod_assignment
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/assignment (17 calls) /mod/assignment/index.php:16: add_to_log($course->id, "assignment", "view all", "index.php?id=$course->id", ""); /mod/assignment/type/uploadsingle/assignment.class.php:68: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/uploadsingle/assignment.class.php:239: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:49: add_to_log($this->course->id, assignment, view, "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:449: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:515: add_to_log($this->course->id, assignment, upload, /mod/assignment/type/upload/assignment.class.php:636: add_to_log($this->course->id, assignment, upload, //TODO: add finalize action to log /mod/assignment/type/upload/assignment.class.php:676: add_to_log($this->course->id, assignment, upload, //TODO: add finalize action to log /mod/assignment/type/upload/assignment.class.php:704: add_to_log($this->course->id, assignment, view submission, submissions.php?id=.$this->cm->id.&userid=.$userid.&mode=.$mode.&offset=.$offset, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:820: add_to_log($this->course->id, assignment, upload, //TODO: add delete action to log /mod/assignment/type/online/assignment.class.php:78: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/online/assignment.class.php:86: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/offline/assignment.class.php:96: add_to_log($this->course->id, assignment, update grades, /mod/assignment/lib.php:159: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", /mod/assignment/lib.php:777: add_to_log($this->course->id, assignment, update grades, /mod/assignment/lib.php:1248: add_to_log($course->id, assignment, view submission, submissions.php?id=.$this->cm->id, $this->assignment->id, $this->cm->id); /mod/assignment/lib.php:1795: add_to_log($this->course->id, assignment, update grades,
31.summary: Replace add_to_log with an event trigger - mod_wiki
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/wiki (17 calls) /mod/wiki/overridelocks.php:80: add_to_log($course->id, "wiki", "overridelocks", "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/restoreversion.php:78: add_to_log($course->id, "wiki", "restore", "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/history.php:64: add_to_log($course->id, wiki, history, "history.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/admin.php:62: add_to_log($course->id, "wiki", "admin", "admin.php?pageid=".$page->id, $page->id, $cm->id); /mod/wiki/map.php:61: add_to_log($course->id, "wiki", "map", "map.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/index.php:48: add_to_log($course->id, wiki, view, "index.php?id=".$id, ""); /mod/wiki/diff.php:76: add_to_log($course->id, "wiki", "diff", "diff.php?pageid=".$pageid."&comparewith=".$comparewith."&compare=".$compare, $pageid, $cm->id); /mod/wiki/create.php:110: add_to_log($course->id, wiki, add page, "view.php?pageid=".$newpageid, $newpageid, $cm->id); /mod/wiki/create.php:117: add_to_log($course->id, wiki, add page, "view.php?pageid=".$newpageid, $newpageid, $cm->id); /mod/wiki/edit.php:88: add_to_log($course->id, wiki, edit, "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/viewversion.php:68: add_to_log($course->id, "wiki", "history", "viewversion.php?pageid=".$pageid."&versionid=".$versionid, $pageid, $cm->id); /mod/wiki/instancecomments.php:102: add_to_log($course->id, wiki, comment, "comments.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/view.php:292: add_to_log($course->id, wiki, view, "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/view.php:294: add_to_log($course->id, wiki, view, "view.php?id=".$id, $id, $cm->id); /mod/wiki/view.php:296: add_to_log($course->id, wiki, view, "view.php?wid=".$wid."&title=".$title, $wid, $cm->id); /mod/wiki/prettyview.php:62: add_to_log($course->id, "wiki", "view", "prettyview.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/comments.php:62: add_to_log($course->id, wiki, comments, "comments.php?pageid=".$pageid, $pageid, $cm->id);
32.summary: Replace add_to_log with an event trigger - mod_quiz
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/quiz (14 calls) /mod/quiz/processattempt.php:164: add_to_log($attemptobj->get_courseid(), quiz, close attempt, /mod/quiz/overridedelete.php:66: add_to_log($cm->course, quiz, delete override, /mod/quiz/attempt.php:98: add_to_log($attemptobj->get_courseid(), quiz, continue attempt, /mod/quiz/report.php:86: add_to_log($course->id, quiz, report, report.php?id= . $cm->id . &mode= . $mode, /mod/quiz/index.php:39: add_to_log($course->id, "quiz", "view all", "index.php?id=$course->id", ""); /mod/quiz/report/attemptsreport.php:321: add_to_log($quiz->course, quiz, delete attempt, report.php?id= . $cm->id, /mod/quiz/edit.php:158: add_to_log($cm->course, quiz, editquestions, /mod/quiz/comment.php:47: add_to_log($attemptobj->get_courseid(), quiz, manualgrade, comment.php?attempt= . /mod/quiz/locallib.php:271: add_to_log($quizobj->get_courseid(), quiz, preview, view.php?id=.$quizobj->get_cmid(), /mod/quiz/locallib.php:274: add_to_log($quizobj->get_courseid(), quiz, attempt, review.php?attempt=.$attempt->id, /mod/quiz/overrideedit.php:175: add_to_log($cm->course, quiz, edit override, /mod/quiz/addrandom.php:93: add_to_log($quiz->course, quiz, addcategory, /mod/quiz/view.php:73: add_to_log($course->id, quiz, view, view.php?id= . $cm->id, $quiz->id, $cm->id); /mod/quiz/review.php:89: add_to_log($attemptobj->get_courseid(), quiz, review, review.php?attempt= . /mod/quiz/summary.php:81: add_to_log($attemptobj->get_courseid(), quiz, view summary,
33.summary: Replace add_to_log with an event trigger - mod_glossary
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/glossary (13 calls) /mod/glossary/deleteentry.php:116: add_to_log($course->id, "glossary", "delete entry", "view.php?id=$cm->id&mode=$prevmode&hook=$hook", $entry->id,$cm->id); /mod/glossary/index.php:23: add_to_log($course->id, "glossary", "view all", "index.php?id=$course->id", ""); /mod/glossary/import.php:168: add_to_log($course->id, "course", "add mod", /mod/glossary/import.php:171: add_to_log($course->id, $mod->modulename, "add", /mod/glossary/showentry.php:64: add_to_log($entry->courseid, glossary, view entry, "showentry.php?eid=$entry->id", $entry->id, $entry->cmid); /mod/glossary/showentry_ajax.php:80: add_to_log($entry->courseid, glossary, view entry, "showentry.php?eid=$entry->id", $entry->id, $entry->cmid); /mod/glossary/edit.php:129: add_to_log($course->id, "glossary", "add entry", /mod/glossary/edit.php:135: add_to_log($course->id, "glossary", "update entry", /mod/glossary/editcategories.php:106: add_to_log($course->id, "glossary", "edit category", "editcategories.php?id=$cm->id", $hook,$cm->id); /mod/glossary/editcategories.php:127: add_to_log($course->id, "glossary", "delete category", "editcategories.php?id=$cm->id", $hook,$cm->id); /mod/glossary/editcategories.php:191: add_to_log($course->id, "glossary", "add category", "editcategories.php?id=$cm->id", $cat->id,$cm->id); /mod/glossary/approve.php:37: add_to_log($course->id, "glossary", "approve entry", "showentry.php?id=$cm->id&eid=$eid", "$eid", $cm->id); /mod/glossary/view.php:127: add_to_log($course->id, "glossary", "view", "view.php?id=$cm->id&tab=$tab", $glossary->id, $cm->id);
34.summary: Replace add_to_log with an event trigger - grade
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. grade ./grade/report/grader/ajax_callbacks.php:127: add_to_log($course->id, grade, update, $url, $info); ./grade/report/grader/lib.php:309: add_to_log($this->course->id, grade, update, $url, $info); ./grade/edit/tree/grade.php:212: add_to_log($course->id, grade, update, $url, $info); ./grade/edit/tree/grade.php:239: add_to_log($course->id, grade, update, $url, $info);
35.summary: Replace add_to_log with an event trigger - message
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. message /message/index.php:134: add_to_log(SITEID, message, add contact, index.php?user1=.$addcontact.&user2=.$USER->id, $addcontact); /message/index.php:139: add_to_log(SITEID, message, remove contact, index.php?user1=.$removecontact.&user2=.$USER->id, $removecontact); /message/index.php:143: add_to_log(SITEID, message, block contact, index.php?user1=.$blockcontact.&user2=.$USER->id, $blockcontact); /message/index.php:147: add_to_log(SITEID, message, unblock contact, index.php?user1=.$unblockcontact.&user2=.$USER->id, $unblockcontact); /message/index.php:184: add_to_log(SITEID, message, write, index.php?user=.$user1->id.&id=.$user2->id.&history=1m.$messageid, $user1->id); /message/lib.php:132: add_to_log(SITEID, message, view, index.php, $viewing);
36.summary: Grade update event
description: Multiple activities make updates to the grading table, there should be a generic event, or a class or something we can use for these situations instead of creating multiple events that do the same thing. See on why this is needed.
37.summary: Legacy events and addtolog() Cleanup
description: Make sure there is no remaining addtolog() calls in core, or agree on whether they should be deprecated but kept for a while or not. -Make sure there is no legacy events left in core.- see -Make sure all new events use the correct naming convention.- see -Create a mapping list, listing all old events/addtolog() and respective new event. Add this list to docs.- See -Cleanup lib/db/events.php, either delete all events listing or add all new events to the list.- see once is resolved, make sure all existing events have the legacyassertions when needed. -implement can_view() for all events.- see
38.summary: Cleanup and fixup of the events/logging docs
description: While looking at the Events doc, I noticed some inconsistencies. For example:- The pattern of names for new names of the events seems wrong. The relationship column doesnt make any sense imo and also now since we have those new events, we should provide an exact mapping. On detail evaluation am sure, many other inconsistencies would be found. We need to revalute this doc and fixup any incorrect data.
39.summary: Remove remaining uses of content_viewed, and deprecate it
description: We still have uses of content_viewed in core. It was decided to remove this from core because:- There is no educational value in this event. It doesnt contain enough information of what actually happened. If some of the viewed events can be grouped together, they should have their own abstract parent. ex- course_module_viewed we must not store localised strings in events we should not store urls in other array - we have get_url() instead !!!
40.summary: use restore and ws origin in logged events
description: . Current problem Problem is that we cannot just falsify log history by injecting log records from the restore file, events must be always triggered and we need to know where are the courses coming from, that means the restore process needs to log everything that is happening during restore. import (=== backup+restore) of activities should not try to restore any logs restore from different site cannot create log entries with non-existent users duplication of course (restore into new course) may bork stats statistics should probably ignore the events coming from restore completely . Possible solutions . A/ use events 1/ trigger \core\event\restore_started and \core\event\restore_finished events (this might be useful in any case) 2/ log writers would watch for these and start adding restore origin when writing events to storage during the restore process . B/ new $PAGE->get_request_origin() The idea is to have one method that tells you if you are doing something from normal page, ws, cli, restore. The restore code would use some private API to tell PAGE that restore starts/end or it could even use 1/, but that would require a new observer which does not seem optimal to me. At the same time we could add $PAGE->get_request_ip(). After A/ or B/ is implemented we could filter out logs coming from the restore process in stats and other areas where we want to ignore the events triggered during restore. The next step would be to optionally restore the original log data - we would need backup/restore support in log stores and new method in base event class which would have to be overridden by events that can recalculate the ids.
41.summary: Replace add_to_log with an event trigger - tag
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. tag /tag/coursetagslib.php:304: add_to_log($courseid, coursetags, add, $url, Course tagged); /tag/edit.php:138: add_to_log($COURSE->id, tag, update, index.php?id=. $tag->id, $tag->name . ->. $tagnew->name); /tag/edit.php:141: add_to_log($COURSE->id, tag, update, index.php?id=. $tag->id, $tag->name); /tag/user.php:50: add_to_log(SITEID, tag, flag, index.php?id=. $tagid, $tagid, , $USER->id); Suggested additional events tag deleted
42.summary: Replace add_to_log with an event trigger - mod_forum
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/forum (24 calls) /mod/forum/discuss.php:95: add_to_log($course->id, forum, move discussion, "discuss.php?d=$discussion->id", $discussion->id, $cmto->id); /mod/forum/discuss.php:107: add_to_log($course->id, forum, view discussion, "discuss.php?d=$discussion->id", $discussion->id, $cm->id); /mod/forum/subscribe.php:152: add_to_log($course->id, "forum", "unsubscribe", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/subscribe.php:177: add_to_log($course->id, "forum", "subscribe", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/markposts.php:85: add_to_log($course->id, "discussion", "mark read", "view.php?f=$forum->id", $d, $cm->id); /mod/forum/markposts.php:96: add_to_log($course->id, "forum", "mark read", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/markposts.php:103: // add_to_log($course->id, "forum", "mark unread", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/index.php:54: add_to_log($course->id, forum, view forums, "index.php?id=$course->id"); /mod/forum/index.php:183: add_to_log($course->id, forum, subscribeall, "index.php?id=$course->id", $course->id); /mod/forum/index.php:186: add_to_log($course->id, forum, unsubscribeall, "index.php?id=$course->id", $course->id); /mod/forum/settracking.php:63: add_to_log($course->id, "forum", "stop tracking", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/settracking.php:71: add_to_log($course->id, "forum", "start tracking", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/lib.php:742: add_to_log($course->id, forum, mail error, "discuss.php?d=$discussion->idp$post->id", /mod/forum/lib.php:1040: add_to_log($course->id, forum, mail digest error, , , $cm->id, $userto->id); /mod/forum/user.php:65: add_to_log(($isspecificcourse)?$courseid:SITEID, "forum", "user report", user.php?.$url->get_query_string(), $userid); /mod/forum/post.php:336: add_to_log($discussion->course, "forum", "delete discussion", /mod/forum/post.php:353: add_to_log($discussion->course, "forum", "delete post", $discussionurl, "$post->id", $cm->id); /mod/forum/post.php:454: add_to_log($discussion->course, "forum", "prune post", /mod/forum/post.php:682: add_to_log($course->id, "forum", "update post", /mod/forum/post.php:725: add_to_log($course->id, "forum", "add post", /mod/forum/post.php:772: add_to_log($course->id, "forum", "add discussion", /mod/forum/subscribers.php:57: add_to_log($course->id, "forum", "view subscribers", "subscribers.php?id=$forum->id", $forum->id, $cm->id); /mod/forum/view.php:131: add_to_log($course->id, "forum", "view forum", "view.php?id=$cm->id", "$forum->id", $cm->id); /mod/forum/view.php:133: add_to_log($course->id, "forum", "view forum", "view.php?f=$forum->id", "$forum->id"); /mod/forum/search.php:115: add_to_log($course->id, "forum", "search", "search.php?id=$course->id&search=".urlencode($search), $search);
43.summary: Replace existing add_to_log calls for mod_assign
description: Replace the existing add_to_log calls for mod_assign.
44.summary: Replace add_to_log call for page viewed in /report/completion/user.php
description: /report/completion/user.php:53: add_to_log($course->id, course, report completion, "report/completion/user.php?id=$user->id&course=$course->id", $course->id);
45.summary: Create page viewed event for course
description: /course/user.php:108: add_to_log($course->id, "course", "user report", "user.php?id=$course->id&user=$user->id&mode=$mode", "$user->id"); /course/view.php:117: add_to_log($course->id, course, $loglabel, "view.php?". $logparam, $infoid); /index.php:79: add_to_log(SITEID, course, view, view.php?id=.SITEID, SITEID);
46.summary: Replace add_to_log in mod_workshop (part 2)
description: Unfinished after : code $git grep add_to_log mod/workshop/locallib.php: call_user_func_array(add_to_log, $args); code
47.summary: Tool to list all events
description: As events are being added and updated, it is very hard to find which events are available and what data they store. We need a tool that is useful for two main user groups: for analysts/researchers, to understand what data may be found in our logs for developers, to understand what events are available to use The tool should: Generate a list of all events in core Include high-level descriptions of the event List as much as possible about the payload data in the event Filter/search by verb/module etc. List the observers that are consuming those events.
48.summary: Proposed Events Verbs
description: Here are 4 verbs that I feel are both useful enough, and generic enough, to be on the core verb list. started bq. Marking when something that occurs across time starts. Could apply to a quiz attempt, a chat session, a group meeting, etc. ended bq. The ending that corresponds to started. joined bq. Used to represent a person entering a synchronous group event, such as a chat. hosted bq. For synchronous group events, such as a chat or meeting, represents the person who controls the event entering. Depending on the particular context it is used in, could be a teaching or participating type 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: META: New event system - stage 2
description: New event system - stage 2
### Response:
1.summary: Replace add_to_log with an event trigger - mod_data
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/data (9 calls) /mod/data/templates.php:76: add_to_log($course->id, data, templates view, "templates.php?id=$cm->id&d=$data->id", $data->id, $cm->id); /mod/data/templates.php:141: add_to_log($course->id, data, templates saved, "templates.php?id=$cm->id&d=$data->id", $data->id, $cm->id); /mod/data/index.php:42: add_to_log($course->id, "data", "view all", "index.php?id=$course->id", ""); /mod/data/field.php:124: add_to_log($course->id, data, fields add, /mod/data/field.php:166: add_to_log($course->id, data, fields update, /mod/data/field.php:197: add_to_log($course->id, data, fields delete, /mod/data/edit.php:189: add_to_log($course->id, data, update, "view.php?d=$data->id&rid=$rid", $data->id, $cm->id); /mod/data/edit.php:239: add_to_log($course->id, data, add, "view.php?d=$data->id&rid=$recordid", $data->id, $cm->id); /mod/data/view.php:255: add_to_log($course->id, data, view, "view.php?id=$cm->id", $data->id, $cm->id); /mod/data/view.php:377: add_to_log($course->id, data, record delete, "view.php?id=$cm->id", $data->id, $cm->id); Please also check /mod/data/lib.php data_delete_record() add_to_log call (if is integrated) add_to_log($courseid, data, record delete, "view.php?id=$cmid", $data->id, $cmid);
2.summary: Replace add_to_log with an event trigger - mod_lesson
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/lesson (9 calls) /mod/lesson/index.php:42: add_to_log($course->id, "lesson", "view all", "index.php?id=$course->id", ""); /mod/lesson/essay.php:133: add_to_log($course->id, lesson, update grade, "essay.php?id=$cm->id", $lesson->name, $cm->id); /mod/lesson/essay.php:247: add_to_log($course->id, lesson, update email essay grade, "essay.php?id=$cm->id", format_string($pages$attempt->pageid->title,true).: .fullname($users$attempt->userid), $cm->id); /mod/lesson/essay.php:303: add_to_log($course->id, lesson, view grade, "essay.php?id=$cm->id", get_string(manualgrading, lesson), $cm->id); /mod/lesson/highscores.php:149: add_to_log($course->id, lesson, update highscores, "highscores.php?id=$cm->id", $name, $cm->id); /mod/lesson/highscores.php:160: add_to_log($course->id, lesson, view highscores, "highscores.php?id=$cm->id", $lesson->name, $cm->id); /mod/lesson/view.php:182: add_to_log($course->id, lesson, start, view.php?id=. $cm->id, $lesson->id, $cm->id); /mod/lesson/view.php:286: add_to_log($PAGE->course->id, lesson, view, view.php?id=. $PAGE->cm->id, $page->id, $PAGE->cm->id); /mod/lesson/view.php:417: add_to_log($course->id, "lesson", "end", "view.php?id=".$PAGE->cm->id, "$lesson->id", $PAGE->cm->id);
3.summary: Replace add_to_log with an event trigger - mod_scorm
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/scorm (11 calls) /mod/scorm/loadSCO.php:159: add_to_log($course->id, scorm, launch, view.php?id=.$cm->id, $result, $cm->id); /mod/scorm/report.php:62: add_to_log($course->id, scorm, report, report.php?id=.$cm->id, $scorm->id, $cm->id); /mod/scorm/index.php:35: add_to_log($course->id, "scorm", "view all", "index.php?id=$course->id", ""); /mod/scorm/report/objectives/report.php:53: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/report/basic/report.php:46: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/report/interactions/report.php:47: add_to_log($course->id, scorm, delete attempts, report.php?id= . $cm->id, implode(",", $attemptids), $cm->id); /mod/scorm/userreport.php:70: add_to_log($course->id, scorm, userreport, userreport.php?id=.$cm->id, $scorm->id, $cm->id); /mod/scorm/player.php:160: add_to_log($course->id, scorm, view, "player.php?cm=$cm->id&scoid=$sco->id", "$scorm->id", $cm->id); /mod/scorm/view.php:107: add_to_log($course->id, scorm, pre-view, view.php?id=.$cm->id, "$scorm->id", $cm->id); report/userreportinteractions.php:add_to_log($course->id, scorm, userreportinteractions, userreportinteractions.php?id=.$cm->id, $scorm->id, $cm->id) report/userreporttracks.php:add_to_log($course->id, scorm, userreporttracks, userreporttracks.php?id=.$id, $scorm->id, $id);
4.summary: Replace Legacy events - Blogs
description: Replace all legacy events related to blogs. blog/locallib.php: events_trigger(blog_entry_added, $this); blog/locallib.php: events_trigger(blog_entry_edited, $entry); blog/locallib.php: events_trigger(blog_entry_deleted, $this);
5.summary: Replace add_to_log with an event trigger - User
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. /user/index.php:89: add_to_log($course->id, user, view all, index.php?id=.$course->id, ); /user/view.php:191: add_to_log($course->id, "user", "view", "view.php?id=$user->id&course=$course->id", "$user->id"); /auth/ldap/auth.php:1739: add_to_log(SITEID, user, login, "view.php?id=$USER->id&course=".SITEID, /auth/shibboleth/index.php:65: add_to_log(SITEID, user, login, "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id); /login/change_password.php:123: add_to_log($course->id, user, change password, "view.php?id=$USER->id&course=$course->id", "$USER->id");
6.summary: Replace Legacy events - Cohort
description: Replace all legacy events related to cohort. cohort/lib.php: events_trigger(cohort_added, $cohort); cohort/lib.php: events_trigger(cohort_updated, $cohort); cohort/lib.php: events_trigger(cohort_deleted, $cohort); cohort/lib.php: events_trigger(cohort_member_added, (object)array(cohortid=>$cohortid, userid=>$userid)); cohort/lib.php: events_trigger(cohort_member_removed, (object)array(cohortid=>$cohortid, userid=>$userid));
7.summary: Replace add_to_log with an event trigger - notes
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. notes /notes/index.php:64: add_to_log($courseid, notes, view, index.php?course=.$courseid.&user=.$userid, view notes); /notes/lib.php:107: add_to_log($note->courseid, notes, add, $logurl, add note); /notes/lib.php:114: add_to_log($note->courseid, notes, update, $logurl , update note); /notes/lib.php:134: add_to_log($note->courseid, notes, delete, $logurl, delete note);
8.summary: Replace add_to_log with an event trigger - mod_book
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/book (17 calls) /mod/book/show.php:67: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/show.php:68: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/tool/exportimscp/index.php:46: add_to_log($course->id, book, exportimscp, tool/exportimscp/index.php?id=.$cm->id, $book->id, $cm->id); /mod/book/tool/importhtml/locallib.php:87: add_to_log($book->course, book, add chapter, view.php?id=.$context->instanceid.&chapterid=.$chapter->id, $chapter->id, $context->instanceid); /mod/book/tool/importhtml/locallib.php:151: add_to_log($book->course, course, update mod, ../mod/book/view.php?id=.$context->instanceid, book .$book->id); /mod/book/tool/print/index.php:80: add_to_log($course->id, book, print chapter, tool/print/index.php?id=.$cm->id.&chapterid=.$chapter->id, $chapter->id, $cm->id); /mod/book/tool/print/index.php:123: add_to_log($course->id, book, print, tool/print/index.php?id=.$cm->id, $book->id, $cm->id); /mod/book/index.php:51: add_to_log($course->id, book, view all, index.php?id=.$course->id, ); /mod/book/delete.php:71: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/delete.php:72: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/edit.php:78: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/edit.php:79: add_to_log($course->id, book, update chapter, view.php?id=.$cm->id.&chapterid=.$data->id, $data->id, $cm->id); /mod/book/edit.php:104: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/edit.php:105: add_to_log($course->id, book, add chapter, view.php?id=.$cm->id.&chapterid=.$data->id, $data->id, $cm->id); /mod/book/move.php:180: add_to_log($course->id, course, update mod, ../mod/book/view.php?id=.$cm->id, book .$book->id); /mod/book/move.php:181: add_to_log($course->id, book, update, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/view.php:78: add_to_log($course->id, book, view, view.php?id=.$cm->id, $book->id, $cm->id); /mod/book/view.php:113: add_to_log($course->id, book, view chapter, view.php?id=.$cm->id.&chapterid=.$chapter->id, $chapter->id, $cm->id);
9.summary: Replace Legacy events - Assessable content
description: Replace all legacy events related to Assessable content. mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/locallib.php: events_trigger(assessable_submitted, $eventdata); mod/assign/submission/file/locallib.php: events_trigger(assessable_file_uploaded, $eventdata); mod/assign/submission/onlinetext/locallib.php: events_trigger(assessable_content_uploaded, $eventdata); mod/assignment/type/online/assignment.class.php: events_trigger(assessable_content_uploaded, $eventdata); mod/assignment/type/upload/assignment.class.php: events_trigger(assessable_file_uploaded, $eventdata); mod/assignment/type/upload/assignment.class.php: events_trigger(assessable_files_done, $eventdata); mod/assignment/type/uploadsingle/assignment.class.php: events_trigger(assessable_file_uploaded, $eventdata); mod/forum/lib.php: events_trigger(assessable_content_uploaded, $eventdata); mod/workshop/submission.php: events_trigger(assessable_content_uploaded, $eventdata);
10.summary: Replace Legacy events - Completion
description: Replace all legacy events related to completion. lib/completionlib.php: events_trigger(activity_completion_changed, $data); completion/completion_completion.php: events_trigger(course_completed, $this->get_record_data());
11.summary: Replace Legacy events - Course
description: Replace all legacy events related to course. course/lib.php: events_trigger(course_created, $course); course/lib.php: events_trigger(course_updated, $course); lib/moodlelib.php: events_trigger(course_deleted, $course); lib/moodlelib.php: events_trigger(course_content_removed, $course); lib/coursecatlib.php: events_trigger(course_category_deleted, $this); lib/coursecatlib.php: events_trigger(course_category_deleted, $this); backup/util/plan/restore_plan.class.php: events_trigger(course_restored, (object) array(
12.summary: Replace Legacy events - role
description: Replace all legacy events related to role. lib/accesslib.php: events_trigger(role_assigned, $ra); lib/accesslib.php: events_trigger(role_unassigned, $ra); lib/accesslib.php: events_trigger(role_unassigned, $ra);
13.summary: Replace Legacy events - Mixed
description: Replace all legacy events related to lti,workshop. workshop_viewed lti_unknown_service_api_call Replace event handlers with event observers. mod/workshop/allocation/scheduled/db/events.php workshopallocation_scheduled_workshop_viewed Edit - quiz events moved to a separate issue. portfolio_send also moved to a separate issue.
14.summary: Replace add_to_log with an event trigger - Course
description: Replace the add_to_log calls in the following directory, with new events which contains the same information: course/ (21 calls)
15.summary: Replace add_to_log with an event trigger - completion
description: Replace the add_to_log calls in the following directories, with new events which contains the same information: Completion /course/completion.php:138: add_to_log($course->id, course, completion updated, completion.php?id=.$course->id); /report/completion/user.php:53: add_to_log($course->id, course, report completion, "report/completion/user.php?id=$user->id&course=$course->id", $course->id);
16.summary: Replace add_to_log with an event trigger - course reports
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. course / reports /report/participation/index.php:66: add_to_log($course->id, "course", "report participation", "report/participation/index.php?id=$course->id", $course->id); /report/log/index.php:118: add_to_log($course->id, "course", "report log", "report/log/index.php?id=$course->id", $course->id); /report/log/graph.php:70: add_to_log($course->id, course, report log, "report/log/graph.php?user=$user->id&id=$course->id&type=$type&date=$date", $course->id); /report/log/user.php:65: add_to_log($course->id, course, report log, "report/log/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id); /report/loglive/index.php:51: add_to_log($course->id, course, report live, "report/loglive/index.php?id=$course->id", $course->id); /report/stats/index.php:70: add_to_log($course->id, "course", "report stats", "report/stats/index.php?course=$course->id", $course->id); /report/stats/graph.php:65: add_to_log($course->id, course, report stats, "report/stats/graph.php?userid=$userid&id=$course->id&mode=$mode&roleid=$roleid", $course->id); /report/stats/user.php:52: add_to_log($course->id, course, report stats, "report/stats/user.php?id=$user->id&course=$course->id", $course->id); /report/outline/index.php:40: add_to_log($course->id, course, report outline, "report/outline/index.php?id=$course->id", $course->id); /report/outline/user.php:56: add_to_log($course->id, course, report outline, "report/outline/user.php?id=$user->id&course=$course->id&mode=$mode", $course->id);
17.summary: Replace add_to_log with an event trigger - course
description: Replace the add_to_log calls in the following directories, with new events which contains the same information: Course /course/recent.php:41: add_to_log($course->id, "course", "recent", "recent.php?id=$course->id", $course->id); /course/delete.php:68: add_to_log(SITEID, "course", "delete", "view.php?id=$course->id", "$course->fullname (ID $course->id)"); /course/manage.php:252: add_to_log($course->id, "course", ($visible ? show : hide), "edit.php?id=$course->id", $course->id); /course/manage.php:280: add_to_log($movecourse->id, "course", "move", "edit.php?id=$movecourse->id", $movecourse->id); /course/lib.php:2041: add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id); /course/lib.php:2291: add_to_log(SITEID, course, new, view.php?id=.$course->id, $data->fullname. (ID .$course->id.)); /course/lib.php:2380: add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id); /course/user.php:108: add_to_log($course->id, "course", "user report", "user.php?id=$course->id&user=$user->id&mode=$mode", "$user->id"); /course/editsection.php:72: add_to_log($course->id, "course", "editsection", "editsection.php?id=$id", "$sectionnum"); /course/view.php:117: add_to_log($course->id, course, $loglabel, "view.php?". $logparam, $infoid); /course/loginas.php:70: add_to_log($course->id, "course", "loginas", "../user/view.php?id=$course->id&user=$userid", "$oldfullname -> $newfullname"); /index.php:79: add_to_log(SITEID, course, view, view.php?id=.SITEID, SITEID);
18.summary: Replace add_to_log with an event trigger - mod_assign
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/assign (26 calls) /mod/assign/index.php:35: add_to_log($course->id, assign, view all, index.php?id=$course->id, ); /mod/assign/locallib.php:2416: add_to_log($this->get_course()->id, investigate this function /mod/assign/locallib.php:2408: public function add_to_log($action = , $info = , $url=) And these lines: /mod/assign/feedback/offline/locallib.php:167: $this->assignment->add_to_log(grade submission, $this->assignment->format_grade_for_log($grade)); /mod/assign/feedback/offline/locallib.php:195: $this->assignment->add_to_log(save grading feedback, $logdesc); /mod/assign/locallib.php:2110: $this->add_to_log(view submission, $logmessage); /mod/assign/locallib.php:2133: $this->add_to_log(view feedback, $logmessage); /mod/assign/locallib.php:2392: $this->add_to_log(download all submissions, get_string(downloadall, assign)); /mod/assign/locallib.php:2810: $this->add_to_log(view grading form, $msg); /mod/assign/locallib.php:2846: $this->add_to_log(view, get_string(viewrevealidentitiesconfirm, assign)); /mod/assign/locallib.php:3059: $this->add_to_log(view submission grading table, $logmessage); /mod/assign/locallib.php:3146: $this->add_to_log(view submit assignment form, get_string(viewownsubmissionform, assign)); /mod/assign/locallib.php:3367: $this->add_to_log(view batch set marking workflow state, get_string(viewbatchsetmarkingworkflowstate, assign)); /mod/assign/locallib.php:3428: $this->add_to_log(view batch set marker allocation, get_string(viewbatchmarkingallocation, assign)); /mod/assign/locallib.php:3481: $this->add_to_log(view confirm submit assignment form, $logmessage); /mod/assign/locallib.php:3828: $this->add_to_log(view, get_string(viewownsubmissionstatus, assign)); /mod/assign/locallib.php:4493: $this->add_to_log(submission statement accepted, $logmessage); /mod/assign/locallib.php:4495: $this->add_to_log(submit for grading, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:4529: $this->add_to_log(grant extension, $userid); /mod/assign/locallib.php:4762: $this->add_to_log(grade submission, $this->format_grade_for_log($grade)); /mod/assign/locallib.php:4811: $this->add_to_log(reveal identities, get_string(revealidentities, assign)); /mod/assign/locallib.php:4999: $this->add_to_log(submissioncopied, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:5105: $this->add_to_log(submission statement accepted, $logmessage); /mod/assign/locallib.php:5107: $this->add_to_log(submit, $this->format_submission_for_log($submission)); /mod/assign/locallib.php:5613: $this->add_to_log(revert submission to draft, $logmessage); /mod/assign/locallib.php:5652: $this->add_to_log(lock submission, $logmessage); /mod/assign/locallib.php:5692: $this->add_to_log(set marking workflow state, $message); /mod/assign/locallib.php:5734: $this->add_to_log(set marking allocation, $message); /mod/assign/locallib.php:5774: $this->add_to_log(unlock submission, $logmessage); /mod/assign/locallib.php:5831: $this->add_to_log(grade submission, $this->format_grade_for_log($grade));
19.summary: Replace add_to_log with an event trigger - role
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. role /admin/roles/manage.php:93: add_to_log(SITEID, role, delete, admin/roles/manage.php, $roles$roleid->localname, , $USER->id); /admin/roles/override.php:128: add_to_log($course->id, role, override, admin/roles/override.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/assign.php:114: add_to_log($course->id, role, assign, admin/roles/assign.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/assign.php:134: add_to_log($course->id, role, unassign, admin/roles/assign.php?contextid=.$context->id.&roleid=.$roleid, $rolename, , $USER->id); /admin/roles/define.php:199: add_to_log(SITEID, role, $action, admin/roles/define.php?action=view&roleid= . /admin/roles/allow.php:49: add_to_log(SITEID, role, edit allow . $mode, str_replace($CFG->wwwroot . /, , $baseurl), , , $USER->id); /lib/accesslib.php:1524: add_to_log(SITEID, role, delete, admin/roles/action=delete&roleid=.$roleid, $rolename, );
20.summary: Replace Legacy events - Groups
description: Replace all legacy events related to Groups. group/lib.php: events_trigger(groups_member_added, $eventdata); group/lib.php: events_trigger(groups_member_removed, $eventdata); group/lib.php: events_trigger(groups_group_created, $group); group/lib.php: events_trigger(groups_grouping_created, $data); group/lib.php: events_trigger(groups_group_updated, $group); group/lib.php: events_trigger(groups_grouping_updated, $data); group/lib.php: events_trigger(groups_group_deleted, $group); group/lib.php: events_trigger(groups_grouping_deleted, $grouping); Plurals: group/lib.php: events_trigger(groups_members_removed, $eventdata); group/lib.php: events_trigger(groups_groupings_groups_removed, $courseid); group/lib.php: events_trigger(groups_groups_deleted, $courseid); group/lib.php: events_trigger(groups_groupings_deleted, $courseid);
21.summary: Replace Legacy events - module
description: Replace all legacy events related to module. course/dnduploadlib.php: events_trigger(mod_created, $eventdata); course/lib.php: events_trigger(mod_deleted, $eventdata); All places where course modules are created, updated(?) or deleted.
22.summary: Replace Legacy events - User
description: Replace all legacy events related to User. admin/tool/uploaduser/index.php: events_trigger(user_updated, $existinguser); admin/tool/uploaduser/index.php: events_trigger(user_created, $user); admin/user.php: events_trigger(user_updated, $user); admin/user.php: events_trigger(user_updated, $user); auth/email/auth.php: events_trigger(user_created, $user); auth/ldap/auth.php: events_trigger(user_created, $user); lib/enrollib.php: events_trigger(user_enrolled, $ue); lib/enrollib.php: events_trigger(user_enrol_modified, $ue); lib/enrollib.php: events_trigger(user_enrol_modified, $ue); lib/enrollib.php: events_trigger(user_unenrolled, $ue); lib/enrollib.php: events_trigger(user_unenrolled, $ue); lib/eventslib.php:function events_trigger($eventname, $eventdata) lib/moodlelib.php: events_trigger(user_logout, $params); lib/moodlelib.php: events_trigger(user_created, $DB->get_record(user, array(id=>$user->id))); lib/moodlelib.php: events_trigger(user_updated, $DB->get_record(user, array(id=>$oldinfo->id))); lib/moodlelib.php: events_trigger(user_deleted, $user); enrol/manual/locallib.php: events_trigger(user_enrol_modified, $enrolment); user/edit.php: events_trigger(user_updated, $usernew); user/editadvanced.php: events_trigger(user_created, $usernew); user/editadvanced.php: events_trigger(user_updated, $usernew); user/emailupdate.php: events_trigger(user_updated, $user); user/lib.php: events_trigger(user_created, $newuser); user/lib.php: events_trigger(user_updated, $updateduser); Please also check user/lib.php user_update_users() from (if it has been integrated) events_trigger(user_updated, $user);
23.summary: Replace add_to_log with an event trigger - mod_page
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/page /mod/page/index.php:36:add_to_log($course->id, page, view all, "index.php?id=$course->id", ); /mod/page/view.php:54:add_to_log($course->id, page, view, view.php?id=.$cm->id, $page->id, $cm->id);
24.summary: Replace add_to_log with an event trigger - mod_feedback
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/feedback (6 calls) /mod/feedback/complete_guest.php:213: add_to_log($course->id,feedback, startcomplete, view.php?id=.$cm->id, $feedback->id); /mod/feedback/index.php:43: add_to_log($course->id, feedback, view all, $url->out(false), $course->id); /mod/feedback/delete_completed.php:79: add_to_log($course->id, feedback, delete, view.php?id=.$cm->id, $feedback->id, $cm->id); /mod/feedback/complete.php:269: add_to_log($course->id, feedback, submit, view.php?id=.$cm->id, $feedback->id, $cm->id, $userid); /mod/feedback/complete.php:213: add_to_log($course->id, feedback, startcomplete, view.php?id=.$cm->id, $feedback->id, $cm->id, $userid); /mod/feedback/view.php:100: add_to_log($course->id, feedback, view, view.php?id=.$cm->id, $feedback->id, $cm->id);
25.summary: Replace add_to_log with an event trigger - mod_chat
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/chat (6 calls) /mod/chat/chat_ajax.php:94: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/report.php:50: add_to_log($course->id, chat, report, "report.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/index.php:17: add_to_log($course->id, chat, view all, "index.php?id=$course->id", ); /mod/chat/gui_header_js/insert.php:61: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/gui_basic/index.php:108: add_to_log($course->id, chat, talk, "view.php?id=$cm->id", $chat->id, $cm->id); /mod/chat/view.php:73: add_to_log($course->id, chat, view, "view.php?id=$cm->id", $chat->id, $cm->id);
26.summary: Replace add_to_log with an event trigger - mod_choice
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/choice (5 calls) /mod/choice/report.php:46: add_to_log($course->id, "choice", "report", "report.php?id=$cm->id", "$choice->id",$cm->id); /mod/choice/index.php:17: add_to_log($course->id, "choice", "view all", "index.php?id=$course->id", ""); /mod/choice/lib.php:296: add_to_log($course->id, "choice", "choose again", "view.php?id=$cm->id", $choice->id, $cm->id); /mod/choice/lib.php:310: add_to_log($course->id, "choice", "choose", "view.php?id=$cm->id", $choice->id, $cm->id); /mod/choice/view.php:79: add_to_log($course->id, "choice", "view", "view.php?id=$cm->id", $choice->id, $cm->id);
27.summary: Replace add_to_log with an event trigger - webservices
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. webservices /webservice/lib.php:74: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(invalidtimedtoken, webservice), 0); /webservice/lib.php:81: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice) . ": " . getremoteaddr(), 0); /webservice/lib.php:145: add_to_log(SITEID, webservice, user unconfirmed, , $user->username); /webservice/lib.php:151: add_to_log(SITEID, webservice, user suspended, , $user->username); /webservice/lib.php:157: add_to_log(SITEID, webservice, nologin auth attempt with web service, , $user->username); /webservice/lib.php:166: add_to_log(SITEID, webservice, expired password, , $user->username); /webservice/lib.php:850: add_to_log(SITEID, webservice, get_string(simpleauthlog, webservice), , get_string(failedtolog, webservice).": ".$this->username."/".$this->password." - ".getremoteaddr() , 0); /webservice/lib.php:870: add_to_log(SITEID, , , , get_string(wsaccessuserdeleted, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:876: add_to_log(SITEID, , , , get_string(wsaccessuserunconfirmed, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:882: add_to_log(SITEID, , , , get_string(wsaccessusersuspended, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:895: add_to_log(SITEID, , , , get_string(wsaccessuserexpired, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:902: add_to_log(SITEID, , , , get_string(wsaccessusernologin, webservice, $user->username) . " - ".getremoteaddr(), 0, $user->id); /webservice/lib.php:929: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice).": ".$this->token. " - ".getremoteaddr() , 0); /webservice/lib.php:947: add_to_log(SITEID, webservice, get_string(tokenauthlog, webservice), , get_string(failedtolog, webservice).": ".getremoteaddr() , 0); /webservice/lib.php:1061: add_to_log(SITEID, webservice, , , $this->zend_class." ".getremoteaddr() , 0, $this->userid); /webservice/lib.php:1522: add_to_log(SITEID, webservice, $this->functionname, , getremoteaddr() , 0, $this->userid); /admin/webservice/service.php:61: add_to_log(SITEID, webservice, delete, $returnurl, get_string(deleteservice, webservice, $service)); /admin/webservice/service.php:78: add_to_log(SITEID, webservice, add, $returnurl, get_string(addservice, webservice, $servicedata)); /admin/webservice/service.php:88: add_to_log(SITEID, webservice, edit, $returnurl, get_string(editservice, webservice, $servicedata)); /admin/webservice/service_users.php:60: add_to_log(SITEID, core, assign, $CFG->admin . /webservice/service_users.php?id= /admin/webservice/service_users.php:74: add_to_log(SITEID, core, assign, $CFG->admin . /webservice/service_users.php?id= webservice (login) /login/token.php:164: add_to_log(SITEID, webservice, automatically create user token, , User ID: . $user->id); /login/token.php:174: add_to_log(SITEID, webservice, sending requested user token, , User ID: . $user->id);
28.summary: Replace add_to_log with an event trigger - Blog
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. blog/ (6 calls) /blog/index.php:227: add_to_log($courseid, blog, view, index.php?entryid=.$entryid.&tagid=. view blog entry); /blog/locallib.php:262: add_to_log(SITEID, blog, add, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject); /blog/locallib.php:299: add_to_log(SITEID, blog, update, index.php?userid=.$USER->id.&entryid=.$entry->id, $entry->subject); /blog/locallib.php:317: add_to_log(SITEID, blog, delete, index.php?userid=. $this->userid, deleted blog entry with entry id . $this->id); /blog/locallib.php:356: add_to_log($courseid, blog, $action, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject); /blog/locallib.php:360: add_to_log($cm->course, blog, $action, index.php?userid=.$this->userid.&entryid=.$this->id, $this->subject, $cm->id, $this->userid);
29.summary: Replace add_to_log with an event trigger - misc
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. lib /lib/uploadlib.php:772: add_to_log($courseid, upload, upload, ((!$nourl) ? substr($_SERVERHTTP_REFERER, 0, 100) : ), $newfilepath); /lib/uploadlib.php:786: add_to_log(0, upload, infected, $_SERVERHTTP_REFERER, $oldfilepath, 0, $userid); /lib/moodlelib.php:5791: add_to_log(SITEID, library, mailer, qualified_me(), ERROR: . $mail->ErrorInfo); mnet /mnet/lib.php:446: add_to_log(SITEID, admin/mnet, update, admin/mnet/access_control.php, /mnet/lib.php:455: add_to_log(SITEID, admin/mnet, add, admin/mnet/access_control.php, report /report/questioninstances/index.php:38: add_to_log(SITEID, "admin", "report questioninstances", "report/questioninstances/index.php?qtype=$requestedqtype", $requestedqtype); admin/tool /admin/tool/capability/index.php:95: add_to_log(SITEID, "admin", "tool capability", "tool/capability/index.php", count($capabilities));
30.summary: Replace add_to_log with an event trigger - mod_assignment
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/assignment (17 calls) /mod/assignment/index.php:16: add_to_log($course->id, "assignment", "view all", "index.php?id=$course->id", ""); /mod/assignment/type/uploadsingle/assignment.class.php:68: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/uploadsingle/assignment.class.php:239: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:49: add_to_log($this->course->id, assignment, view, "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:449: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:515: add_to_log($this->course->id, assignment, upload, /mod/assignment/type/upload/assignment.class.php:636: add_to_log($this->course->id, assignment, upload, //TODO: add finalize action to log /mod/assignment/type/upload/assignment.class.php:676: add_to_log($this->course->id, assignment, upload, //TODO: add finalize action to log /mod/assignment/type/upload/assignment.class.php:704: add_to_log($this->course->id, assignment, view submission, submissions.php?id=.$this->cm->id.&userid=.$userid.&mode=.$mode.&offset=.$offset, $this->assignment->id, $this->cm->id); /mod/assignment/type/upload/assignment.class.php:820: add_to_log($this->course->id, assignment, upload, //TODO: add delete action to log /mod/assignment/type/online/assignment.class.php:78: add_to_log($this->course->id, assignment, upload, view.php?a=.$this->assignment->id, $this->assignment->id, $this->cm->id); /mod/assignment/type/online/assignment.class.php:86: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", $this->assignment->id, $this->cm->id); /mod/assignment/type/offline/assignment.class.php:96: add_to_log($this->course->id, assignment, update grades, /mod/assignment/lib.php:159: add_to_log($this->course->id, "assignment", "view", "view.php?id=$this->cm->id", /mod/assignment/lib.php:777: add_to_log($this->course->id, assignment, update grades, /mod/assignment/lib.php:1248: add_to_log($course->id, assignment, view submission, submissions.php?id=.$this->cm->id, $this->assignment->id, $this->cm->id); /mod/assignment/lib.php:1795: add_to_log($this->course->id, assignment, update grades,
31.summary: Replace add_to_log with an event trigger - mod_wiki
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/wiki (17 calls) /mod/wiki/overridelocks.php:80: add_to_log($course->id, "wiki", "overridelocks", "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/restoreversion.php:78: add_to_log($course->id, "wiki", "restore", "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/history.php:64: add_to_log($course->id, wiki, history, "history.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/admin.php:62: add_to_log($course->id, "wiki", "admin", "admin.php?pageid=".$page->id, $page->id, $cm->id); /mod/wiki/map.php:61: add_to_log($course->id, "wiki", "map", "map.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/index.php:48: add_to_log($course->id, wiki, view, "index.php?id=".$id, ""); /mod/wiki/diff.php:76: add_to_log($course->id, "wiki", "diff", "diff.php?pageid=".$pageid."&comparewith=".$comparewith."&compare=".$compare, $pageid, $cm->id); /mod/wiki/create.php:110: add_to_log($course->id, wiki, add page, "view.php?pageid=".$newpageid, $newpageid, $cm->id); /mod/wiki/create.php:117: add_to_log($course->id, wiki, add page, "view.php?pageid=".$newpageid, $newpageid, $cm->id); /mod/wiki/edit.php:88: add_to_log($course->id, wiki, edit, "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/viewversion.php:68: add_to_log($course->id, "wiki", "history", "viewversion.php?pageid=".$pageid."&versionid=".$versionid, $pageid, $cm->id); /mod/wiki/instancecomments.php:102: add_to_log($course->id, wiki, comment, "comments.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/view.php:292: add_to_log($course->id, wiki, view, "view.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/view.php:294: add_to_log($course->id, wiki, view, "view.php?id=".$id, $id, $cm->id); /mod/wiki/view.php:296: add_to_log($course->id, wiki, view, "view.php?wid=".$wid."&title=".$title, $wid, $cm->id); /mod/wiki/prettyview.php:62: add_to_log($course->id, "wiki", "view", "prettyview.php?pageid=".$pageid, $pageid, $cm->id); /mod/wiki/comments.php:62: add_to_log($course->id, wiki, comments, "comments.php?pageid=".$pageid, $pageid, $cm->id);
32.summary: Replace add_to_log with an event trigger - mod_quiz
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/quiz (14 calls) /mod/quiz/processattempt.php:164: add_to_log($attemptobj->get_courseid(), quiz, close attempt, /mod/quiz/overridedelete.php:66: add_to_log($cm->course, quiz, delete override, /mod/quiz/attempt.php:98: add_to_log($attemptobj->get_courseid(), quiz, continue attempt, /mod/quiz/report.php:86: add_to_log($course->id, quiz, report, report.php?id= . $cm->id . &mode= . $mode, /mod/quiz/index.php:39: add_to_log($course->id, "quiz", "view all", "index.php?id=$course->id", ""); /mod/quiz/report/attemptsreport.php:321: add_to_log($quiz->course, quiz, delete attempt, report.php?id= . $cm->id, /mod/quiz/edit.php:158: add_to_log($cm->course, quiz, editquestions, /mod/quiz/comment.php:47: add_to_log($attemptobj->get_courseid(), quiz, manualgrade, comment.php?attempt= . /mod/quiz/locallib.php:271: add_to_log($quizobj->get_courseid(), quiz, preview, view.php?id=.$quizobj->get_cmid(), /mod/quiz/locallib.php:274: add_to_log($quizobj->get_courseid(), quiz, attempt, review.php?attempt=.$attempt->id, /mod/quiz/overrideedit.php:175: add_to_log($cm->course, quiz, edit override, /mod/quiz/addrandom.php:93: add_to_log($quiz->course, quiz, addcategory, /mod/quiz/view.php:73: add_to_log($course->id, quiz, view, view.php?id= . $cm->id, $quiz->id, $cm->id); /mod/quiz/review.php:89: add_to_log($attemptobj->get_courseid(), quiz, review, review.php?attempt= . /mod/quiz/summary.php:81: add_to_log($attemptobj->get_courseid(), quiz, view summary,
33.summary: Replace add_to_log with an event trigger - mod_glossary
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/glossary (13 calls) /mod/glossary/deleteentry.php:116: add_to_log($course->id, "glossary", "delete entry", "view.php?id=$cm->id&mode=$prevmode&hook=$hook", $entry->id,$cm->id); /mod/glossary/index.php:23: add_to_log($course->id, "glossary", "view all", "index.php?id=$course->id", ""); /mod/glossary/import.php:168: add_to_log($course->id, "course", "add mod", /mod/glossary/import.php:171: add_to_log($course->id, $mod->modulename, "add", /mod/glossary/showentry.php:64: add_to_log($entry->courseid, glossary, view entry, "showentry.php?eid=$entry->id", $entry->id, $entry->cmid); /mod/glossary/showentry_ajax.php:80: add_to_log($entry->courseid, glossary, view entry, "showentry.php?eid=$entry->id", $entry->id, $entry->cmid); /mod/glossary/edit.php:129: add_to_log($course->id, "glossary", "add entry", /mod/glossary/edit.php:135: add_to_log($course->id, "glossary", "update entry", /mod/glossary/editcategories.php:106: add_to_log($course->id, "glossary", "edit category", "editcategories.php?id=$cm->id", $hook,$cm->id); /mod/glossary/editcategories.php:127: add_to_log($course->id, "glossary", "delete category", "editcategories.php?id=$cm->id", $hook,$cm->id); /mod/glossary/editcategories.php:191: add_to_log($course->id, "glossary", "add category", "editcategories.php?id=$cm->id", $cat->id,$cm->id); /mod/glossary/approve.php:37: add_to_log($course->id, "glossary", "approve entry", "showentry.php?id=$cm->id&eid=$eid", "$eid", $cm->id); /mod/glossary/view.php:127: add_to_log($course->id, "glossary", "view", "view.php?id=$cm->id&tab=$tab", $glossary->id, $cm->id);
34.summary: Replace add_to_log with an event trigger - grade
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. grade ./grade/report/grader/ajax_callbacks.php:127: add_to_log($course->id, grade, update, $url, $info); ./grade/report/grader/lib.php:309: add_to_log($this->course->id, grade, update, $url, $info); ./grade/edit/tree/grade.php:212: add_to_log($course->id, grade, update, $url, $info); ./grade/edit/tree/grade.php:239: add_to_log($course->id, grade, update, $url, $info);
35.summary: Replace add_to_log with an event trigger - message
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. message /message/index.php:134: add_to_log(SITEID, message, add contact, index.php?user1=.$addcontact.&user2=.$USER->id, $addcontact); /message/index.php:139: add_to_log(SITEID, message, remove contact, index.php?user1=.$removecontact.&user2=.$USER->id, $removecontact); /message/index.php:143: add_to_log(SITEID, message, block contact, index.php?user1=.$blockcontact.&user2=.$USER->id, $blockcontact); /message/index.php:147: add_to_log(SITEID, message, unblock contact, index.php?user1=.$unblockcontact.&user2=.$USER->id, $unblockcontact); /message/index.php:184: add_to_log(SITEID, message, write, index.php?user=.$user1->id.&id=.$user2->id.&history=1m.$messageid, $user1->id); /message/lib.php:132: add_to_log(SITEID, message, view, index.php, $viewing);
36.summary: Grade update event
description: Multiple activities make updates to the grading table, there should be a generic event, or a class or something we can use for these situations instead of creating multiple events that do the same thing. See on why this is needed.
37.summary: Legacy events and addtolog() Cleanup
description: Make sure there is no remaining addtolog() calls in core, or agree on whether they should be deprecated but kept for a while or not. -Make sure there is no legacy events left in core.- see -Make sure all new events use the correct naming convention.- see -Create a mapping list, listing all old events/addtolog() and respective new event. Add this list to docs.- See -Cleanup lib/db/events.php, either delete all events listing or add all new events to the list.- see once is resolved, make sure all existing events have the legacyassertions when needed. -implement can_view() for all events.- see
38.summary: Cleanup and fixup of the events/logging docs
description: While looking at the Events doc, I noticed some inconsistencies. For example:- The pattern of names for new names of the events seems wrong. The relationship column doesnt make any sense imo and also now since we have those new events, we should provide an exact mapping. On detail evaluation am sure, many other inconsistencies would be found. We need to revalute this doc and fixup any incorrect data.
39.summary: Remove remaining uses of content_viewed, and deprecate it
description: We still have uses of content_viewed in core. It was decided to remove this from core because:- There is no educational value in this event. It doesnt contain enough information of what actually happened. If some of the viewed events can be grouped together, they should have their own abstract parent. ex- course_module_viewed we must not store localised strings in events we should not store urls in other array - we have get_url() instead !!!
40.summary: use restore and ws origin in logged events
description: . Current problem Problem is that we cannot just falsify log history by injecting log records from the restore file, events must be always triggered and we need to know where are the courses coming from, that means the restore process needs to log everything that is happening during restore. import (=== backup+restore) of activities should not try to restore any logs restore from different site cannot create log entries with non-existent users duplication of course (restore into new course) may bork stats statistics should probably ignore the events coming from restore completely . Possible solutions . A/ use events 1/ trigger \core\event\restore_started and \core\event\restore_finished events (this might be useful in any case) 2/ log writers would watch for these and start adding restore origin when writing events to storage during the restore process . B/ new $PAGE->get_request_origin() The idea is to have one method that tells you if you are doing something from normal page, ws, cli, restore. The restore code would use some private API to tell PAGE that restore starts/end or it could even use 1/, but that would require a new observer which does not seem optimal to me. At the same time we could add $PAGE->get_request_ip(). After A/ or B/ is implemented we could filter out logs coming from the restore process in stats and other areas where we want to ignore the events triggered during restore. The next step would be to optionally restore the original log data - we would need backup/restore support in log stores and new method in base event class which would have to be overridden by events that can recalculate the ids.
41.summary: Replace add_to_log with an event trigger - tag
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. tag /tag/coursetagslib.php:304: add_to_log($courseid, coursetags, add, $url, Course tagged); /tag/edit.php:138: add_to_log($COURSE->id, tag, update, index.php?id=. $tag->id, $tag->name . ->. $tagnew->name); /tag/edit.php:141: add_to_log($COURSE->id, tag, update, index.php?id=. $tag->id, $tag->name); /tag/user.php:50: add_to_log(SITEID, tag, flag, index.php?id=. $tagid, $tagid, , $USER->id); Suggested additional events tag deleted
42.summary: Replace add_to_log with an event trigger - mod_forum
description: Replace the add_to_log calls for the following area, with a call to the get_legacy_logdata function in the event class. mod/forum (24 calls) /mod/forum/discuss.php:95: add_to_log($course->id, forum, move discussion, "discuss.php?d=$discussion->id", $discussion->id, $cmto->id); /mod/forum/discuss.php:107: add_to_log($course->id, forum, view discussion, "discuss.php?d=$discussion->id", $discussion->id, $cm->id); /mod/forum/subscribe.php:152: add_to_log($course->id, "forum", "unsubscribe", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/subscribe.php:177: add_to_log($course->id, "forum", "subscribe", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/markposts.php:85: add_to_log($course->id, "discussion", "mark read", "view.php?f=$forum->id", $d, $cm->id); /mod/forum/markposts.php:96: add_to_log($course->id, "forum", "mark read", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/markposts.php:103: // add_to_log($course->id, "forum", "mark unread", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/index.php:54: add_to_log($course->id, forum, view forums, "index.php?id=$course->id"); /mod/forum/index.php:183: add_to_log($course->id, forum, subscribeall, "index.php?id=$course->id", $course->id); /mod/forum/index.php:186: add_to_log($course->id, forum, unsubscribeall, "index.php?id=$course->id", $course->id); /mod/forum/settracking.php:63: add_to_log($course->id, "forum", "stop tracking", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/settracking.php:71: add_to_log($course->id, "forum", "start tracking", "view.php?f=$forum->id", $forum->id, $cm->id); /mod/forum/lib.php:742: add_to_log($course->id, forum, mail error, "discuss.php?d=$discussion->idp$post->id", /mod/forum/lib.php:1040: add_to_log($course->id, forum, mail digest error, , , $cm->id, $userto->id); /mod/forum/user.php:65: add_to_log(($isspecificcourse)?$courseid:SITEID, "forum", "user report", user.php?.$url->get_query_string(), $userid); /mod/forum/post.php:336: add_to_log($discussion->course, "forum", "delete discussion", /mod/forum/post.php:353: add_to_log($discussion->course, "forum", "delete post", $discussionurl, "$post->id", $cm->id); /mod/forum/post.php:454: add_to_log($discussion->course, "forum", "prune post", /mod/forum/post.php:682: add_to_log($course->id, "forum", "update post", /mod/forum/post.php:725: add_to_log($course->id, "forum", "add post", /mod/forum/post.php:772: add_to_log($course->id, "forum", "add discussion", /mod/forum/subscribers.php:57: add_to_log($course->id, "forum", "view subscribers", "subscribers.php?id=$forum->id", $forum->id, $cm->id); /mod/forum/view.php:131: add_to_log($course->id, "forum", "view forum", "view.php?id=$cm->id", "$forum->id", $cm->id); /mod/forum/view.php:133: add_to_log($course->id, "forum", "view forum", "view.php?f=$forum->id", "$forum->id"); /mod/forum/search.php:115: add_to_log($course->id, "forum", "search", "search.php?id=$course->id&search=".urlencode($search), $search);
43.summary: Replace existing add_to_log calls for mod_assign
description: Replace the existing add_to_log calls for mod_assign.
44.summary: Replace add_to_log call for page viewed in /report/completion/user.php
description: /report/completion/user.php:53: add_to_log($course->id, course, report completion, "report/completion/user.php?id=$user->id&course=$course->id", $course->id);
45.summary: Create page viewed event for course
description: /course/user.php:108: add_to_log($course->id, "course", "user report", "user.php?id=$course->id&user=$user->id&mode=$mode", "$user->id"); /course/view.php:117: add_to_log($course->id, course, $loglabel, "view.php?". $logparam, $infoid); /index.php:79: add_to_log(SITEID, course, view, view.php?id=.SITEID, SITEID);
46.summary: Replace add_to_log in mod_workshop (part 2)
description: Unfinished after : code $git grep add_to_log mod/workshop/locallib.php: call_user_func_array(add_to_log, $args); code
47.summary: Tool to list all events
description: As events are being added and updated, it is very hard to find which events are available and what data they store. We need a tool that is useful for two main user groups: for analysts/researchers, to understand what data may be found in our logs for developers, to understand what events are available to use The tool should: Generate a list of all events in core Include high-level descriptions of the event List as much as possible about the payload data in the event Filter/search by verb/module etc. List the observers that are consuming those events.
48.summary: Proposed Events Verbs
description: Here are 4 verbs that I feel are both useful enough, and generic enough, to be on the core verb list. started bq. Marking when something that occurs across time starts. Could apply to a quiz attempt, a chat session, a group meeting, etc. ended bq. The ending that corresponds to started. joined bq. Used to represent a person entering a synchronous group event, such as a chat. hosted bq. For synchronous group events, such as a chat or meeting, represents the person who controls the event entering. Depending on the particular context it is used in, could be a teaching or participating type 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: MoodleNet
summary: MoodleNet Community
description: Issues identified and reported that could be addressed by the improvement of documentation and/or by learning on Moodle Academy.
| Unsolvable | 1.summary: Plan communications for MoodleNet (re)launch
description: Launch publicly Partners Press release MUA Moodle.org Elsewhere!
2.summary: Improve licensing reference material
description: It has been reported that users of MoodleNet central are not always stating the correct creative commons licensing for their resources. Whilst this is the responsibility of the user and not MoodleNet, we will add an activity in the MoodleNet course on Moodle Academy| to address this and update the documentation accordingly. brumasribera what is your opinion on adding a help icon next to the licensing dropdown that would link to 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: MoodleNet
summary: MoodleNet Community
description: Issues identified and reported that could be addressed by the improvement of documentation and/or by learning on Moodle Academy.
### Response:
1.summary: Plan communications for MoodleNet (re)launch
description: Launch publicly Partners Press release MUA Moodle.org Elsewhere!
2.summary: Improve licensing reference material
description: It has been reported that users of MoodleNet central are not always stating the correct creative commons licensing for their resources. Whilst this is the responsibility of the user and not MoodleNet, we will add an activity in the MoodleNet course on Moodle Academy| to address this and update the documentation accordingly. brumasribera what is your opinion on adding a help icon next to the licensing dropdown that would link to 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: Allow admin settings to be shown / hidden on the fly based on the status of other settings
description: Here we will consolidate all the places in Moodle that will benefit from this change.
| Solvable | 1.summary: Admin setting hidden/disabled: Add the core functionality
description: Its not unusual to have plugin (Moodle core as well as 3rd party plugins) settings on admin settings pages which only make sense if another setting has a certain status. For example, on /admin/settings.php?section=modsettingforum, the forum_rsstype and the forum_rssarticles setting only need to be visible when forum_enablerssfeeds is set to yes. Other applications often have mechanisms to show / hide these depending settings on the fly based on the status of the leading setting. I.e. as soon as an admin changes the status of the leading setting on the settings page, the depending settings get shown and the other way round. At the moment, Moodle lacks such a mechanism. The solution for plugin developers is a) to describe the dependency in the settings descriptions (like its done in the above-mentioned example) or to code a special solution for the plugins settings page. Having such a mechanism would help clean up the admin settings pages and help understanding dependent settings on the admin pages. ---------------- This issue is strongly related to , but as far as I understood, is targeted to a static dependency and misses a "on the fly" part. ---------------- PS: A similar on-the-fly mechanism already exists in the course settings when the course format is changed and for activity settings where the disableif attribute can be used to disable activity setting widgets on the fly based on another activity settings status. Perhaps you dont have to reinvent the wheel completely.
2.summary: Admin setting hidden/disabled: Make use of the new functionality in the forum module
description: The forum module could benefit from 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: Allow admin settings to be shown / hidden on the fly based on the status of other settings
description: Here we will consolidate all the places in Moodle that will benefit from this change.
### Response:
1.summary: Admin setting hidden/disabled: Add the core functionality
description: Its not unusual to have plugin (Moodle core as well as 3rd party plugins) settings on admin settings pages which only make sense if another setting has a certain status. For example, on /admin/settings.php?section=modsettingforum, the forum_rsstype and the forum_rssarticles setting only need to be visible when forum_enablerssfeeds is set to yes. Other applications often have mechanisms to show / hide these depending settings on the fly based on the status of the leading setting. I.e. as soon as an admin changes the status of the leading setting on the settings page, the depending settings get shown and the other way round. At the moment, Moodle lacks such a mechanism. The solution for plugin developers is a) to describe the dependency in the settings descriptions (like its done in the above-mentioned example) or to code a special solution for the plugins settings page. Having such a mechanism would help clean up the admin settings pages and help understanding dependent settings on the admin pages. ---------------- This issue is strongly related to , but as far as I understood, is targeted to a static dependency and misses a "on the fly" part. ---------------- PS: A similar on-the-fly mechanism already exists in the course settings when the course format is changed and for activity settings where the disableif attribute can be used to disable activity setting widgets on the fly based on another activity settings status. Perhaps you dont have to reinvent the wheel completely.
2.summary: Admin setting hidden/disabled: Make use of the new functionality in the forum module
description: The forum module could benefit from 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: MoodleNet servers should be able to fetch and serve ActivityPub objects
description: MoodleNet servers should be able to fetch and serve ActivityPub objects
| Solvable | 1.summary: Make sure MN data format is compatible with ActivityPub, or translate between the two when appropriate
description: Some fields need to be added/renamed/removed, either directly in the database (migrations), or only upon being translated to/from the ActivityPub REST API, 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: MoodleNet
summary: MoodleNet servers should be able to fetch and serve ActivityPub objects
description: MoodleNet servers should be able to fetch and serve ActivityPub objects
### Response:
1.summary: Make sure MN data format is compatible with ActivityPub, or translate between the two when appropriate
description: Some fields need to be added/renamed/removed, either directly in the database (migrations), or only upon being translated to/from the ActivityPub REST API, 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: MoodleNet
summary: Define MoodleNet integration with Moodle Core
description: See issues included in this epic.
| Unsolvable | 1.summary: Specify user identity/authentication approach
description: WIP
2.summary: Specify Moodle Core plugins
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 MoodleNet integration with Moodle Core
description: See issues included in this epic.
### Response:
1.summary: Specify user identity/authentication approach
description: WIP
2.summary: Specify Moodle Core plugins
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 Community Sites
summary: Moodle User Docs updates for 4.1
description: Create 4.1 user docs in advance of the major release on 28th November 2022
| Solvable | 1.summary: Update admin pages in user docs
description: Determine pages that need updating the user docs
2.summary: English and German 4.1 docs set up
description: During the week starting Nov 7 could you please: Create the 401/en and 401/de wikis by cloning the 400/en and 400/de wiki databases Disable email notification of watched pages Have I got the numbering correct? mudrd8mz Are you able to do this or should another team member take it on? Many thanks in advance. _________________________________ from : Once the clone docs are created, next step (Mary/Aurelie), in new version wiki: (/) Edit MediaWiki:MoodleDocsVersionLinks (/) Edit Main_page (/) Add message to MediaWiki:Sitenotice (/) Remove new features template from all pages in Category:New_features (/) Edit Template:New_features and Category:New_features (/)Go through tracker issues with the docs_required label and the release notes for the upcoming release and add documentation on new features plus the new features template (/) Create Upgrading_to_Moodle_x.y and redirect to Upgrading (/) Update version number in Template:Version and Template:Version2 and Git for Administrators (x) Review Special:WantedPages (x) Review Special:LonelyPages (/) Review instances of "(new in x.y)" text (not always necessary to remove them) (/) Add link to new version wiki to ________________________________ Legend: (x) - not done (!) - work in progress (?) - waiting for testing (y) - tested fine, ready to be deployed (/) - done
3.summary: Final checks for user docs 4.1 ready for release
description: w/c 21st Nov 2022, follow the following steps as per for the user docs for 4.1. (prepared in | ) In new wiki: Remove message in MediaWiki:Sitenotice Check (and update if needed) Upgrading and Upgrade overview pages In all older version wikis: Edit to add the new version and remove older versions (though keeping LTS releases| . Day of release | Request for the new version wiki to be made default and email notification of watched pages to be enabled. In previous latest version wiki: Edit to make it like Edit to make it like Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki Edit and add redirect en( so it redirects to the latest version of the page Edit and add redirect en( so it redirects to the latest version of the page For no longer supported versions, create MediaWiki:Sitenotice by copying content from . Final checks | Email notification of watched pages enabled Links without version number, for example , redirect to the new version wiki Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki New version wiki listed 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 Community Sites
summary: Moodle User Docs updates for 4.1
description: Create 4.1 user docs in advance of the major release on 28th November 2022
### Response:
1.summary: Update admin pages in user docs
description: Determine pages that need updating the user docs
2.summary: English and German 4.1 docs set up
description: During the week starting Nov 7 could you please: Create the 401/en and 401/de wikis by cloning the 400/en and 400/de wiki databases Disable email notification of watched pages Have I got the numbering correct? mudrd8mz Are you able to do this or should another team member take it on? Many thanks in advance. _________________________________ from : Once the clone docs are created, next step (Mary/Aurelie), in new version wiki: (/) Edit MediaWiki:MoodleDocsVersionLinks (/) Edit Main_page (/) Add message to MediaWiki:Sitenotice (/) Remove new features template from all pages in Category:New_features (/) Edit Template:New_features and Category:New_features (/)Go through tracker issues with the docs_required label and the release notes for the upcoming release and add documentation on new features plus the new features template (/) Create Upgrading_to_Moodle_x.y and redirect to Upgrading (/) Update version number in Template:Version and Template:Version2 and Git for Administrators (x) Review Special:WantedPages (x) Review Special:LonelyPages (/) Review instances of "(new in x.y)" text (not always necessary to remove them) (/) Add link to new version wiki to ________________________________ Legend: (x) - not done (!) - work in progress (?) - waiting for testing (y) - tested fine, ready to be deployed (/) - done
3.summary: Final checks for user docs 4.1 ready for release
description: w/c 21st Nov 2022, follow the following steps as per for the user docs for 4.1. (prepared in | ) In new wiki: Remove message in MediaWiki:Sitenotice Check (and update if needed) Upgrading and Upgrade overview pages In all older version wikis: Edit to add the new version and remove older versions (though keeping LTS releases| . Day of release | Request for the new version wiki to be made default and email notification of watched pages to be enabled. In previous latest version wiki: Edit to make it like Edit to make it like Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki Edit and add redirect en( so it redirects to the latest version of the page Edit and add redirect en( so it redirects to the latest version of the page For no longer supported versions, create MediaWiki:Sitenotice by copying content from . Final checks | Email notification of watched pages enabled Links without version number, for example , redirect to the new version wiki Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki New version wiki listed 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: Bootstrapbase deprecation followup
description: Followup of issues from the Bootstrap deprecation in
| Unsolvable | 1.summary: Remove PHP Less compiler
description: With removing all core themes that use the lessphpc in theme designer mode, we will have a library that is no longer required within Moodle core. There are currently two calls to this library located: code:java lib/outputlib.php get_css_content() get_css_content_debug() code This change would leave the SCSS as the primary compiler with a CSS fallback. It would be good if we could look at deprecating this library.
2.summary: Deprecate block docking functions
description: Block docking JS is being removed as a part of . The decision was made to retain user preferences, settings and the base functions however, returning false. This issue would also have to look at removing the relevant parts of the blocks privacy provider and related strings. We should either clean these items up or use them as a part of after some consideration.
3.summary: Determine setup of dark navbar for Classic theme
description: The dark navbar has insufficient contrast (fails WCAG). There are a few different approaches we can take, depending how we want custom business colours to work, and the style defaults.
4.summary: Determine navigation item icon use
description: The clean theme applied a default icon next to each item in the navigation block that did not have one defined, which has been omitted in the Classic theme. Though the indent defines the level, the separation of long link names may be unclear to users without an icon identifying each new item. We need to determine whether to add an icon, and if so, add the icon.
| 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: Bootstrapbase deprecation followup
description: Followup of issues from the Bootstrap deprecation in
### Response:
1.summary: Remove PHP Less compiler
description: With removing all core themes that use the lessphpc in theme designer mode, we will have a library that is no longer required within Moodle core. There are currently two calls to this library located: code:java lib/outputlib.php get_css_content() get_css_content_debug() code This change would leave the SCSS as the primary compiler with a CSS fallback. It would be good if we could look at deprecating this library.
2.summary: Deprecate block docking functions
description: Block docking JS is being removed as a part of . The decision was made to retain user preferences, settings and the base functions however, returning false. This issue would also have to look at removing the relevant parts of the blocks privacy provider and related strings. We should either clean these items up or use them as a part of after some consideration.
3.summary: Determine setup of dark navbar for Classic theme
description: The dark navbar has insufficient contrast (fails WCAG). There are a few different approaches we can take, depending how we want custom business colours to work, and the style defaults.
4.summary: Determine navigation item icon use
description: The clean theme applied a default icon next to each item in the navigation block that did not have one defined, which has been omitted in the Classic theme. Though the indent defines the level, the separation of long link names may be unclear to users without an icon identifying each new item. We need to determine whether to add an icon, and if so, add the icon.
|
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.1
description: Further improvements to Quiz and question bank in Moodle 4.1 See also
| Unsolvable | 1.summary: Move the participants filter UI from within core_user to a re-usable API
description: Participants filter is currently coupled with the core_user, where it helps to filter the users using different filtering criteria. This feature is widely helpful and has the potential to be used in different areas of the core. To make this feature extendable and usable in different locations in core or community plugins, this tracker decouples this feature from the core user and moves it to the core to make it an extendible API. This API will be used in the qbank as a proof of concept.
2.summary: Question bank: add a new Modified by column
description: Create a new Modified by column (which now has to get the data to show by getting the latest version of this question and seeing who created it and when.)
3.summary: Quiz and Question bank in Moodle 4.1 - Wireframes
description: This issue is to serve as a placeholder for wireframes related to this epic. Having a separate "issue" for wireframes will help keep things organised in the epic and make navigation easier.
4.summary: Version selection in comment modal
description: At the moment, one question has one column to add a comment on that specific question. Add the ability to change version in the comment modal so users can comment on different question being in the same modal.
5.summary: In-place edit of the question name in the qbank view
description: Details and screenshots TBA (using the pencil like core)
6.summary: Question bank view - page size should be 100
description: Since forever, the question bank has defaulted to showing 20 questions on a page, with an option to switch to show all questions (which is acutally limited to 1000 for performance reasons). In discussions relating to other question changes for 4.0, we realised that for Modern browsers and servers, it would be fine to change these sizes to 100 and 4000, and that would be much better for users. Since this is a simple change, we should try to get this into 4.0.
7.summary: Create help icon for qbank api
description: Implement a method so that columns can define their help icon with information added to it.
8.summary: question_attempt_step_subquestion_adapter class contains some strange anachronisms
description: During the late stages of (done in Moodle 2.1!) some key concepts in the code were renamed. However, it seems that the question_attempt_step_subquestion_adapter class was not fully updated at the time. I noticed this while working on , and now that we have spotted it, it should be fixed.
9.summary: Allow multiple bulk actions from qbank plugins
description: Bulk actions should be an array as one plugin can have multiple actions .
10.summary: Question bank: add a last-used column
description: Create a new question bank column which will show when the question was last attempted by a student. This tracker will also implement a filterable object for the last used column.
11.summary: Performance problem from a query in in mdl_comments
description: After updating to Moodle 4.0, we noticed slow queries on mdl_comments in the database. These always have the same query as cause: code:javaSELECT c. FROM mdl_comments c WHERE c.commentarea = question AND c.component = qbank_comment AND c.itemid = 1234 code The query came with for backup of questions in core. We have now observed the query in production for a few days and see a payload of 25 to about 60 on the database. The cause for this behavior could be a missing index on noformatcommentarea, component, itemid noformat
| 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.1
description: Further improvements to Quiz and question bank in Moodle 4.1 See also
### Response:
1.summary: Move the participants filter UI from within core_user to a re-usable API
description: Participants filter is currently coupled with the core_user, where it helps to filter the users using different filtering criteria. This feature is widely helpful and has the potential to be used in different areas of the core. To make this feature extendable and usable in different locations in core or community plugins, this tracker decouples this feature from the core user and moves it to the core to make it an extendible API. This API will be used in the qbank as a proof of concept.
2.summary: Question bank: add a new Modified by column
description: Create a new Modified by column (which now has to get the data to show by getting the latest version of this question and seeing who created it and when.)
3.summary: Quiz and Question bank in Moodle 4.1 - Wireframes
description: This issue is to serve as a placeholder for wireframes related to this epic. Having a separate "issue" for wireframes will help keep things organised in the epic and make navigation easier.
4.summary: Version selection in comment modal
description: At the moment, one question has one column to add a comment on that specific question. Add the ability to change version in the comment modal so users can comment on different question being in the same modal.
5.summary: In-place edit of the question name in the qbank view
description: Details and screenshots TBA (using the pencil like core)
6.summary: Question bank view - page size should be 100
description: Since forever, the question bank has defaulted to showing 20 questions on a page, with an option to switch to show all questions (which is acutally limited to 1000 for performance reasons). In discussions relating to other question changes for 4.0, we realised that for Modern browsers and servers, it would be fine to change these sizes to 100 and 4000, and that would be much better for users. Since this is a simple change, we should try to get this into 4.0.
7.summary: Create help icon for qbank api
description: Implement a method so that columns can define their help icon with information added to it.
8.summary: question_attempt_step_subquestion_adapter class contains some strange anachronisms
description: During the late stages of (done in Moodle 2.1!) some key concepts in the code were renamed. However, it seems that the question_attempt_step_subquestion_adapter class was not fully updated at the time. I noticed this while working on , and now that we have spotted it, it should be fixed.
9.summary: Allow multiple bulk actions from qbank plugins
description: Bulk actions should be an array as one plugin can have multiple actions .
10.summary: Question bank: add a last-used column
description: Create a new question bank column which will show when the question was last attempted by a student. This tracker will also implement a filterable object for the last used column.
11.summary: Performance problem from a query in in mdl_comments
description: After updating to Moodle 4.0, we noticed slow queries on mdl_comments in the database. These always have the same query as cause: code:javaSELECT c. FROM mdl_comments c WHERE c.commentarea = question AND c.component = qbank_comment AND c.itemid = 1234 code The query came with for backup of questions in core. We have now observed the query in production for a few days and see a payload of 25 to about 60 on the database. The cause for this behavior could be a missing index on noformatcommentarea, component, itemid noformat
|
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: The navigation overhaul stage one - users
description: This is the general specification for the navigation overhaul: We are tackling in this epic.
| Unsolvable | 1.summary: Consistent user context page layout
description: We want to change the headers of each user page so that they are more consistent. This includes course pages that relate to one user. has the documentation. See the invision app for how this should be implemented. We need to agree upon the design and implementation of the user header. The specification will need to be updated.
| 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: The navigation overhaul stage one - users
description: This is the general specification for the navigation overhaul: We are tackling in this epic.
### Response:
1.summary: Consistent user context page layout
description: We want to change the headers of each user page so that they are more consistent. This includes course pages that relate to one user. has the documentation. See the invision app for how this should be implemented. We need to agree upon the design and implementation of the user header. The specification will need to be updated.
|
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.8.3 upgrade
description:
| Unsolvable | 1.summary: Upgrade moodle.org to 2.8.3
description:
2.summary: Upgrade learn.moodle.net to 2.8.3
description:
3.summary: Upgrade lang.moodle.org to 2.8.3
description:
4.summary: Upgrade download.moodle.org to 2.8.3
description:
5.summary: Upgrade school.demo.moodle.net to 2.8.3
description:
6.summary: Upgrade demo.moodle.net to 2.8.3
description:
7.summary: Upgrade dev.moodle.org to 2.8.3
description:
8.summary: Upgrade moodle.net to 2.8.3
description:
9.summary: Upgrade research.moodle.net to 2.8.3
description:
10.summary: Upgrade moodlemoot.org sites to 2.8.3
description: mootau15 mootieuk15 and mootus15
| 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.8.3 upgrade
description:
### Response:
1.summary: Upgrade moodle.org to 2.8.3
description:
2.summary: Upgrade learn.moodle.net to 2.8.3
description:
3.summary: Upgrade lang.moodle.org to 2.8.3
description:
4.summary: Upgrade download.moodle.org to 2.8.3
description:
5.summary: Upgrade school.demo.moodle.net to 2.8.3
description:
6.summary: Upgrade demo.moodle.net to 2.8.3
description:
7.summary: Upgrade dev.moodle.org to 2.8.3
description:
8.summary: Upgrade moodle.net to 2.8.3
description:
9.summary: Upgrade research.moodle.net to 2.8.3
description:
10.summary: Upgrade moodlemoot.org sites to 2.8.3
description: mootau15 mootieuk15 and mootus15
|
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: Moodle.org reboot
description:
| Unsolvable | 1.summary: Improve the list of communities page
description: Make the list of communities (courses) more user-friendly by adding text at top (category description) mentioning Moodle Docs and show course descriptions.
2.summary: Create new theme for moodle.org
description: 2.4 theme based on designs
3.summary: local_moodleorg needs to populate PHM cohort rather than group
description: Well use the cohort sync plugin to populate to all the courses.
4.summary: Social media logos need updating
description: From xymoodle: Have created the new logos (for both twitter and fb) - The logos need updating on they look fine on the front page. Are they used anywhere else XY?
5.summary: Useful posts in Spanish should display for es_mx users
description: As reported by germanvaleroelizondo in about the Useful posts area on the front page of moodle.org: bq. it lists correctly the useful posts in spanish for the international spanish (es) users, but it fall back to english posts for the mexican spanish users (es_mx). Could it be possible for users of the mexican spanish language pack to have the forum post of the spanish language course listed within the Useful posts area ?
6.summary: Re-award PHM 2013 badge
description: Unfortunately I set an expiry date for the PHM 2013 badge by mistake. Thus, we need to re-award the badge and remove the expired badge from peoples profiles.
7.summary: Add permalink to forums
description:
8.summary: Award PHM 2014 badge
description: It seems that a solution for awarding badges automatically based on cohort membership will take some development time, thus I suggest the following short-term solution: Once is fixed and we have a PHM cohort, obtain a list of PHM user IDs. Make use of Aparups special script (previously used in ) and award PHM 2014 badges as a one-off job. Then for the rest of the year, as there wont be many new PHMs (only a few each month) I can award the badges manually (after checking that Matts hack is still in force or after the fix for is backported).
9.summary: Site title needs improving
description: Currently the site title for moodle.org is simply Moodle.org. Just wondering whether it should be something like: bq. Moodle.org - Open-source software for collaborative learning or bq. Moodle - Open-source learning platform | Moodle.org xymoodle please could you advise.
10.summary: Amend the useful scale in Japanese
description: As requested by mits: quoteamend the useful scale in Japanese as below Before After (Useful)quote The scale has id 115.
| 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: Moodle.org reboot
description:
### Response:
1.summary: Improve the list of communities page
description: Make the list of communities (courses) more user-friendly by adding text at top (category description) mentioning Moodle Docs and show course descriptions.
2.summary: Create new theme for moodle.org
description: 2.4 theme based on designs
3.summary: local_moodleorg needs to populate PHM cohort rather than group
description: Well use the cohort sync plugin to populate to all the courses.
4.summary: Social media logos need updating
description: From xymoodle: Have created the new logos (for both twitter and fb) - The logos need updating on they look fine on the front page. Are they used anywhere else XY?
5.summary: Useful posts in Spanish should display for es_mx users
description: As reported by germanvaleroelizondo in about the Useful posts area on the front page of moodle.org: bq. it lists correctly the useful posts in spanish for the international spanish (es) users, but it fall back to english posts for the mexican spanish users (es_mx). Could it be possible for users of the mexican spanish language pack to have the forum post of the spanish language course listed within the Useful posts area ?
6.summary: Re-award PHM 2013 badge
description: Unfortunately I set an expiry date for the PHM 2013 badge by mistake. Thus, we need to re-award the badge and remove the expired badge from peoples profiles.
7.summary: Add permalink to forums
description:
8.summary: Award PHM 2014 badge
description: It seems that a solution for awarding badges automatically based on cohort membership will take some development time, thus I suggest the following short-term solution: Once is fixed and we have a PHM cohort, obtain a list of PHM user IDs. Make use of Aparups special script (previously used in ) and award PHM 2014 badges as a one-off job. Then for the rest of the year, as there wont be many new PHMs (only a few each month) I can award the badges manually (after checking that Matts hack is still in force or after the fix for is backported).
9.summary: Site title needs improving
description: Currently the site title for moodle.org is simply Moodle.org. Just wondering whether it should be something like: bq. Moodle.org - Open-source software for collaborative learning or bq. Moodle - Open-source learning platform | Moodle.org xymoodle please could you advise.
10.summary: Amend the useful scale in Japanese
description: As requested by mits: quoteamend the useful scale in Japanese as below Before After (Useful)quote The scale has id 115.
|
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 student UI tweaks
description: The quiz UI for students is pretty good, but some things could be made slightly slicker, as discussed in this forum thread This Epic is to track implementation of those changes.
| Unsolvable | 1.summary: Rationalise confirmations when you start a quiz
description: At the start of the quiz, only show the "Are you sure you want to start this quiz now" if the quiz has a time limit. At the moment, it is shown if there is a time-limit or a limited number of attempts, but there is only possible harm in starting an attempt if there is a time-limit. If the quiz has a password, this is currently shown after the Are-you-sure. (Though other checks like are shown on the same page as the password, if both are enable.) Merge the time-limit Are-you sure onto this page, so there is never more than one page to click through. And, make that combined page a JavaScript thing in all cases, like the current Are you sure message.
2.summary: Add the OU styling of the Quiz navigation into Moodle core as the default
description: Possibly for bootstrap base only?
3.summary: Quiz review should default to show all questions
description: ... unless the quiz is very big.
4.summary: Change the buttons at the end of the quiz review page
description: 7. Instead of the Finish review link at the end of the review, we should instead put Back to course and Re-attempt quiz buttons right there. There would be no direct link back to the quiz information page. Of course, the Re-attempt quiz link will only be shown if a re-attempt is allowed.
5.summary: Always show a link back to the course on the Quiz information page
description: Users do seem to be unable to use the navigation. This has been requested on and off over the years in the quiz forum.
| 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 student UI tweaks
description: The quiz UI for students is pretty good, but some things could be made slightly slicker, as discussed in this forum thread This Epic is to track implementation of those changes.
### Response:
1.summary: Rationalise confirmations when you start a quiz
description: At the start of the quiz, only show the "Are you sure you want to start this quiz now" if the quiz has a time limit. At the moment, it is shown if there is a time-limit or a limited number of attempts, but there is only possible harm in starting an attempt if there is a time-limit. If the quiz has a password, this is currently shown after the Are-you-sure. (Though other checks like are shown on the same page as the password, if both are enable.) Merge the time-limit Are-you sure onto this page, so there is never more than one page to click through. And, make that combined page a JavaScript thing in all cases, like the current Are you sure message.
2.summary: Add the OU styling of the Quiz navigation into Moodle core as the default
description: Possibly for bootstrap base only?
3.summary: Quiz review should default to show all questions
description: ... unless the quiz is very big.
4.summary: Change the buttons at the end of the quiz review page
description: 7. Instead of the Finish review link at the end of the review, we should instead put Back to course and Re-attempt quiz buttons right there. There would be no direct link back to the quiz information page. Of course, the Re-attempt quiz link will only be shown if a re-attempt is allowed.
5.summary: Always show a link back to the course on the Quiz information page
description: Users do seem to be unable to use the navigation. This has been requested on and off over the years in the quiz forum.
|
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.1.1 upgrade
description: Moodle 3.1.1 scheduled release: Monday 11 July 2016
| Unsolvable | 1.summary: Upgrade moodle.org to 3.1.1
description:
2.summary: Upgrade learn.moodle.net to 3.1.1
description:
3.summary: Upgrade lang.moodle.org to 3.1.1
description:
4.summary: Upgrade school.demo.moodle.net to 3.1.1
description:
5.summary: Upgrade demo.moodle.net to 3.1.1
description:
6.summary: Upgrade dev.moodle.org to 3.1.1
description:
7.summary: Upgrade moodle.net to 3.1.1
description:
8.summary: Upgrade moodlemoot.org sites to 3.1.1
description:
9.summary: Upgrade download.moodle.org to 3.1.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.1.1 upgrade
description: Moodle 3.1.1 scheduled release: Monday 11 July 2016
### Response:
1.summary: Upgrade moodle.org to 3.1.1
description:
2.summary: Upgrade learn.moodle.net to 3.1.1
description:
3.summary: Upgrade lang.moodle.org to 3.1.1
description:
4.summary: Upgrade school.demo.moodle.net to 3.1.1
description:
5.summary: Upgrade demo.moodle.net to 3.1.1
description:
6.summary: Upgrade dev.moodle.org to 3.1.1
description:
7.summary: Upgrade moodle.net to 3.1.1
description:
8.summary: Upgrade moodlemoot.org sites to 3.1.1
description:
9.summary: Upgrade download.moodle.org to 3.1.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: List of issues identified to promote the mobile app in core
description: List of issues identified to promote the mobile app in core
| Unsolvable | 1.summary: Add footer promotion of the Mobile app
description: Just like Moodle Docs appears in all footers on themes unless they ignore it or disable it , we should have a "Get Moodle on your Mobile" link appear and link to a landing page with the information related to getting it (not the common one, explain later). This will show no matter if the user is using a mobile device or not - so is very different to smart banners. The URL that they link to can be overridden in the settings if they have their own mobile app - so this setting should be a URL. Only show if mobile services are enabled and the URL is set.
2.summary: Mention in the notifications page when Mobile services are disabled
description: We should display a warning in the notifications page when Mobile services are disabled (same like when the site is not registered)
3.summary: Mention mobile app in user profile page
description: If a user accesses their profile page or notifications config page and mobile is enabled on the moodle site and the user has not yet logged in via the Moodle Mobile App, it should alert the user that they can log in via the app, and if they have logged in via the app the pages should say "Mobile Connected" or something similar. Show the mobile column in prefs page - grayed out, with instructions on how to activate and prompt to download the app to activate
| 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: List of issues identified to promote the mobile app in core
description: List of issues identified to promote the mobile app in core
### Response:
1.summary: Add footer promotion of the Mobile app
description: Just like Moodle Docs appears in all footers on themes unless they ignore it or disable it , we should have a "Get Moodle on your Mobile" link appear and link to a landing page with the information related to getting it (not the common one, explain later). This will show no matter if the user is using a mobile device or not - so is very different to smart banners. The URL that they link to can be overridden in the settings if they have their own mobile app - so this setting should be a URL. Only show if mobile services are enabled and the URL is set.
2.summary: Mention in the notifications page when Mobile services are disabled
description: We should display a warning in the notifications page when Mobile services are disabled (same like when the site is not registered)
3.summary: Mention mobile app in user profile page
description: If a user accesses their profile page or notifications config page and mobile is enabled on the moodle site and the user has not yet logged in via the Moodle Mobile App, it should alert the user that they can log in via the app, and if they have logged in via the app the pages should say "Mobile Connected" or something similar. Show the mobile column in prefs page - grayed out, with instructions on how to activate and prompt to download the app to activate
|
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 the machine learning layer for Moodle 3.8
description: List of issues related to the machine learning layer in Moodle for Moodle 3.8.
| Solvable | 1.summary: Allow the python machine learning backend to run from a separate server
description: Moodle includes two machine learning backends, one written in PHP and a much superior option written in python. The python one is the recommended choice. However, we require sys admins to install the moodle-mlbackend-python package into the web server, which is not ideal as the ML training process affects the web server workload. The communication between Moodle and the python backend is through files (.csv with training data) and, at the moment, the python ML backend reads the input files from the web server filesystem. Sites with multiple frontend servers can use a directory shared among the web servers ( but that is not enough to keep the processes separated. If we want the python backend to live in a separate server we should send the files through HTTP requests to it. We should discuss some points: Do we want a separate mlbackend plugin? We can hide/show admin settings using JS since but even with that having a separate plugin may be clearer. What security measures should we implement? Or should the python ML service be only available in the local network? We should ideally provide security settings to allow people to connect to servers that are not part of the local network. Python Flask to expose the python package functionalities through an API accessible through HTTP? It seems the best candidate. Docker? Once we have the Flask service we can easily setup a docker image for people to quickly deploy a container with it.
| 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 the machine learning layer for Moodle 3.8
description: List of issues related to the machine learning layer in Moodle for Moodle 3.8.
### Response:
1.summary: Allow the python machine learning backend to run from a separate server
description: Moodle includes two machine learning backends, one written in PHP and a much superior option written in python. The python one is the recommended choice. However, we require sys admins to install the moodle-mlbackend-python package into the web server, which is not ideal as the ML training process affects the web server workload. The communication between Moodle and the python backend is through files (.csv with training data) and, at the moment, the python ML backend reads the input files from the web server filesystem. Sites with multiple frontend servers can use a directory shared among the web servers ( but that is not enough to keep the processes separated. If we want the python backend to live in a separate server we should send the files through HTTP requests to it. We should discuss some points: Do we want a separate mlbackend plugin? We can hide/show admin settings using JS since but even with that having a separate plugin may be clearer. What security measures should we implement? Or should the python ML service be only available in the local network? We should ideally provide security settings to allow people to connect to servers that are not part of the local network. Python Flask to expose the python package functionalities through an API accessible through HTTP? It seems the best candidate. Docker? Once we have the Flask service we can easily setup a docker image for people to quickly deploy a container with it.
|
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: Theme Boost: follow ups
description: There are lots of places in moodle where we had custom CSS that does not look good on Boost theme. Most of them were addressed when working on Moodle 3.2 release This epic collects together remaining issues that may or may not be fixed before 3.2 release (November 28th). We appreciate community help on providing patches for these issues. Reminder: due to a jira "feature" list of issues in epic is not visible unless you are logged in.
| Unsolvable | 1.summary: Remove the CSS chunker from Moodle
description: The CSS chunker is a work around a browser bug and a symptom of our own CSS sickness in Moodle. If we drop support for old IE versions we can drop the chunker and simplify our CSS serving code greatly.
2.summary: Improve styling of inplace editables
description: As discussed in , when we switch from text to an inplace editable the styling leaves a little to be desired. We really need to urgently revisit the styling of them because the more we use them, the more that this is visible and detracts from the user interface. Some minor points to consider: the box shape of the editable element (select/text) should match the size of the item it replaces the spinner should not take up additional space the spinner should be on the same line as whatever its next to (no second line) the explanation text should not bump the element width down it should float in some way These are all things which were considered with the original implementation of the inplace editable within the course.
3.summary: Wrap performance information on boost theme to take less space.
description: With performance information displayed in boost theme, the footer is too big and the information is hard to read. It would be nice to have some similar style as in clean theme. Steps to reproduce: with boost theme Set Debug messages to Developer Enable Performance info View page footer and it is too big and aligned vertically.
4.summary: theme_boost: Lot of blank space between courses in course overview block
description: Steps to reproduce: Login as teacher on or go to your site where user is enrolled in some courses and have some pending activities. On the dashboard in course overview page, you will observe lot of gap between courses.
5.summary: Use bootstrap4 styles for inline editing tooltip in boost
description: The inline editing feature is not using bootstrap styles and markup so may not look great in all boost presets and does not use the theme colours.
6.summary: Boost: Group index form is not boosty
description: The groups index form is in a yuky non-boosty way: !Screen Shot 2016-11-15 at 20.52.22.png|thumbnail! Lets see if we can tidy it up without having to rewrite the whole thing..
7.summary: Refactor hard-coded header in the course overview block
description: The course overview block wraps each course title in an header. This is hard-coded in the renderer. This leads to the course name text being very large on the page (see e.g. Its also become an accessibility problem on Boost. On Boost all block instance headers are s. With the hard-coded s you get a hierarchical structure on the dashboard in which s are nested inside an . Inasmuch as the content of this block is actually a list of courses (with information within) I think you could make an argument for reimplementing this as an unordered list. Failing that, the headers should be demoted so that the header hierarchy is semantically valid.
8.summary: Remove the navbar from the dashboard / frontpage.
description: The actual request is for the "Home" and "Dashboard" links to be removed from the nav bar in boost always because they are in the navigation drawer. The header should shrink when there are now no nodes left in it.
9.summary: theme_boost: drawer should add update aria-expanded only after drawer transition is over
description: While working on , it was observed that drawer open takes 0.5 sec and it may fail randomly on faster machines as there is no way to ensure if the drawer is open, even after checking for aria-expanded attribute. It will be nice to ensure drawer is open/closed before updating aria-expanded attribute. Note: Once this is fixed, please remove the css from debug.scss file for drawer.
10.summary: theme_boost: footer text alignment
description: In previous Moodle themes the footer text was centered, in Boost its left aligned and it looks pretty awful.. Cloud are in the process of making a local hack to include our Google Ads banners in the footer, and we need to center the text to make it look acceptable. If no one is against it, we can contribute the text-align patch back to core (its a one liner i think?)
11.summary: Boost admin page "menu" items are too widely spread
description: Looking at the admin page(s), the old menu sections are too far from the links (old sub menu items). It is unpleasant to use and also an accessibility issue for some. Please have the links much closer to the section titles. Instead of col-sm-6 & col-sm-6, maybe user col-sm-3 & col-sm-9 ? Login as manager to: (To see what I am referring to) Also, attaching screen capture with suggested changes
12.summary: Add support for "collapsing" (hiding/showing) blocks in theme "boost"
description: The Boost theme removed the two upper-right icons in blocks that provided the ability to "collapse" and "dock" side blocks. In , a request to add "docking" was alleviated because of "something new," probably the newer side bar. I can understand this. However, I believe that there is still a need to be able to collapse the blocks, meaning that the little "minus" icon should be retained. I believe this because some blocks can get pretty long, and some blocks might not be useful to students, so I desire that students should be able to collapse these blocks. For example, I use the RSS feed blocks to provide easy access to my lecture videos (using podcast technology.) At the end of my semester, this list grows pretty long (see attached graphic.) Additionally, I like to also use a redundant RSS feed block for open-captioned versions of my videos, again long. I like to tell students that they can collapse the block that is of no interest to them. As another example, I provide both the Calendar block and the Upcoming Events block. I like the ability for students to collapse either of these if they happen to prefer one over the other. So I request that the "minus" icon be retained on blocks in the Boost theme. I think that this becomes even more important with Boost since we now have only one side column for blocks. (Incidentally, I really am eager to switch from MORE to Boost, but this inability to collapse blocks might be a show-stopper.)
13.summary: theme_boost: use btn-primary for continue_button renderer
description: The continue_button renderer currently generates a secondary button, which de-emphasise the button. This class is intended to be used when there are mulitple options presented and the current one is low priority, so as not to distract the user from the more important options. The use case for this renderer is you are finished on this page which wants you to read the info above and then acknowledge it with "continue" button before leaving. This almost certainly makes the button the primary call to action on the page in the many places it is used in the codebase.
14.summary: Boost: Unwanted horizontal scroll when editing a quiz
description: Go to Log in as manager Note the horizontal scroll bar
15.summary: UI Challenges when navigating through the site administration menu (theme:Boost)
description: With the Boost theme on by default, it is a major challenge going through the site administration menus and sub menus, as there is no admin block tree open, I need to go back to the site administration page to choose another sub menu on the tree. Try going from: Site administration > Grades > General settings To: Site administration > Grades > Grade category settings Suggestions: (1) Add a link to "Grades" on the breadcrumbs menu. (2) Add "Previous" and "Next" navigation on top and bottom of any admin settings page.
16.summary: Should still seperately display "Turn editing on" button in the Boost theme
description: In the latest 3.2 Boost theme, the most frequently used "turn editing on" button is merged to the course level operations gear dropdown button. This is not reasonable, many teachers feedback they cannot find "turn editing on" button!
17.summary: Styling of the badges/badge page looks bad in Boost.
description: See the attached screenshot here| Youll need to set up a backpack connection to fully appreciate this problem, as the Add to backpack button depends on this, and when present, isnt styled like Boost (btn btn-secondary needed no doubt). The location of the Download button is bad too. It needs to be situated underneath the badge, like on clean. Maybe a display: block css fix?
18.summary: Boost: "Turn Editing On" menu location is different on Front Page compared with Course Page
description: Front Page, Boost: !image-2017-06-15-10-51-42-379.png! Course Page, Boost: !image-2017-06-15-10-52-13-999.png!
19.summary: Boost: "Show cog menu on all pages of a course"
description: Reasoning - the activity settings block used to show on all pages Extra clicks are now required to navigate between settings pages This issue is created from feedback from kosswa and abias (thanks). Extra information: During the development of Boost it was decided to only put this big cog menu on the front page of the thing (course/activity/whatever). There are some pages where it is distracting - the main example was when filling out a settings form. It was suggested to only show the menu on pages with the 2 column layout - which excludes settings forms. Another thing to consider is whether activities should show both the course and activity settings cog menu.
20.summary: Add hook to modify elements in the flat navigation list.
description: The flat navigation list gets built from some items in the nav tree and some specifically chosen course sections. There are plugins which attempt to customise it, but because the existing navigation hooks dont cover the flat navigation there is a limited number of things they can configure. There should be a new hook point that operates on the flat navigation structure after it is built but before it is rendered.
21.summary: Boost: Make all nodes in the breadcrumb clickable
description: Some nodes in the breadcrumb are not associated with a page. This is a bad experience when users want to jump between pages at the same level in the navigation. This was raised by kosswa and abias. Initial list of guilty pages are: "Users", "Reports", "Badges", "My courses".
22.summary: Remove blue outlines from Boost notification/message icons for the mouse users (i.e. fix accessibility / move the focus)
description: When you click on the Boost notification/message icons, then you see a blue outline on the icons (indicating the focus). The focus should be moved to the notification popup. Try with Voiceover, you dont know you are there. I think a nice example is Youtube. Login on Youtube and go to the main page. Navigate with the keyboard till you arrive on your profile image (top bar). Press Enter/Space, the focus is now on the popup. Notice, how the outline did appear on your profile image and, once you pressed Enter/Space, it disappears. The focus moved on the popup, but it is not outlined (not sure if it is easily replicable - I saw some outline:0 in the Youtube css, they may be using some JS detecting keyboard usage to created their own outline). If you were using Voiceover a non-interactive popup element would have been outlined by Voiceover. A counter-argument about accessibility in this Youtube example, could be that the blue outline disappeared on the popup => the user doesnt know where is the focus at this specific time. However it happens when the user doesnt use voiceover, so the user is a visual user, and so he is likely going to guess that the focus is in the popup and the next TAB press will be moving into the popup (this is a hypothesis from me). Finally, and most importantly for the mouse users, when you click on your Youtube user profile image, you see no outlines on your profile image or in the popup. To fix it, maybe you can focus the title element of the Moodle notification/message popup? I didnt try it, but that would be my next move to remove the Boost notification/message blue outline for mouse users.
23.summary: Theme Boost: Improve design / dimensions of page header
description: We came up with this issue especially because on small screens the page header takes so much space whilst it contains very few information. So, we thought of adding media queries to make the dimensions at least on mobile devices smaller. However, I would propose to improve the page header in general. Status quo The page header displays the users name and his avatar on many sites (e.g. dashboard, private files, user profile) Especially the users avatar picture blows up the size of the header My login information is redundant on these sites as they are also displayed in the navbar that always stays in the sight because it is fixied to the top. Improvement proposal Because I know who I am and I can always check my login status in the fixed to top navbar, I would remove users information in the header entirely. The page header cards could get a heading displaying the last breadcrumb title which is the most specific page a user is visiting currently Advantages This would shrink the dimensions of the page header on all screen sizes, which means that there are no special media queries necessary for small screens. Users would not see their name and avatar so often as they know who they are Users get the information which page they are visiting currently with a quick view Mock ups Following some Mockups displaying the status quo and the result of the proposed solution: ||Status quo||Proposal|| |!dashboard_status_quo.png!|!dashboard_proposal.png!| |!private_files_status_quo.png!|!private_files_proposal.png!| |!profile_status_quo.png!|!profile_proposal.png!|
24.summary: Theme Boost: Rearrange the course menu items in more tabs
description: Hi, we bring this up because the new tab structure for the course menu is a really nice feature but it could be optimised in our opinion. We think that the sections Reports, Badges and Question bank do not belong to the course administration in the closer sense. We think they are entities of their own and it would be useful if they would be displayed as own. So users have only those settings grouped together within a tab which belong thematically to each other. This should increase the usability and the access time, because users do not have to remember where to find, for example the badges settings, they just have to select the tab "Badges". A comparison between the status quo and the proposed improvement: !course_menu_status_quo.png|thumbnail! !course_menu_improvement.png|thumbnail! What do you think? Best, Kathrin
| 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: Theme Boost: follow ups
description: There are lots of places in moodle where we had custom CSS that does not look good on Boost theme. Most of them were addressed when working on Moodle 3.2 release This epic collects together remaining issues that may or may not be fixed before 3.2 release (November 28th). We appreciate community help on providing patches for these issues. Reminder: due to a jira "feature" list of issues in epic is not visible unless you are logged in.
### Response:
1.summary: Remove the CSS chunker from Moodle
description: The CSS chunker is a work around a browser bug and a symptom of our own CSS sickness in Moodle. If we drop support for old IE versions we can drop the chunker and simplify our CSS serving code greatly.
2.summary: Improve styling of inplace editables
description: As discussed in , when we switch from text to an inplace editable the styling leaves a little to be desired. We really need to urgently revisit the styling of them because the more we use them, the more that this is visible and detracts from the user interface. Some minor points to consider: the box shape of the editable element (select/text) should match the size of the item it replaces the spinner should not take up additional space the spinner should be on the same line as whatever its next to (no second line) the explanation text should not bump the element width down it should float in some way These are all things which were considered with the original implementation of the inplace editable within the course.
3.summary: Wrap performance information on boost theme to take less space.
description: With performance information displayed in boost theme, the footer is too big and the information is hard to read. It would be nice to have some similar style as in clean theme. Steps to reproduce: with boost theme Set Debug messages to Developer Enable Performance info View page footer and it is too big and aligned vertically.
4.summary: theme_boost: Lot of blank space between courses in course overview block
description: Steps to reproduce: Login as teacher on or go to your site where user is enrolled in some courses and have some pending activities. On the dashboard in course overview page, you will observe lot of gap between courses.
5.summary: Use bootstrap4 styles for inline editing tooltip in boost
description: The inline editing feature is not using bootstrap styles and markup so may not look great in all boost presets and does not use the theme colours.
6.summary: Boost: Group index form is not boosty
description: The groups index form is in a yuky non-boosty way: !Screen Shot 2016-11-15 at 20.52.22.png|thumbnail! Lets see if we can tidy it up without having to rewrite the whole thing..
7.summary: Refactor hard-coded header in the course overview block
description: The course overview block wraps each course title in an header. This is hard-coded in the renderer. This leads to the course name text being very large on the page (see e.g. Its also become an accessibility problem on Boost. On Boost all block instance headers are s. With the hard-coded s you get a hierarchical structure on the dashboard in which s are nested inside an . Inasmuch as the content of this block is actually a list of courses (with information within) I think you could make an argument for reimplementing this as an unordered list. Failing that, the headers should be demoted so that the header hierarchy is semantically valid.
8.summary: Remove the navbar from the dashboard / frontpage.
description: The actual request is for the "Home" and "Dashboard" links to be removed from the nav bar in boost always because they are in the navigation drawer. The header should shrink when there are now no nodes left in it.
9.summary: theme_boost: drawer should add update aria-expanded only after drawer transition is over
description: While working on , it was observed that drawer open takes 0.5 sec and it may fail randomly on faster machines as there is no way to ensure if the drawer is open, even after checking for aria-expanded attribute. It will be nice to ensure drawer is open/closed before updating aria-expanded attribute. Note: Once this is fixed, please remove the css from debug.scss file for drawer.
10.summary: theme_boost: footer text alignment
description: In previous Moodle themes the footer text was centered, in Boost its left aligned and it looks pretty awful.. Cloud are in the process of making a local hack to include our Google Ads banners in the footer, and we need to center the text to make it look acceptable. If no one is against it, we can contribute the text-align patch back to core (its a one liner i think?)
11.summary: Boost admin page "menu" items are too widely spread
description: Looking at the admin page(s), the old menu sections are too far from the links (old sub menu items). It is unpleasant to use and also an accessibility issue for some. Please have the links much closer to the section titles. Instead of col-sm-6 & col-sm-6, maybe user col-sm-3 & col-sm-9 ? Login as manager to: (To see what I am referring to) Also, attaching screen capture with suggested changes
12.summary: Add support for "collapsing" (hiding/showing) blocks in theme "boost"
description: The Boost theme removed the two upper-right icons in blocks that provided the ability to "collapse" and "dock" side blocks. In , a request to add "docking" was alleviated because of "something new," probably the newer side bar. I can understand this. However, I believe that there is still a need to be able to collapse the blocks, meaning that the little "minus" icon should be retained. I believe this because some blocks can get pretty long, and some blocks might not be useful to students, so I desire that students should be able to collapse these blocks. For example, I use the RSS feed blocks to provide easy access to my lecture videos (using podcast technology.) At the end of my semester, this list grows pretty long (see attached graphic.) Additionally, I like to also use a redundant RSS feed block for open-captioned versions of my videos, again long. I like to tell students that they can collapse the block that is of no interest to them. As another example, I provide both the Calendar block and the Upcoming Events block. I like the ability for students to collapse either of these if they happen to prefer one over the other. So I request that the "minus" icon be retained on blocks in the Boost theme. I think that this becomes even more important with Boost since we now have only one side column for blocks. (Incidentally, I really am eager to switch from MORE to Boost, but this inability to collapse blocks might be a show-stopper.)
13.summary: theme_boost: use btn-primary for continue_button renderer
description: The continue_button renderer currently generates a secondary button, which de-emphasise the button. This class is intended to be used when there are mulitple options presented and the current one is low priority, so as not to distract the user from the more important options. The use case for this renderer is you are finished on this page which wants you to read the info above and then acknowledge it with "continue" button before leaving. This almost certainly makes the button the primary call to action on the page in the many places it is used in the codebase.
14.summary: Boost: Unwanted horizontal scroll when editing a quiz
description: Go to Log in as manager Note the horizontal scroll bar
15.summary: UI Challenges when navigating through the site administration menu (theme:Boost)
description: With the Boost theme on by default, it is a major challenge going through the site administration menus and sub menus, as there is no admin block tree open, I need to go back to the site administration page to choose another sub menu on the tree. Try going from: Site administration > Grades > General settings To: Site administration > Grades > Grade category settings Suggestions: (1) Add a link to "Grades" on the breadcrumbs menu. (2) Add "Previous" and "Next" navigation on top and bottom of any admin settings page.
16.summary: Should still seperately display "Turn editing on" button in the Boost theme
description: In the latest 3.2 Boost theme, the most frequently used "turn editing on" button is merged to the course level operations gear dropdown button. This is not reasonable, many teachers feedback they cannot find "turn editing on" button!
17.summary: Styling of the badges/badge page looks bad in Boost.
description: See the attached screenshot here| Youll need to set up a backpack connection to fully appreciate this problem, as the Add to backpack button depends on this, and when present, isnt styled like Boost (btn btn-secondary needed no doubt). The location of the Download button is bad too. It needs to be situated underneath the badge, like on clean. Maybe a display: block css fix?
18.summary: Boost: "Turn Editing On" menu location is different on Front Page compared with Course Page
description: Front Page, Boost: !image-2017-06-15-10-51-42-379.png! Course Page, Boost: !image-2017-06-15-10-52-13-999.png!
19.summary: Boost: "Show cog menu on all pages of a course"
description: Reasoning - the activity settings block used to show on all pages Extra clicks are now required to navigate between settings pages This issue is created from feedback from kosswa and abias (thanks). Extra information: During the development of Boost it was decided to only put this big cog menu on the front page of the thing (course/activity/whatever). There are some pages where it is distracting - the main example was when filling out a settings form. It was suggested to only show the menu on pages with the 2 column layout - which excludes settings forms. Another thing to consider is whether activities should show both the course and activity settings cog menu.
20.summary: Add hook to modify elements in the flat navigation list.
description: The flat navigation list gets built from some items in the nav tree and some specifically chosen course sections. There are plugins which attempt to customise it, but because the existing navigation hooks dont cover the flat navigation there is a limited number of things they can configure. There should be a new hook point that operates on the flat navigation structure after it is built but before it is rendered.
21.summary: Boost: Make all nodes in the breadcrumb clickable
description: Some nodes in the breadcrumb are not associated with a page. This is a bad experience when users want to jump between pages at the same level in the navigation. This was raised by kosswa and abias. Initial list of guilty pages are: "Users", "Reports", "Badges", "My courses".
22.summary: Remove blue outlines from Boost notification/message icons for the mouse users (i.e. fix accessibility / move the focus)
description: When you click on the Boost notification/message icons, then you see a blue outline on the icons (indicating the focus). The focus should be moved to the notification popup. Try with Voiceover, you dont know you are there. I think a nice example is Youtube. Login on Youtube and go to the main page. Navigate with the keyboard till you arrive on your profile image (top bar). Press Enter/Space, the focus is now on the popup. Notice, how the outline did appear on your profile image and, once you pressed Enter/Space, it disappears. The focus moved on the popup, but it is not outlined (not sure if it is easily replicable - I saw some outline:0 in the Youtube css, they may be using some JS detecting keyboard usage to created their own outline). If you were using Voiceover a non-interactive popup element would have been outlined by Voiceover. A counter-argument about accessibility in this Youtube example, could be that the blue outline disappeared on the popup => the user doesnt know where is the focus at this specific time. However it happens when the user doesnt use voiceover, so the user is a visual user, and so he is likely going to guess that the focus is in the popup and the next TAB press will be moving into the popup (this is a hypothesis from me). Finally, and most importantly for the mouse users, when you click on your Youtube user profile image, you see no outlines on your profile image or in the popup. To fix it, maybe you can focus the title element of the Moodle notification/message popup? I didnt try it, but that would be my next move to remove the Boost notification/message blue outline for mouse users.
23.summary: Theme Boost: Improve design / dimensions of page header
description: We came up with this issue especially because on small screens the page header takes so much space whilst it contains very few information. So, we thought of adding media queries to make the dimensions at least on mobile devices smaller. However, I would propose to improve the page header in general. Status quo The page header displays the users name and his avatar on many sites (e.g. dashboard, private files, user profile) Especially the users avatar picture blows up the size of the header My login information is redundant on these sites as they are also displayed in the navbar that always stays in the sight because it is fixied to the top. Improvement proposal Because I know who I am and I can always check my login status in the fixed to top navbar, I would remove users information in the header entirely. The page header cards could get a heading displaying the last breadcrumb title which is the most specific page a user is visiting currently Advantages This would shrink the dimensions of the page header on all screen sizes, which means that there are no special media queries necessary for small screens. Users would not see their name and avatar so often as they know who they are Users get the information which page they are visiting currently with a quick view Mock ups Following some Mockups displaying the status quo and the result of the proposed solution: ||Status quo||Proposal|| |!dashboard_status_quo.png!|!dashboard_proposal.png!| |!private_files_status_quo.png!|!private_files_proposal.png!| |!profile_status_quo.png!|!profile_proposal.png!|
24.summary: Theme Boost: Rearrange the course menu items in more tabs
description: Hi, we bring this up because the new tab structure for the course menu is a really nice feature but it could be optimised in our opinion. We think that the sections Reports, Badges and Question bank do not belong to the course administration in the closer sense. We think they are entities of their own and it would be useful if they would be displayed as own. So users have only those settings grouped together within a tab which belong thematically to each other. This should increase the usability and the access time, because users do not have to remember where to find, for example the badges settings, they just have to select the tab "Badges". A comparison between the status quo and the proposed improvement: !course_menu_status_quo.png|thumbnail! !course_menu_improvement.png|thumbnail! What do you think? Best, Kathrin
|
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: SITES tasks to perform related to Moodle 2.6 release
description: This epic covers all tasks for the SITES team as a consequence of Moodle 2.6 release as per
| Unsolvable | 1.summary: Prepare 2.6 documentation sites
description: According to the release schedule, we should create the new 2.6 docs forked off the current 2.5 one. This applies to /25/en and /25/de. To make this happen: we will need the new "2.6" icon we will need to copy the database+images and modify .htaccess and LocalSettings.php I am ready to perform the second task. i have no idea who is in chanrge for making those icons though. tsala, can you help here?
2.summary: Post about the release on Twitter and other outlets.
description:
3.summary: Create Moodle 2.7 branch in AMOS
description: New "X.Y+1dev" branch to be created in AMOS, to have master changes performed there. This needs to be done anytime during the on-sync period.
4.summary: Update docs setup to use 2.6 by default
description: For en and de Moodle Docs, update default redirects, enable email notifications and add version links to
5.summary: Upgrade all moodle.org and moodle.net sites to latest release version
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: SITES tasks to perform related to Moodle 2.6 release
description: This epic covers all tasks for the SITES team as a consequence of Moodle 2.6 release as per
### Response:
1.summary: Prepare 2.6 documentation sites
description: According to the release schedule, we should create the new 2.6 docs forked off the current 2.5 one. This applies to /25/en and /25/de. To make this happen: we will need the new "2.6" icon we will need to copy the database+images and modify .htaccess and LocalSettings.php I am ready to perform the second task. i have no idea who is in chanrge for making those icons though. tsala, can you help here?
2.summary: Post about the release on Twitter and other outlets.
description:
3.summary: Create Moodle 2.7 branch in AMOS
description: New "X.Y+1dev" branch to be created in AMOS, to have master changes performed there. This needs to be done anytime during the on-sync period.
4.summary: Update docs setup to use 2.6 by default
description: For en and de Moodle Docs, update default redirects, enable email notifications and add version links to
5.summary: Upgrade all moodle.org and moodle.net sites to latest release version
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: GDPR Subject Access Request and Data Registry
description: This epic is to cover the creation of a new privacy subsystem, plus associated component implementations of that subsystem, plus an admin tool to access the data within it. This is part of the work towards .
| Unsolvable | 1.summary: Use a context-children-based method to retrieve the list of course blocks
description: tool_dataprivacy is currently fetching blocks using get_course_blocks external function, which retrieves blocks instances ready to be displayed, we want access to all block instances regardless of their contents being visible to users.
2.summary: Implement providers for core_portfolio and portfolio_xx plugins
description: Implement providers for core_portfolio. This includes: Subsystem provider Subsystem interface for portfolio plugins to implement Reference portfolio plugin (Mahara) provider implementation
3.summary: Create a process to send a request to the site data protection officer
description: Create a simple form to send a request to the site data protection officer. By creating the form in Moodle, we can verify the identity of the user making the request. The record of the request should be stored in Moodle and an email sent directly to the data protection officer. We can then describe the process of contacting the data protection officer on the privacy policy page. ||User Stories||Acceptance Criteria|| |As a Moodle administrator I want moodle to provide a form for contacting the data protection officer for my moodle site.| There is a site admin setting "contactdataprotectionofficerthroughmoodle" If enabled, users will be provided links from the site privacy policy, as well as from their own profile page to contact the sites data protection officer. The link will go to a new form with simple instructions and a text box for providing more details. When submitted - a record of the request will be stored and an email will be sent to the data protection officer. The language of these automated links will respect the users current language.| |As a Moodle administrator with an alternate process for contacting my data protection officer, I do not want these requests to go through moodle.| I can disable the new setting and no automatic links will be shown in the privacy policy or in users profiles. I can write manual instructions for contacting the data protection officer in my privacy policy.|
4.summary: Delete personal data when it is no longer required
description: This is a new setting that will allow user data to be anonymised if a user has not logged into Moodle for X period (years?). We should exclude site admins and consider what will happen with ldap syncs etc. ||User Stories||Acceptance Criteria|| |Moodle should delete personal data when it is no longer required in order to comply with the principals of "privacy by design".| There should be a site administration setting (under privacy) which will delete user data automatically if they have not been used for X period. Admin accounts should never be deleted according to this setting. Authentication plugins should be able to specify that their users are exempt (e.g. ldap users). If a user matches this criteria, they should be deleted from Moodle using the standard deletion functions.|
5.summary: Create new privacy subsystem
description: We need to create the required basis for the new privacy subsystem in which the new metadata and request PHP interfaces will exist, as well as the helper API functions.
6.summary: Implement request interface for mod_assign
description: This is an issue to track the creation of a prototype PHP Interface for \core\privacy\request as the API negotiating Subject Access Requests in the assignment module.
7.summary: Implement request interface for mod_forum
description: This is an issue to track the creation of a prototype PHP Interface for \core\privacy\request as the API negotiating Subject Access Requests in the forum module.
8.summary: Allow the Privacy Officer to create categories and purposes for data (in the tool)
description: From the user stories: 1. As a Privacy Officer I want to be able to add and edit the categories of personal data in my institution. Moodle should provide a report listing categories of personal data, with options to edit existing items, or create new items. Only users with relevant capability should be allowed to add/edit. 2. As a Privacy Officer, I want to be able add and edit the purposes for collection of personal data in my institution. Moodle should provide a report listing purposes for capturing personal data, with options to edit existing items, or create new items. Only users with relevant capability should be allowed to add/edit. I should be able to provide a default value for retention period during this add/edit process. When creating a purpose there should also be a checkbox or something similar for stopping user deletion requests from being granted. Some purposes such as keeping grades has a higher standing for retention above the right to be forgotten. This flag would ensure that the areas that use this purpose do not have user data deleted from users making such requests.
9.summary: Implement providers for non-data blocks
description: Implement the privacy provider API for blocks which have no real data.
10.summary: Implement providers for block_html
description: Implement providers for block_html
11.summary: Implement providers for mod_quiz
description: Attempt to write mod_quiz providers for the in-progress SAR API.
12.summary: Implement providers for mod_choice
description: Attempt to write mod_choice providers for the in-progress SAR API.
13.summary: Create the registry for adding the purpose and retention periods.
description: We require a registry to list the context / component tree and allow a purpose and retention period (among other settings) to be applied to each level of the tree. The most granular item would be an instance of an activity (module). Need to confirm that this doesnt go down to sub-plugin. It should be possible to set the purpose and retention period for a context and and have it be applied to all of its children down the tree. The form should have a checkbox for applying the setting to the child elements that by default is unchecked. Checking this box will apply the setting to the child elements but will put up a warning saying that the Privacy Officer (PO) needs to review every section to demonstrate compliance. The purpose select element should start with two options Options. Inherit from parent (unset) Inherit from parent By default "Inherit from parent (unset)" allows for each element in the tree to be flagged, requiring attention from the PO. If "Inherit from parent" is set then the attention flag is removed. The tree on the left should show all context / component items, but have a toggle to only show areas that need attention. When setting the purpose / retention period settings, the purpose should be selectable and the retention period should only be shown (not selectable). To set a different retention period a new purpose will have to be created. Related user stories ||User Stories||Acceptance Criteria|| |As a Privacy officer, I want to be able to quickly see which areas of Moodle I have not set the purpose and retention periods for user data.| Moodle should provide a report that shows the current system and which areas have not had the purpose and retention periods specified in relation to user data. Updating the purpose and retention period will mean that this area will no longer show as requiring attention.| |As a privacy officer, I want to be able to efficiently set purposes and retention periods for existing content in my Moodle system.| At each level of the context tree (System, Course category, course, activity, etc.) it should be possible to set the purpose and retention period for user data and have this setting be applied to all child areas. (e.g. I go to a course and set the purpose and retention period and then have it apply it to all activities in that course). The default purpose for all existing items in a site should be set to Not set (currently inheriting) meaning fewer changes will be needed for compliance.|
14.summary: Create backend needed to store purpose, category, retention against contextid
description: This allows work on the UI to be started. Given an item in the context tree (a specific course or course module, etc), we need to be able to set its category and purpose and store this in the Data Privacy tool. This issue is about the back end only. Note: Categories and purposes are user-configurable - see . Do we link these or copy these when storing the relationship between contextid/component and purpose/category? - This is up for discussion on this issue.
15.summary: Allow privacy metadata to be stored in the Data Privacy tool
description: Reads data from the manager::get_metadata_for_components() call - an assoc array of item collections indexed by frankenstyle component names - which needs to be stored in some sort of a metadata summary table in the tool. Should make CRUD methods too, as the tool may need to remove or update metadata as plugins change after install/removal.
16.summary: Create a report showing component compliance
description: NEEDS UX DESIGNS! Should highlight and distinguish between those components which: Are compliant and dont store data Are compliant and do store data Are not compliant (meaning some implementations are missing in their code base) Used as a system audit/review tool primarily.
17.summary: Create a process for updating privacy metadata on upgrade/install
description: Privacy subsystem should fetch and broadcast new metadata to any plugins needing to know about the changes - for now, just the Data Privacy plugin - but should work generically. Given we cant use hooks during upgrade/install, we may need to ask the core privacy subsystem to schedule an adhoc task to fetch and inform other plugins (via a hook).
18.summary: Create a way to store the defaults for purpose and retention for each context level
description: We need a page where we can set the defaults for purpose and retention for each context. Besides site, each of the settings would have inherit in the select options. These defaults would then be what is selected by default when a new item is created after this point in time (existing items would not be affected). Related user story || User Stories || Acceptance Criteria || | As a privacy officer, I want to be able to set defaults for all the contexts in Moodle, so that when creating new instances (course, mod, etc), the default purpose can be used. | The Data Privacy tool should provide a setting for each of the contexts, allowing a default purpose to be set for that context. Values should include: Inherit Others from the list created by the PO. System context must exclude Inherit from its list. |
19.summary: Provide a way to set the purpose and retention across a context level
description: To help set purposes and retention information effectively we would like a way to set this across a context level i.e. I want all courses to have the same purpose and retention period. Related user story || User Stories || Acceptance Criteria || | As a privacy officer, I want to be able to apply the default value for context to all existing instances at that context only. E.g. Apply a default of Education to all course categories. | Data Privacy tool to provide a new page allowing application of default values to existing data within that context. Page should allow the PO to choose the context on which to act, the purpose to apply to items, and an option to override existing values (defaulted to not set). |
20.summary: Implement subsystem provider for plagiarism API
description: Note: This is a hard one. We need to work out what to do here because there is no consistent API at this stage.
21.summary: Implement core_privacy for core themes
description: These are likely to be easy as I dont believe we store any user data: theme_bootstrapbase theme_clean theme_more theme_boost
22.summary: Implement core_privacy for null providing activities
description: Adrian suggests: mod_resource mod_folder mod_label There may be others too. See if there are any other activity modules which we can get out of the way quickly.
23.summary: Implement core_privacy for repositories and core_repository
description: Lets take a look at repositories and see if we can fully implement the core_privacy API for at least one.
24.summary: Implement core_privacy for a course format
description: Implement core_privacy for at least one course format.
25.summary: Implement core_privacy for an tool_usertours
description: Perhaps user tours
26.summary: Implement core_privacy for atto subplugins
description: Look at both atto, and all plugins. I think the only one which saves data is to do with draft autosaving.
27.summary: Implement core_privacy for calendar types
description: Implement core_privacy for calendar types
28.summary: Connect the Data Privacy tool to the subsystems manager to facilitate data export
description: Heres what needs to be done: 1. New table tool_dataprivacy_request_contexts to hold contexts for a given request Should have cols: - requestid - component - contextid - status (for now: pending, approved, rejected but allow for more) 2. New constants in the api class to hold the context statuses above (pending , approved, rejected etc) 3. New request made adhoc task updates: - generate the contextlist_collection - for each contextlist: store the component, context, etc in tool_dataprivacy_request_contexts table - progress the request (current code does this already) 4. At the point of approving (before scheduling the adhoc task): - set status of all respective contexts in the table to approved (may evolve to a UI control eventually) 5. Request approved adhoc task updates: - fetch list of approved contexts (those with status approved) - reassemble a contextlist collection for these using approved_contextlist instead of contextlist. - pass to manager->export() - TODO: consider how to mop up the contexts in the tool_dataprivacy_request_contexts table. Do we do now or later? (scheduled task ?) Note: This work should be based on the tool: and on -- work.
29.summary: action_menu UI component extension
description: I would love to slightly extend action_menu and family. This would greatly help us make GDPRs data registry compatible with both bootstrap 2 and bootstrap 4 themes.
30.summary: New block_instance_by_id blocks API method
description: Another issue that would help us with GDPR data registry. We can survive without it but it does not seem risky and it should be easily backportable.
31.summary: Implement core_privacy for message airnotifier.
description: Lets take a look at messages and see if we can fully implement the core_privacy API for at least one.
32.summary: Implement provider in the dataprivacy tool
description: Implement and pull request here:
33.summary: Use tool_dataprivacy prefix for the data privacy tables
description: Convention states that table names of plugins should be named in the Frankenstyle format. We should rename the plugins tables to use the tool_dataprivacy as table prefix.
34.summary: Use expectException in unit tests in the privacy tool
description: Travis is complaining about empty catch statements in api_test.php: noformat FILE: /home/travis/moodle/admin/tool/dataprivacy/tests/api_test.php ------------------------------------------------------------------------------------------------------------------------ FOUND 8 ERRORS AND 14 WARNINGS AFFECTING 16 LINES ------------------------------------------------------------------------------------------------------------------------ 527 | ERROR | Empty CATCH statement detected 545 | ERROR | Empty CATCH statement detected 553 | ERROR | Empty CATCH statement detected 560 | ERROR | Empty CATCH statement detected 621 | ERROR | Empty CATCH statement detected 638 | ERROR | Empty CATCH statement detected 646 | ERROR | Empty CATCH statement detected 653 | ERROR | Empty CATCH statement detected ------------------------------------------------------------------------------------------------------------------------ noformat Perhaps using expectException is better.
35.summary: Extend link_subsystem calls to allow components to specify privacy fields when linking
description: Looking at the portfolio (and this may be the case for some other areas too), I see a situation where a given component calls the portfolio subsystem, which links to the plugin types (portfolio). The plugin types (Mahara for example) link externally. The issue I see here is that only the component (lets use forum as an example), knows what data it passes to the subsystem, and which subsequently gets exported externally. The subsystem and the plugins just pass it along, and dont know this. To me, it sounds like we need a way to say something like "Link subsystem with this data" - which we currently dont have with the link subsystem class. Right now, we dont / cant describe metadata about the fields sent externally through this flow: forum -> portfolio subsystem -> mahara plugin. Id think one way to address this would be to allow passing in fields to link_subsystem.
36.summary: Implement core_privacy for core_calendar
description: Implement privacy provider for core_calendar.
37.summary: Add a cache for purposes
description: We could also add one for categories but the really important one is for purposes as purposes contain retention periods and retention periods is what we need to fetch while calculating which contexts should be deleted.
38.summary: Implement core_privacy for a message email.
description: Implement the privacy provider for message email.
39.summary: Missing polyfill for plagiarism provider interface
description: Mentioned on . Need to provide this polyfill for plugins to use.
40.summary: Merge data privacy settings and links to the common Privacy and Policy admin tree branch
description: The summary describes pretty much everything.
41.summary: Add a global enable / disable delete expired contexts (according to data registry)
description: The data registry is useful to set a retention period to each moodle context instance. The consequences of not setting retention periods properly can be horrible e.g. 0 years retention period assigned at user context means that all users without ongoing courses will be deleted :) We need moodle admins to explicitly enable this feature before stuff gets deleted automatically. I intentionally allowed users to set a 0 years retention period, we may want to reconsider this.
42.summary: Implement core_privacy for a message jabber.
description: Implement the privacy provider for message jabber.
43.summary: Implement core_privacy for message popup.
description: Implement the privacy provider for message popup.
44.summary: Allow admins to confirm which expired contexts should be deleted
description: In we introduced a scheduled task that iterates through expired contexts (expired according its retention period) At the moment we just delete them but ideally we would provide a report for admins so they can confirm which contexts should be deleted. ||User Story||Acceptance Criteria|| |As a privacy officer, I want to be able to view a report listing data which should no longer be held, so that I can select which data to remove to comply with the principle of "Privacy by Design".| Moodle will provide a report listing all types of data which has passed its retention period, so that the Privacy Officer can review and choose which data areas are to be erased. This report will highlight data areas (courses, plugins, etc) and will not include the actual data itself. Choosing to delete all selected data should queue the selected data for deletion. Scheduled task will run to look for queued jobs and will remove the relevant data (that which the Privacy Officer selected). Admin account and any associated data must be considered exempt from the deletion process (see next point).|
45.summary: Implement core_privacy for block rss client
description: Implement the privacy provider for block_rss_client.
46.summary: Implement provider for tool_monitor
description: Implement the core_privacy provider for tool_monitor.
47.summary: Implement the privacy provider for core_user.
description: Implement the core_privacy provider for core_user.
48.summary: Implement providers for block_community
description: Implement providers for block_community
49.summary: Allow admins to confirm which expired contexts should be deleted: UI part
description: Build the UI part of the deletion workflow for expired contexts: ||User Story||Acceptance Criteria|| |As a privacy officer, I want to be able to view a report listing data which should no longer be held, so that I can select which data to remove to comply with the principle of "Privacy by Design".| Moodle will provide a report listing all types of data which has passed its retention period, so that the Privacy Officer can review and choose which data areas are to be erased. This report will highlight data areas (courses, plugins, etc) and will not include the actual data itself. Choosing to delete all selected data should queue the selected data for deletion. |
50.summary: Honour protected purposes during deletion requests
description: Purposes have a protected field which description states that The retention of this data has a higher legal precedent over a users request to be forgotten. This data will only be deleted after the retention period has expired Deletion requests should honour that protected field, skipping protected contexts. Pasting a conversation from SAR team chat: code Andrew Nicols, 03.04.18 14:18 It should be in here: Andrew Nicols, 03.04.18 14:18 Yes... but thats within the tool Andrew Nicols, 03.04.18 14:18 The API just deletes what it is told. DavidMonllao, 03.04.18 14:18 e.g. a user request to be forgotten is granted, we go through all the contexts where the user did something skipping the ones flagged as protected Andrew Nicols, 03.04.18 14:19 Yup Andrew Nicols, 03.04.18 14:19 Thats where we should do it DavidMonllao, 03.04.18 14:19 it looks like it would be a good fit for get_contexts_for_userid Andrew Nicols, 03.04.18 14:19 Sorry, I thought that youd done that part. Andrew Nicols, 03.04.18 14:20 My bad :) DavidMonllao, 03.04.18 14:20 np np Andrew Nicols, 03.04.18 14:20 How do you mean? DavidMonllao, 03.04.18 14:20 get_contexts_for_userid is only called for deletion requests is that right? Andrew Nicols, 03.04.18 14:20 No... its called for export requests too DavidMonllao, 03.04.18 14:20 then maybe delete_user_data Andrew Nicols, 03.04.18 14:20 It is the duty of the tool, not the privacy API Andrew Nicols, 03.04.18 14:21 The privacy API just deletes what it is told. The tool is the only part aware of protected contexts, and it is the one responsible for calling the API with the correct data. Andrew Nicols, 03.04.18 14:21 It may be helpful if we add a function to the approved_contextlist class to remove_contexts(array $contextids) Andrew Nicols, 03.04.18 14:22 So that when we re-hydrate the contextlist on line we can remove the ones which shoudl not be there Andrew Nicols, 03.04.18 14:23 $contextlist = new \core_privacy\local\request\approved_contextlist($foruser, $contextlist->get_component(), $contextlist->get_contextids()); $contextlist->remove_contexts($blacklistedids); $approvedcollection->add_contextlist($contextlist); Andrew Nicols, 03.04.18 14:25 Alternatively, well do that when we fetch the contextlists into the approved contextlist. Andrew Nicols, 03.04.18 14:25 At the moment were just fetching all contexts from get_contexts_for_userid and turning them into an apporved_contextlist. There is a todo on line 109 to use the DB that Jake has been desigining. Andrew Nicols, 03.04.18 14:26 When we do that, well be able to link against the table for protected ones and just exclude them I presum.e code
51.summary: Implement core_privacy for report progress
description: Implement the privacy provider for report progress.
52.summary: Implement core_privacy for report completion
description: Implement the privacy provider for report completion.
53.summary: Implement core_privacy for dataformat plugins.
description: Implement core_privacy for dataformat plugins.
54.summary: Implement providers for auth_manual
description: Attempt to write auth_manual providers for the in-progress SAR API.
55.summary: Implement core_privacy for mod_feedback
description: See summary.
56.summary: Implement providers for core_notes
description: Implement providers for core_notes
57.summary: Implement core_privacy for fileconverter_unoconv
description: Implement core_privacy for fileconverter_unoconv.
58.summary: Implement core_privacy for auth plugins (not oaut and manual)
description: Probably all null providers. (Not auth_oaut and auth_manual ) auth_cas auth_db auth_email auth_ldap auth_lti auth_mnet auth_nologin auth_none auth_shibboleth auth_webservice For Moodle 3.3.5 has to: auth_imap auth_fc auth_pam auth_pop3 auth_nntp
59.summary: Split out manager->get_components_list into a core function
description: This list of frankenstyle names for all core components (plugins + core subsystems) is used all over the place in both this project and in places in core too (search and others). We should have a function in core_component which provides this, instead of having to assemble this list manually all over the place. This change should introduce the function in core and make the manager use this instead of its current internal implementation.
60.summary: Implement core_privacy for core_competency
description: See summary.
61.summary: Implement core_privacy for fileconverter_googledrive
description: Implement core_privacy for fileconverter_googledrive
62.summary: Implement providers for report components
description: Implement providers for report components
63.summary: Implement providers for auth_oaut
description: Implement providers for auth_oaut
64.summary: Implement core_privacy for admin/tool components.
description: Implement the null privacy provider for admin/tool components which have been identified not to store any personal data. NOTE: there are some additional admin/tools not covered in this ticket because they were flagged to maybe store personal data / preferences. These remaining admin/tools will be addressed in separate issues.
65.summary: Include tool_dataprivacy in core
description: This issue is about including in core and it is closely related to privacy API and .
66.summary: Implement core_privacy for media plugins.
description: Implement core_privacy for media plugins.
67.summary: Implement core_privacy for webservice plugins.
description: Implement core_privacy for webservice plugins.
68.summary: Implement core_privacy for mod_workshop
description: Implement the privacy API in the Workshop module
69.summary: Implement core_privacy for enrol plugins (not lti and paypal)
description: Probably all null providers. (Not enrol_lti and enrol_paypal). enrol_category enrol_cohort enrol_database enrol_flatfile enrol_guest enrol_imsenterprise enrol_ldap enrol_manual enrol_meta enrol_mnet enrol_self
70.summary: Implement core_privacy for course format plugins
description: Probably all null providers. format_singleactivity format_social format_topics format_weeks
71.summary: Implement core_privacy for assignment plugins.
description: Implement core_privacy for assignment plugins.
72.summary: Provide means for the Privacy Officer to set lawful basis for defining purposes for collection of personal data
description: We need to add form controls that let the Privacy Officer select one or more items defined in GDPR Art 6: Lawfulness of processing and GDPR Art 9: Sensitive Personal Data.
73.summary: Implement core_privacy for mod_data and datafields
description: Implement core_privacy for mod_data and datafields: datafield_checkbox datafield_date datafield_file datafield_latlong datafield_menu datafield_multimenu datafield_number datafield_picture datafield_radiobutton datafield_text datafield_textarea datafield_url
74.summary: Implement the privacy provider for core_role
description: Implement the privacy provider for core_role. According to the comments, core_role has data.
75.summary: Implement providers for tool_mobile
description: Implement core_privacy for admin/tool/mobile. It has a user preference: tool_mobile_autologin_request_last
76.summary: Implement providers for core_register
description: Implements Null Provider.
77.summary: Implement providers for core_my
description: Implement providers for core_my
78.summary: Implement core_privacy for core media.
description: Implement core_privacy for core media.
79.summary: Implement core_privacy for core_grading, gradingform_guide and gradingform_rubric
description: Implement core_privacy for: core_grading gradingform_guide gradingform_rubric
80.summary: Implement core_privacy API for gradeexport
description: Implement core_privacy for gradeexport plugins: gradeexport_ods gradeexport_txt gradeexport_xls gradeexport_xml
81.summary: Implement core_privacy API for gradeimport
description: Implement core_privacy for gradeimport plugins: gradeimport_csv gradeimport_direct gradeimport_xml
82.summary: Delete users for deletion requests and expired context_user
description: We delete all data associated to a user in all components but we do not yet delete the user itself. This issue is about that.
83.summary: Implement core_privacy API for gradereport
description: Implement core_privacy for gradereport plugins: gradereport_grader gradereport_history gradereport_outcomes gradereport_overview gradereport_singleview gradereport_user
84.summary: Implement core_privacy API for core_rss
description: Implement core_privacy for core_rss
85.summary: Implement core_privacy for mod_scorm
description: Implement the privacy API in the SCORM module.
86.summary: Implement core_privacy API for datapreset_imagegallery
description: Implement core_privacy API for datapreset_imagegallery.
87.summary: Implement core_privacy for mod_survey
description: See summary.
88.summary: Implement core_privacy for profilefield plugins.
description: Implement core_privacy for profilefield plugins.
89.summary: Implement core_privacy for tool_recyclebin
description: Implement null provider for tool_recyclebin This plugin does have a database table tool_recyclebin_course but it does not contain any identifying user data. No userid is tracked within this tables records.
90.summary: Implement core_privacy for mod_wiki
description: Implement core_privacy for mod_wiki On data deletion request: - Individual wikis to be removed completely - Contributions to collaborative wikis remain
91.summary: Implement core_privacy for tool_profiling
description: Implement null providers for tool_profiling. This plugin does access data from the mdl_profiling table, where the data is inserted by the lib/xhprof/xhprof_moodle.php script -> function profiling_import_runs(). However, the mdl_profiling table does not contain any user identifiable data.
92.summary: Implement core_privacy for tool_cohortroles
description: Implement metadata and plugin providers for tool_cohortroles. This plugin stores user data in the mdl_tool_cohortroles table.
93.summary: Implement core_privacy for booktool plugins
description: Implement core_privacy for booktool plugins.
94.summary: Implement core_privacy for mod_chat
description: See summary.
95.summary: Implement core_privacy for mod_lesson
description: See summary.
96.summary: Implement core_privacy for profilefield_checkbox
description: Implement core_privacy for profilefield_checkbox.
97.summary: Implement providers for mod_glossary
description: Attempt to write mod_glossary providers for the in-progress SAR API.
98.summary: Implement core_privacy for tool_assignmentupgrade
description: The tool_assignmentupgrade plugin contains a user preference tool_assignmentupgrade_perpage setting.
99.summary: Implement core_privacy API for core_cohort
description: Implement core_privacy for core_cohort
100.summary: Implement providers for block_comments
description: Attempt to write mod_glossary providers for the in-progress SAR API.
101.summary: Implement core_privacy for profilefield_datetime
description: Implement core_privacy for profilefield_datetime.
102.summary: Implement core_privacy for core_grades
description: See summary.
103.summary: Implement core_privacy for core_enrol
description: Implement core_privacy for core_enrol
104.summary: Expand data registry usage information / help
description: It may be worth expanding the data registry information (help buttons / info messages) as it is a complex tool and some aspects of it may not be obvious. This issue shouldnt introduce traumatic changes, just new messages around.
105.summary: Implement core_privacy for profilefield_menu
description: Implement core_privacy for profilefield_menu.
106.summary: Implement core_privacy for profilefield_text
description: Implement core_privacy for profilefield_text.
107.summary: Implement core_privacy for profilefield_textarea
description: Implement core_privacy for profilefield_textarea.
108.summary: Implement core_privacy for a core_userkey
description: This is a bit more complex than others as this subsystem does not have a data directory just yet.
109.summary: Extend core_privacy_testsuite to check that the database table exists
description: This will catch typos and ensure we arent returning invalid metadata.
110.summary: Implement core_privacy API for mod_imscp
description: Implement core_privacy for mod_imscp
111.summary: Implement providers for mod_book
description: Attempt to write mod_book providers for the in-progress SAR API.
112.summary: Implement core_privacy for core_filters
description: core_filters does not define any data.
113.summary: Implement providers for enrol_paypal
description: Attempt to write enrol_paypal providers for the in-progress SAR API.
114.summary: Add error handling for exports and deletes
description: At the moment if any plugins privacy API implementation causes an exception, the whole request fails. Arguably this is correct - we want to make sure the request completed correctly wherever possible, however it may be worth adding some try/catch checks around some requests to allow requests to come to some level of completion and instead alert an administrator somehow. Also consider rolling back database transactions.
115.summary: Implement core_privacy for tool_log and subplugins
description: See summary.
116.summary: Implement providers for core_hub and core_publish
description: Implement providers for core_hub and core_publish. Review core_register and block_community Putting them all together because they all are part of moodle.net / hub communication Note, code is different for Moodle 3.3 !
117.summary: Implement core_privacy for the completion component
description: Add privacy information for the completion component.
118.summary: Merge together core subsystems core_hub, core_register and core_publish
description: core_component::fetch_subsystems() : code hub => null, publish => $CFG->dirroot./course/publish, register => $CFG->dirroot./.$CFG->admin./registration, // Broken badly if $CFG->admin changed. code lib/classes/hub/, lang/en/hub.php - present, contain classes and strings for all three subsystems admin/registration/classes/ and lang/en/register.php - created during GDPR work for privacy API implementations course/publish/classes/, lang/en/publish.php - do not exist but would need to be created for privacy API implementations otherwise, see Basically, there is no reason for components core_publish and core_reigster to exist
119.summary: Add helper functions to add system and user context to contextlist
description: Lets have helper functions so we can help developers add some commonly used contexts (ie. system for messaging).
120.summary: Make sure every table in lib/db/install.xml has a core subsystem responsible for it
description: When we go through the list of core subsystems we may accidentally "forget" some database tables that have user data because there is no strict relation tablecomponent Go through all tables defined in lib/db/install.xml that may have user data and make sure it is covered by one of the core components There are a few places where we have specifically excluded the tables. Nevertheless, we should probably describe the table in metadata. ||Table||Field||Decision||Issue|| ||config_log||userid|TODO core|| ||upgrade_log||userid|TODO core|| ||my_pages||userid|Specifically excluded but should we add metadata?|| ||user_preferences||userid|TODO core|| ||scale||userid|Needs to be done in core_grade|| ||scale_history||loggeduser, userid|Needs to be done in core_grade|| ||role_sortorder||userid|Needs to be done in core_role|| ||events_queue||userid|TODO|| ||grade_import_newitem||importer|Temporary tables only|| ||grade_import_values||importer, userid|Temporary tables only|| ||portfolio_log||userid|TODO - needs exporting|| ||portfolio_tempdata||userid|TODO|| ||backup_controllers||userid|Already done|N/A| ||grading_instances||raterid|Already done|N/A| ||task_adhoc||userid|TODO core|| ||chat_messages_current||userid|TODO|| ||chat_users||userid|TODO|| ||forum_queue||userid|TODO|| ||enrol_flatfile||userid|TODO|| ||enrol_lti_users||userid|Already done|N/A| ||block_recent_activity||userid|TODO|| ||tool_policy_versions||usermodified|TODO|| ||logstore_standard_log||userid|Incorrect name||
121.summary: Implement core_privacy for core_badges
description: See summary.
122.summary: Implement core_privacy for mod_assignment
description: Implement core_privacy for mod_assignment.
123.summary: Implement core_privacy for core_fileconverter
description: See summary.
124.summary: Implement core_privacy for tool_messageinbound
description: See summary.
125.summary: Implement core_privacy for core_search and search engine plugins
description: Implement core_privacy for core_search and search engine plugins
126.summary: Implement core_privacy for core_analytics and machine learning backend plugins
description: Implement core_privacy for core_analytics and machine learning backend plugins
127.summary: The RSS subsystem incorrectly implements \core_privacy\local\request\plugin\provider
description: It will make no difference, for now. However, we should fix this now rather than wait for it to explode.
128.summary: Implement providers for block_recent_activity
description: Attempt to write block_recent_activity providers for the in-progress SAR API.
129.summary: Implement core_privacy for core_files
description: See summary.
130.summary: Implement core_privacy for core_webservice
description: See summary.
131.summary: Implement core_privacy for core_block
description: See summary.
132.summary: Revisit the privacy provider of block_tag_flickr
description: This block requires configuration (preferred tags, ...) which could be seen as user information, and that information is shared with an external system.
133.summary: Implement core_privacy for core_auth
description: See summary.
134.summary: Implement core_privacy for mnetservice_enrol
description: Implement core_privacy for mnetservice_enrol.
135.summary: Implement core_privacy API for core_access
description: Implement core_privacy for core_access
136.summary: Implement core_privacy for mnet
description: Implement core_privacy for mnet, will be probably a null_provider. DB Table mnet_sso_access_control is not needed declare and export. The field username isnt linked to any table. This field is used to allow or deny specific access to a user with this username. But it doesnt created a link with the user. auth_mnet implements: DB Tables, mnet_session and mnet_log. mnetservice_enrol implements: DB Table, mnetservice_enrol_enrolments
137.summary: Implement core_privacy API for core_availability
description: Implement core_privacy for core_availability
138.summary: Implement provider for core_backup
description: Yeh.
139.summary: Implement the privacy provider for core_admin
description: Implements Null Provider. Also, these are all core subsystems and well implement them in other issues.
140.summary: Implement provider for core_form
description: There are user preference sin filemanager.js. Check to see if theyre handled elsewhere or not (such as files).
141.summary: Implement providers for core_group
description: Attempt to write core_group providers for the in-progress SAR API.
142.summary: Implement core_privacy for core_antivirus
description: This was missed in ;(
143.summary: If backup data contains information of a user that has asked to be deleted we should not restore it
description: The core_backup provider implemented in does not actively remove user data from the backup (because that would be insane), so when restoring these backups we should ignore users who dont want to be remembered.
144.summary: enrol_meta to export/delete groups
description: enrol_meta privacy provider should also export and delete the group memberships it is responsible for.
145.summary: enrol_cohort to export/delete groups
description: enrol_cohort privacy provider should also export and delete the group memberships it is responsible for.
146.summary: Implement providers for enrol_lti
description: Implement providers for enrol_lti.
147.summary: Performance fixes for some providers
description: Weve discovered some issues due to joins which dont scale well with large numbers of records. The one which we discovered this with is assign and its because the query planner in some engines doesnt deal well with joins where the filter is only in the WHERE (when it should be on the JOIN). Thankfully this only effects providers, and only those which do complex joins, and thankfully these are mostly extremely well unit tested now.
148.summary: Make JSON output pretty
description: As requested by several people, we should look at making the JSON output pretty.
| 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: GDPR Subject Access Request and Data Registry
description: This epic is to cover the creation of a new privacy subsystem, plus associated component implementations of that subsystem, plus an admin tool to access the data within it. This is part of the work towards .
### Response:
1.summary: Use a context-children-based method to retrieve the list of course blocks
description: tool_dataprivacy is currently fetching blocks using get_course_blocks external function, which retrieves blocks instances ready to be displayed, we want access to all block instances regardless of their contents being visible to users.
2.summary: Implement providers for core_portfolio and portfolio_xx plugins
description: Implement providers for core_portfolio. This includes: Subsystem provider Subsystem interface for portfolio plugins to implement Reference portfolio plugin (Mahara) provider implementation
3.summary: Create a process to send a request to the site data protection officer
description: Create a simple form to send a request to the site data protection officer. By creating the form in Moodle, we can verify the identity of the user making the request. The record of the request should be stored in Moodle and an email sent directly to the data protection officer. We can then describe the process of contacting the data protection officer on the privacy policy page. ||User Stories||Acceptance Criteria|| |As a Moodle administrator I want moodle to provide a form for contacting the data protection officer for my moodle site.| There is a site admin setting "contactdataprotectionofficerthroughmoodle" If enabled, users will be provided links from the site privacy policy, as well as from their own profile page to contact the sites data protection officer. The link will go to a new form with simple instructions and a text box for providing more details. When submitted - a record of the request will be stored and an email will be sent to the data protection officer. The language of these automated links will respect the users current language.| |As a Moodle administrator with an alternate process for contacting my data protection officer, I do not want these requests to go through moodle.| I can disable the new setting and no automatic links will be shown in the privacy policy or in users profiles. I can write manual instructions for contacting the data protection officer in my privacy policy.|
4.summary: Delete personal data when it is no longer required
description: This is a new setting that will allow user data to be anonymised if a user has not logged into Moodle for X period (years?). We should exclude site admins and consider what will happen with ldap syncs etc. ||User Stories||Acceptance Criteria|| |Moodle should delete personal data when it is no longer required in order to comply with the principals of "privacy by design".| There should be a site administration setting (under privacy) which will delete user data automatically if they have not been used for X period. Admin accounts should never be deleted according to this setting. Authentication plugins should be able to specify that their users are exempt (e.g. ldap users). If a user matches this criteria, they should be deleted from Moodle using the standard deletion functions.|
5.summary: Create new privacy subsystem
description: We need to create the required basis for the new privacy subsystem in which the new metadata and request PHP interfaces will exist, as well as the helper API functions.
6.summary: Implement request interface for mod_assign
description: This is an issue to track the creation of a prototype PHP Interface for \core\privacy\request as the API negotiating Subject Access Requests in the assignment module.
7.summary: Implement request interface for mod_forum
description: This is an issue to track the creation of a prototype PHP Interface for \core\privacy\request as the API negotiating Subject Access Requests in the forum module.
8.summary: Allow the Privacy Officer to create categories and purposes for data (in the tool)
description: From the user stories: 1. As a Privacy Officer I want to be able to add and edit the categories of personal data in my institution. Moodle should provide a report listing categories of personal data, with options to edit existing items, or create new items. Only users with relevant capability should be allowed to add/edit. 2. As a Privacy Officer, I want to be able add and edit the purposes for collection of personal data in my institution. Moodle should provide a report listing purposes for capturing personal data, with options to edit existing items, or create new items. Only users with relevant capability should be allowed to add/edit. I should be able to provide a default value for retention period during this add/edit process. When creating a purpose there should also be a checkbox or something similar for stopping user deletion requests from being granted. Some purposes such as keeping grades has a higher standing for retention above the right to be forgotten. This flag would ensure that the areas that use this purpose do not have user data deleted from users making such requests.
9.summary: Implement providers for non-data blocks
description: Implement the privacy provider API for blocks which have no real data.
10.summary: Implement providers for block_html
description: Implement providers for block_html
11.summary: Implement providers for mod_quiz
description: Attempt to write mod_quiz providers for the in-progress SAR API.
12.summary: Implement providers for mod_choice
description: Attempt to write mod_choice providers for the in-progress SAR API.
13.summary: Create the registry for adding the purpose and retention periods.
description: We require a registry to list the context / component tree and allow a purpose and retention period (among other settings) to be applied to each level of the tree. The most granular item would be an instance of an activity (module). Need to confirm that this doesnt go down to sub-plugin. It should be possible to set the purpose and retention period for a context and and have it be applied to all of its children down the tree. The form should have a checkbox for applying the setting to the child elements that by default is unchecked. Checking this box will apply the setting to the child elements but will put up a warning saying that the Privacy Officer (PO) needs to review every section to demonstrate compliance. The purpose select element should start with two options Options. Inherit from parent (unset) Inherit from parent By default "Inherit from parent (unset)" allows for each element in the tree to be flagged, requiring attention from the PO. If "Inherit from parent" is set then the attention flag is removed. The tree on the left should show all context / component items, but have a toggle to only show areas that need attention. When setting the purpose / retention period settings, the purpose should be selectable and the retention period should only be shown (not selectable). To set a different retention period a new purpose will have to be created. Related user stories ||User Stories||Acceptance Criteria|| |As a Privacy officer, I want to be able to quickly see which areas of Moodle I have not set the purpose and retention periods for user data.| Moodle should provide a report that shows the current system and which areas have not had the purpose and retention periods specified in relation to user data. Updating the purpose and retention period will mean that this area will no longer show as requiring attention.| |As a privacy officer, I want to be able to efficiently set purposes and retention periods for existing content in my Moodle system.| At each level of the context tree (System, Course category, course, activity, etc.) it should be possible to set the purpose and retention period for user data and have this setting be applied to all child areas. (e.g. I go to a course and set the purpose and retention period and then have it apply it to all activities in that course). The default purpose for all existing items in a site should be set to Not set (currently inheriting) meaning fewer changes will be needed for compliance.|
14.summary: Create backend needed to store purpose, category, retention against contextid
description: This allows work on the UI to be started. Given an item in the context tree (a specific course or course module, etc), we need to be able to set its category and purpose and store this in the Data Privacy tool. This issue is about the back end only. Note: Categories and purposes are user-configurable - see . Do we link these or copy these when storing the relationship between contextid/component and purpose/category? - This is up for discussion on this issue.
15.summary: Allow privacy metadata to be stored in the Data Privacy tool
description: Reads data from the manager::get_metadata_for_components() call - an assoc array of item collections indexed by frankenstyle component names - which needs to be stored in some sort of a metadata summary table in the tool. Should make CRUD methods too, as the tool may need to remove or update metadata as plugins change after install/removal.
16.summary: Create a report showing component compliance
description: NEEDS UX DESIGNS! Should highlight and distinguish between those components which: Are compliant and dont store data Are compliant and do store data Are not compliant (meaning some implementations are missing in their code base) Used as a system audit/review tool primarily.
17.summary: Create a process for updating privacy metadata on upgrade/install
description: Privacy subsystem should fetch and broadcast new metadata to any plugins needing to know about the changes - for now, just the Data Privacy plugin - but should work generically. Given we cant use hooks during upgrade/install, we may need to ask the core privacy subsystem to schedule an adhoc task to fetch and inform other plugins (via a hook).
18.summary: Create a way to store the defaults for purpose and retention for each context level
description: We need a page where we can set the defaults for purpose and retention for each context. Besides site, each of the settings would have inherit in the select options. These defaults would then be what is selected by default when a new item is created after this point in time (existing items would not be affected). Related user story || User Stories || Acceptance Criteria || | As a privacy officer, I want to be able to set defaults for all the contexts in Moodle, so that when creating new instances (course, mod, etc), the default purpose can be used. | The Data Privacy tool should provide a setting for each of the contexts, allowing a default purpose to be set for that context. Values should include: Inherit Others from the list created by the PO. System context must exclude Inherit from its list. |
19.summary: Provide a way to set the purpose and retention across a context level
description: To help set purposes and retention information effectively we would like a way to set this across a context level i.e. I want all courses to have the same purpose and retention period. Related user story || User Stories || Acceptance Criteria || | As a privacy officer, I want to be able to apply the default value for context to all existing instances at that context only. E.g. Apply a default of Education to all course categories. | Data Privacy tool to provide a new page allowing application of default values to existing data within that context. Page should allow the PO to choose the context on which to act, the purpose to apply to items, and an option to override existing values (defaulted to not set). |
20.summary: Implement subsystem provider for plagiarism API
description: Note: This is a hard one. We need to work out what to do here because there is no consistent API at this stage.
21.summary: Implement core_privacy for core themes
description: These are likely to be easy as I dont believe we store any user data: theme_bootstrapbase theme_clean theme_more theme_boost
22.summary: Implement core_privacy for null providing activities
description: Adrian suggests: mod_resource mod_folder mod_label There may be others too. See if there are any other activity modules which we can get out of the way quickly.
23.summary: Implement core_privacy for repositories and core_repository
description: Lets take a look at repositories and see if we can fully implement the core_privacy API for at least one.
24.summary: Implement core_privacy for a course format
description: Implement core_privacy for at least one course format.
25.summary: Implement core_privacy for an tool_usertours
description: Perhaps user tours
26.summary: Implement core_privacy for atto subplugins
description: Look at both atto, and all plugins. I think the only one which saves data is to do with draft autosaving.
27.summary: Implement core_privacy for calendar types
description: Implement core_privacy for calendar types
28.summary: Connect the Data Privacy tool to the subsystems manager to facilitate data export
description: Heres what needs to be done: 1. New table tool_dataprivacy_request_contexts to hold contexts for a given request Should have cols: - requestid - component - contextid - status (for now: pending, approved, rejected but allow for more) 2. New constants in the api class to hold the context statuses above (pending , approved, rejected etc) 3. New request made adhoc task updates: - generate the contextlist_collection - for each contextlist: store the component, context, etc in tool_dataprivacy_request_contexts table - progress the request (current code does this already) 4. At the point of approving (before scheduling the adhoc task): - set status of all respective contexts in the table to approved (may evolve to a UI control eventually) 5. Request approved adhoc task updates: - fetch list of approved contexts (those with status approved) - reassemble a contextlist collection for these using approved_contextlist instead of contextlist. - pass to manager->export() - TODO: consider how to mop up the contexts in the tool_dataprivacy_request_contexts table. Do we do now or later? (scheduled task ?) Note: This work should be based on the tool: and on -- work.
29.summary: action_menu UI component extension
description: I would love to slightly extend action_menu and family. This would greatly help us make GDPRs data registry compatible with both bootstrap 2 and bootstrap 4 themes.
30.summary: New block_instance_by_id blocks API method
description: Another issue that would help us with GDPR data registry. We can survive without it but it does not seem risky and it should be easily backportable.
31.summary: Implement core_privacy for message airnotifier.
description: Lets take a look at messages and see if we can fully implement the core_privacy API for at least one.
32.summary: Implement provider in the dataprivacy tool
description: Implement and pull request here:
33.summary: Use tool_dataprivacy prefix for the data privacy tables
description: Convention states that table names of plugins should be named in the Frankenstyle format. We should rename the plugins tables to use the tool_dataprivacy as table prefix.
34.summary: Use expectException in unit tests in the privacy tool
description: Travis is complaining about empty catch statements in api_test.php: noformat FILE: /home/travis/moodle/admin/tool/dataprivacy/tests/api_test.php ------------------------------------------------------------------------------------------------------------------------ FOUND 8 ERRORS AND 14 WARNINGS AFFECTING 16 LINES ------------------------------------------------------------------------------------------------------------------------ 527 | ERROR | Empty CATCH statement detected 545 | ERROR | Empty CATCH statement detected 553 | ERROR | Empty CATCH statement detected 560 | ERROR | Empty CATCH statement detected 621 | ERROR | Empty CATCH statement detected 638 | ERROR | Empty CATCH statement detected 646 | ERROR | Empty CATCH statement detected 653 | ERROR | Empty CATCH statement detected ------------------------------------------------------------------------------------------------------------------------ noformat Perhaps using expectException is better.
35.summary: Extend link_subsystem calls to allow components to specify privacy fields when linking
description: Looking at the portfolio (and this may be the case for some other areas too), I see a situation where a given component calls the portfolio subsystem, which links to the plugin types (portfolio). The plugin types (Mahara for example) link externally. The issue I see here is that only the component (lets use forum as an example), knows what data it passes to the subsystem, and which subsequently gets exported externally. The subsystem and the plugins just pass it along, and dont know this. To me, it sounds like we need a way to say something like "Link subsystem with this data" - which we currently dont have with the link subsystem class. Right now, we dont / cant describe metadata about the fields sent externally through this flow: forum -> portfolio subsystem -> mahara plugin. Id think one way to address this would be to allow passing in fields to link_subsystem.
36.summary: Implement core_privacy for core_calendar
description: Implement privacy provider for core_calendar.
37.summary: Add a cache for purposes
description: We could also add one for categories but the really important one is for purposes as purposes contain retention periods and retention periods is what we need to fetch while calculating which contexts should be deleted.
38.summary: Implement core_privacy for a message email.
description: Implement the privacy provider for message email.
39.summary: Missing polyfill for plagiarism provider interface
description: Mentioned on . Need to provide this polyfill for plugins to use.
40.summary: Merge data privacy settings and links to the common Privacy and Policy admin tree branch
description: The summary describes pretty much everything.
41.summary: Add a global enable / disable delete expired contexts (according to data registry)
description: The data registry is useful to set a retention period to each moodle context instance. The consequences of not setting retention periods properly can be horrible e.g. 0 years retention period assigned at user context means that all users without ongoing courses will be deleted :) We need moodle admins to explicitly enable this feature before stuff gets deleted automatically. I intentionally allowed users to set a 0 years retention period, we may want to reconsider this.
42.summary: Implement core_privacy for a message jabber.
description: Implement the privacy provider for message jabber.
43.summary: Implement core_privacy for message popup.
description: Implement the privacy provider for message popup.
44.summary: Allow admins to confirm which expired contexts should be deleted
description: In we introduced a scheduled task that iterates through expired contexts (expired according its retention period) At the moment we just delete them but ideally we would provide a report for admins so they can confirm which contexts should be deleted. ||User Story||Acceptance Criteria|| |As a privacy officer, I want to be able to view a report listing data which should no longer be held, so that I can select which data to remove to comply with the principle of "Privacy by Design".| Moodle will provide a report listing all types of data which has passed its retention period, so that the Privacy Officer can review and choose which data areas are to be erased. This report will highlight data areas (courses, plugins, etc) and will not include the actual data itself. Choosing to delete all selected data should queue the selected data for deletion. Scheduled task will run to look for queued jobs and will remove the relevant data (that which the Privacy Officer selected). Admin account and any associated data must be considered exempt from the deletion process (see next point).|
45.summary: Implement core_privacy for block rss client
description: Implement the privacy provider for block_rss_client.
46.summary: Implement provider for tool_monitor
description: Implement the core_privacy provider for tool_monitor.
47.summary: Implement the privacy provider for core_user.
description: Implement the core_privacy provider for core_user.
48.summary: Implement providers for block_community
description: Implement providers for block_community
49.summary: Allow admins to confirm which expired contexts should be deleted: UI part
description: Build the UI part of the deletion workflow for expired contexts: ||User Story||Acceptance Criteria|| |As a privacy officer, I want to be able to view a report listing data which should no longer be held, so that I can select which data to remove to comply with the principle of "Privacy by Design".| Moodle will provide a report listing all types of data which has passed its retention period, so that the Privacy Officer can review and choose which data areas are to be erased. This report will highlight data areas (courses, plugins, etc) and will not include the actual data itself. Choosing to delete all selected data should queue the selected data for deletion. |
50.summary: Honour protected purposes during deletion requests
description: Purposes have a protected field which description states that The retention of this data has a higher legal precedent over a users request to be forgotten. This data will only be deleted after the retention period has expired Deletion requests should honour that protected field, skipping protected contexts. Pasting a conversation from SAR team chat: code Andrew Nicols, 03.04.18 14:18 It should be in here: Andrew Nicols, 03.04.18 14:18 Yes... but thats within the tool Andrew Nicols, 03.04.18 14:18 The API just deletes what it is told. DavidMonllao, 03.04.18 14:18 e.g. a user request to be forgotten is granted, we go through all the contexts where the user did something skipping the ones flagged as protected Andrew Nicols, 03.04.18 14:19 Yup Andrew Nicols, 03.04.18 14:19 Thats where we should do it DavidMonllao, 03.04.18 14:19 it looks like it would be a good fit for get_contexts_for_userid Andrew Nicols, 03.04.18 14:19 Sorry, I thought that youd done that part. Andrew Nicols, 03.04.18 14:20 My bad :) DavidMonllao, 03.04.18 14:20 np np Andrew Nicols, 03.04.18 14:20 How do you mean? DavidMonllao, 03.04.18 14:20 get_contexts_for_userid is only called for deletion requests is that right? Andrew Nicols, 03.04.18 14:20 No... its called for export requests too DavidMonllao, 03.04.18 14:20 then maybe delete_user_data Andrew Nicols, 03.04.18 14:20 It is the duty of the tool, not the privacy API Andrew Nicols, 03.04.18 14:21 The privacy API just deletes what it is told. The tool is the only part aware of protected contexts, and it is the one responsible for calling the API with the correct data. Andrew Nicols, 03.04.18 14:21 It may be helpful if we add a function to the approved_contextlist class to remove_contexts(array $contextids) Andrew Nicols, 03.04.18 14:22 So that when we re-hydrate the contextlist on line we can remove the ones which shoudl not be there Andrew Nicols, 03.04.18 14:23 $contextlist = new \core_privacy\local\request\approved_contextlist($foruser, $contextlist->get_component(), $contextlist->get_contextids()); $contextlist->remove_contexts($blacklistedids); $approvedcollection->add_contextlist($contextlist); Andrew Nicols, 03.04.18 14:25 Alternatively, well do that when we fetch the contextlists into the approved contextlist. Andrew Nicols, 03.04.18 14:25 At the moment were just fetching all contexts from get_contexts_for_userid and turning them into an apporved_contextlist. There is a todo on line 109 to use the DB that Jake has been desigining. Andrew Nicols, 03.04.18 14:26 When we do that, well be able to link against the table for protected ones and just exclude them I presum.e code
51.summary: Implement core_privacy for report progress
description: Implement the privacy provider for report progress.
52.summary: Implement core_privacy for report completion
description: Implement the privacy provider for report completion.
53.summary: Implement core_privacy for dataformat plugins.
description: Implement core_privacy for dataformat plugins.
54.summary: Implement providers for auth_manual
description: Attempt to write auth_manual providers for the in-progress SAR API.
55.summary: Implement core_privacy for mod_feedback
description: See summary.
56.summary: Implement providers for core_notes
description: Implement providers for core_notes
57.summary: Implement core_privacy for fileconverter_unoconv
description: Implement core_privacy for fileconverter_unoconv.
58.summary: Implement core_privacy for auth plugins (not oaut and manual)
description: Probably all null providers. (Not auth_oaut and auth_manual ) auth_cas auth_db auth_email auth_ldap auth_lti auth_mnet auth_nologin auth_none auth_shibboleth auth_webservice For Moodle 3.3.5 has to: auth_imap auth_fc auth_pam auth_pop3 auth_nntp
59.summary: Split out manager->get_components_list into a core function
description: This list of frankenstyle names for all core components (plugins + core subsystems) is used all over the place in both this project and in places in core too (search and others). We should have a function in core_component which provides this, instead of having to assemble this list manually all over the place. This change should introduce the function in core and make the manager use this instead of its current internal implementation.
60.summary: Implement core_privacy for core_competency
description: See summary.
61.summary: Implement core_privacy for fileconverter_googledrive
description: Implement core_privacy for fileconverter_googledrive
62.summary: Implement providers for report components
description: Implement providers for report components
63.summary: Implement providers for auth_oaut
description: Implement providers for auth_oaut
64.summary: Implement core_privacy for admin/tool components.
description: Implement the null privacy provider for admin/tool components which have been identified not to store any personal data. NOTE: there are some additional admin/tools not covered in this ticket because they were flagged to maybe store personal data / preferences. These remaining admin/tools will be addressed in separate issues.
65.summary: Include tool_dataprivacy in core
description: This issue is about including in core and it is closely related to privacy API and .
66.summary: Implement core_privacy for media plugins.
description: Implement core_privacy for media plugins.
67.summary: Implement core_privacy for webservice plugins.
description: Implement core_privacy for webservice plugins.
68.summary: Implement core_privacy for mod_workshop
description: Implement the privacy API in the Workshop module
69.summary: Implement core_privacy for enrol plugins (not lti and paypal)
description: Probably all null providers. (Not enrol_lti and enrol_paypal). enrol_category enrol_cohort enrol_database enrol_flatfile enrol_guest enrol_imsenterprise enrol_ldap enrol_manual enrol_meta enrol_mnet enrol_self
70.summary: Implement core_privacy for course format plugins
description: Probably all null providers. format_singleactivity format_social format_topics format_weeks
71.summary: Implement core_privacy for assignment plugins.
description: Implement core_privacy for assignment plugins.
72.summary: Provide means for the Privacy Officer to set lawful basis for defining purposes for collection of personal data
description: We need to add form controls that let the Privacy Officer select one or more items defined in GDPR Art 6: Lawfulness of processing and GDPR Art 9: Sensitive Personal Data.
73.summary: Implement core_privacy for mod_data and datafields
description: Implement core_privacy for mod_data and datafields: datafield_checkbox datafield_date datafield_file datafield_latlong datafield_menu datafield_multimenu datafield_number datafield_picture datafield_radiobutton datafield_text datafield_textarea datafield_url
74.summary: Implement the privacy provider for core_role
description: Implement the privacy provider for core_role. According to the comments, core_role has data.
75.summary: Implement providers for tool_mobile
description: Implement core_privacy for admin/tool/mobile. It has a user preference: tool_mobile_autologin_request_last
76.summary: Implement providers for core_register
description: Implements Null Provider.
77.summary: Implement providers for core_my
description: Implement providers for core_my
78.summary: Implement core_privacy for core media.
description: Implement core_privacy for core media.
79.summary: Implement core_privacy for core_grading, gradingform_guide and gradingform_rubric
description: Implement core_privacy for: core_grading gradingform_guide gradingform_rubric
80.summary: Implement core_privacy API for gradeexport
description: Implement core_privacy for gradeexport plugins: gradeexport_ods gradeexport_txt gradeexport_xls gradeexport_xml
81.summary: Implement core_privacy API for gradeimport
description: Implement core_privacy for gradeimport plugins: gradeimport_csv gradeimport_direct gradeimport_xml
82.summary: Delete users for deletion requests and expired context_user
description: We delete all data associated to a user in all components but we do not yet delete the user itself. This issue is about that.
83.summary: Implement core_privacy API for gradereport
description: Implement core_privacy for gradereport plugins: gradereport_grader gradereport_history gradereport_outcomes gradereport_overview gradereport_singleview gradereport_user
84.summary: Implement core_privacy API for core_rss
description: Implement core_privacy for core_rss
85.summary: Implement core_privacy for mod_scorm
description: Implement the privacy API in the SCORM module.
86.summary: Implement core_privacy API for datapreset_imagegallery
description: Implement core_privacy API for datapreset_imagegallery.
87.summary: Implement core_privacy for mod_survey
description: See summary.
88.summary: Implement core_privacy for profilefield plugins.
description: Implement core_privacy for profilefield plugins.
89.summary: Implement core_privacy for tool_recyclebin
description: Implement null provider for tool_recyclebin This plugin does have a database table tool_recyclebin_course but it does not contain any identifying user data. No userid is tracked within this tables records.
90.summary: Implement core_privacy for mod_wiki
description: Implement core_privacy for mod_wiki On data deletion request: - Individual wikis to be removed completely - Contributions to collaborative wikis remain
91.summary: Implement core_privacy for tool_profiling
description: Implement null providers for tool_profiling. This plugin does access data from the mdl_profiling table, where the data is inserted by the lib/xhprof/xhprof_moodle.php script -> function profiling_import_runs(). However, the mdl_profiling table does not contain any user identifiable data.
92.summary: Implement core_privacy for tool_cohortroles
description: Implement metadata and plugin providers for tool_cohortroles. This plugin stores user data in the mdl_tool_cohortroles table.
93.summary: Implement core_privacy for booktool plugins
description: Implement core_privacy for booktool plugins.
94.summary: Implement core_privacy for mod_chat
description: See summary.
95.summary: Implement core_privacy for mod_lesson
description: See summary.
96.summary: Implement core_privacy for profilefield_checkbox
description: Implement core_privacy for profilefield_checkbox.
97.summary: Implement providers for mod_glossary
description: Attempt to write mod_glossary providers for the in-progress SAR API.
98.summary: Implement core_privacy for tool_assignmentupgrade
description: The tool_assignmentupgrade plugin contains a user preference tool_assignmentupgrade_perpage setting.
99.summary: Implement core_privacy API for core_cohort
description: Implement core_privacy for core_cohort
100.summary: Implement providers for block_comments
description: Attempt to write mod_glossary providers for the in-progress SAR API.
101.summary: Implement core_privacy for profilefield_datetime
description: Implement core_privacy for profilefield_datetime.
102.summary: Implement core_privacy for core_grades
description: See summary.
103.summary: Implement core_privacy for core_enrol
description: Implement core_privacy for core_enrol
104.summary: Expand data registry usage information / help
description: It may be worth expanding the data registry information (help buttons / info messages) as it is a complex tool and some aspects of it may not be obvious. This issue shouldnt introduce traumatic changes, just new messages around.
105.summary: Implement core_privacy for profilefield_menu
description: Implement core_privacy for profilefield_menu.
106.summary: Implement core_privacy for profilefield_text
description: Implement core_privacy for profilefield_text.
107.summary: Implement core_privacy for profilefield_textarea
description: Implement core_privacy for profilefield_textarea.
108.summary: Implement core_privacy for a core_userkey
description: This is a bit more complex than others as this subsystem does not have a data directory just yet.
109.summary: Extend core_privacy_testsuite to check that the database table exists
description: This will catch typos and ensure we arent returning invalid metadata.
110.summary: Implement core_privacy API for mod_imscp
description: Implement core_privacy for mod_imscp
111.summary: Implement providers for mod_book
description: Attempt to write mod_book providers for the in-progress SAR API.
112.summary: Implement core_privacy for core_filters
description: core_filters does not define any data.
113.summary: Implement providers for enrol_paypal
description: Attempt to write enrol_paypal providers for the in-progress SAR API.
114.summary: Add error handling for exports and deletes
description: At the moment if any plugins privacy API implementation causes an exception, the whole request fails. Arguably this is correct - we want to make sure the request completed correctly wherever possible, however it may be worth adding some try/catch checks around some requests to allow requests to come to some level of completion and instead alert an administrator somehow. Also consider rolling back database transactions.
115.summary: Implement core_privacy for tool_log and subplugins
description: See summary.
116.summary: Implement providers for core_hub and core_publish
description: Implement providers for core_hub and core_publish. Review core_register and block_community Putting them all together because they all are part of moodle.net / hub communication Note, code is different for Moodle 3.3 !
117.summary: Implement core_privacy for the completion component
description: Add privacy information for the completion component.
118.summary: Merge together core subsystems core_hub, core_register and core_publish
description: core_component::fetch_subsystems() : code hub => null, publish => $CFG->dirroot./course/publish, register => $CFG->dirroot./.$CFG->admin./registration, // Broken badly if $CFG->admin changed. code lib/classes/hub/, lang/en/hub.php - present, contain classes and strings for all three subsystems admin/registration/classes/ and lang/en/register.php - created during GDPR work for privacy API implementations course/publish/classes/, lang/en/publish.php - do not exist but would need to be created for privacy API implementations otherwise, see Basically, there is no reason for components core_publish and core_reigster to exist
119.summary: Add helper functions to add system and user context to contextlist
description: Lets have helper functions so we can help developers add some commonly used contexts (ie. system for messaging).
120.summary: Make sure every table in lib/db/install.xml has a core subsystem responsible for it
description: When we go through the list of core subsystems we may accidentally "forget" some database tables that have user data because there is no strict relation tablecomponent Go through all tables defined in lib/db/install.xml that may have user data and make sure it is covered by one of the core components There are a few places where we have specifically excluded the tables. Nevertheless, we should probably describe the table in metadata. ||Table||Field||Decision||Issue|| ||config_log||userid|TODO core|| ||upgrade_log||userid|TODO core|| ||my_pages||userid|Specifically excluded but should we add metadata?|| ||user_preferences||userid|TODO core|| ||scale||userid|Needs to be done in core_grade|| ||scale_history||loggeduser, userid|Needs to be done in core_grade|| ||role_sortorder||userid|Needs to be done in core_role|| ||events_queue||userid|TODO|| ||grade_import_newitem||importer|Temporary tables only|| ||grade_import_values||importer, userid|Temporary tables only|| ||portfolio_log||userid|TODO - needs exporting|| ||portfolio_tempdata||userid|TODO|| ||backup_controllers||userid|Already done|N/A| ||grading_instances||raterid|Already done|N/A| ||task_adhoc||userid|TODO core|| ||chat_messages_current||userid|TODO|| ||chat_users||userid|TODO|| ||forum_queue||userid|TODO|| ||enrol_flatfile||userid|TODO|| ||enrol_lti_users||userid|Already done|N/A| ||block_recent_activity||userid|TODO|| ||tool_policy_versions||usermodified|TODO|| ||logstore_standard_log||userid|Incorrect name||
121.summary: Implement core_privacy for core_badges
description: See summary.
122.summary: Implement core_privacy for mod_assignment
description: Implement core_privacy for mod_assignment.
123.summary: Implement core_privacy for core_fileconverter
description: See summary.
124.summary: Implement core_privacy for tool_messageinbound
description: See summary.
125.summary: Implement core_privacy for core_search and search engine plugins
description: Implement core_privacy for core_search and search engine plugins
126.summary: Implement core_privacy for core_analytics and machine learning backend plugins
description: Implement core_privacy for core_analytics and machine learning backend plugins
127.summary: The RSS subsystem incorrectly implements \core_privacy\local\request\plugin\provider
description: It will make no difference, for now. However, we should fix this now rather than wait for it to explode.
128.summary: Implement providers for block_recent_activity
description: Attempt to write block_recent_activity providers for the in-progress SAR API.
129.summary: Implement core_privacy for core_files
description: See summary.
130.summary: Implement core_privacy for core_webservice
description: See summary.
131.summary: Implement core_privacy for core_block
description: See summary.
132.summary: Revisit the privacy provider of block_tag_flickr
description: This block requires configuration (preferred tags, ...) which could be seen as user information, and that information is shared with an external system.
133.summary: Implement core_privacy for core_auth
description: See summary.
134.summary: Implement core_privacy for mnetservice_enrol
description: Implement core_privacy for mnetservice_enrol.
135.summary: Implement core_privacy API for core_access
description: Implement core_privacy for core_access
136.summary: Implement core_privacy for mnet
description: Implement core_privacy for mnet, will be probably a null_provider. DB Table mnet_sso_access_control is not needed declare and export. The field username isnt linked to any table. This field is used to allow or deny specific access to a user with this username. But it doesnt created a link with the user. auth_mnet implements: DB Tables, mnet_session and mnet_log. mnetservice_enrol implements: DB Table, mnetservice_enrol_enrolments
137.summary: Implement core_privacy API for core_availability
description: Implement core_privacy for core_availability
138.summary: Implement provider for core_backup
description: Yeh.
139.summary: Implement the privacy provider for core_admin
description: Implements Null Provider. Also, these are all core subsystems and well implement them in other issues.
140.summary: Implement provider for core_form
description: There are user preference sin filemanager.js. Check to see if theyre handled elsewhere or not (such as files).
141.summary: Implement providers for core_group
description: Attempt to write core_group providers for the in-progress SAR API.
142.summary: Implement core_privacy for core_antivirus
description: This was missed in ;(
143.summary: If backup data contains information of a user that has asked to be deleted we should not restore it
description: The core_backup provider implemented in does not actively remove user data from the backup (because that would be insane), so when restoring these backups we should ignore users who dont want to be remembered.
144.summary: enrol_meta to export/delete groups
description: enrol_meta privacy provider should also export and delete the group memberships it is responsible for.
145.summary: enrol_cohort to export/delete groups
description: enrol_cohort privacy provider should also export and delete the group memberships it is responsible for.
146.summary: Implement providers for enrol_lti
description: Implement providers for enrol_lti.
147.summary: Performance fixes for some providers
description: Weve discovered some issues due to joins which dont scale well with large numbers of records. The one which we discovered this with is assign and its because the query planner in some engines doesnt deal well with joins where the filter is only in the WHERE (when it should be on the JOIN). Thankfully this only effects providers, and only those which do complex joins, and thankfully these are mostly extremely well unit tested now.
148.summary: Make JSON output pretty
description: As requested by several people, we should look at making the JSON output pretty.
|
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: Activity chooser overhaul
description: This epic collects together all the issues related to updating and overhauling the current activity chooser. Invisio prototypes| Please keep the docs| updated with any changes
| Unsolvable | 1.summary: Migrate new JavaScript code from AMD to be ES6 - Sub task of
description: Update the new AMD sections to be using ES6. We agreed that from this point onward we should write any new JavaScript in ES6.
2.summary: Create behat tests for the base activity chooser - Sub task of
description: Create behat tests to cover all features of the activity chooser. Acceptance criteria: Existing tests passing New sliding functionality covered (to description, back from it, adding a new mod from description)
3.summary: Accessibility implementation & audit of activity chooser - Sub task of
description: Review the new Activity picker and make sure that it works with: JAWS NVDA Acceptance criteria: Focus lock Tabbing from inside a grid item goes to exit once done rather than the next or previous
4.summary: Create unit tests for the base activity chooser - Sub task of
description: Create unit tests to cover the functionality of the new code for the base level activity chooser.
5.summary: New API for extending the activity chooser and implementation of favouriting
description: Backend implementation of favouriting for the activity chooser. Add unit tests to prove that this is working as intended. Add favourites to webservice displaying the chooser Add webservice for adding a favourite. Add webservice for removing a favourite.
6.summary: Define the API allowing course mod plugins to add multiple activities to the activity chooser
description: It is currently possible to add additional / pre-configured activities to the activity chooser such as external services. We need to retain this ability. We need to finalise our implementation details Ensure backwards compatibility Unit tests must be included User story ||Story||Approach|| |As an admin, I can configure my LTI/H5P tools to be available on the modal| | . Acceptance criteria Mod activities can add one or more items to the activity chooser by implementing the new API Backward compatibility must be maintained. If we create a new way of adding new items to the activity chooser then we must deprecate the old method. Unit tests must be included with any new functions / methods.
7.summary: Add admin page for recommending activities
description: Related user stories: ||User stories||Approaches|| |As an admin, I can set recommended elements to users(teachers/managers)|Site Admin setting page with the list of all activities. Any activity that is present on the page should have the ability to be recommended.| .Acceptance criteria A settings page in Site administration menu should be available which allows the administrator to select any activity as recommended. Barbara to confirm where to place this in the admin tree. The administrator can also remove the recommendation for activities from the activity chooser from the settings page. H5P installation of activities to be dealt with in a different issue. behat tests for recommending activities on the admin page. Unit tests for any functions methods created through this issue. Use the favourites API to store this information.
8.summary: Ability to search in the activity chooser
description: ||User Stories||Approach|| |As a teacher I should be able to search for elements in the modal based on title and information| | |As a teacher, i should be to see searched elements grouped by tabs| | |As a teacher I should be able to go back to the default view of the modal once I finish searching|Either by removing search or pressing back button| |As a teacher when I perform a search I should be able to see what triggered the result|Have this behave like the H5P search. Results are shown, but no context (if the search result is in the more info section).| |As a teacher, after i perform a search, I should be able to navigate between the information and search results seamlessly|When viewing details of an activity, after clicking back, the search should still be active.| .Acceptance criteria A search bar should be located at the top of the activity chooser when it is opened. Typing anything into the search bar should immediately start showing results (no need to click a search button). The search should search both the name, and the information to show a result. Search results should remove the tabs previously shown and show the results on the one page. Results should be categorised i.e. Starred, Recommended, Activities, H5P. There must be a way to quickly get back to the default state. Clearing the search box being one way. A back button being another. Please implement both. If there are no search results then a message should be displayed saying as much. The search results should remain intact while viewing information on an activity, or starring an activity. Behat tests must cover the above features.
9.summary: Front end implementation of indicating favourites with a star
description: Implement the front end of favouriting for the activity chooser. . User stories ||Story||Approach|| |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| |As a teacher, I should be able to see only my starred elements| | |As a teacher I should be able to unstar an element and it disappears from my list of starred activities.| | . Acceptance criteria Each individual can star any activity listed in the activity chooser. Any item starred is displayed in the starred / favourites tab. Starred items remain in the current tab, as well as being added to the starred tab. Starring should be live. Clicking the star tab should show just starred activities. Activities in the favourite tab can be removed by clicking on the star. This can be done from the starred tab or any other location that the activity is shown. Behat tests must cover this functionality.
10.summary: Support categories/tabs in the activity chooser
description: This issue relies on the list of activities (and their associated metadata) provided by changes in . This issue is scoped with: Translating the list of activities, via display logic, into a template context for the activity chooser template -- Context should provide tabs/categories each of which contain activities. For now, hard limited to just Activities -- Context should indicate which cat/tab is the focus (initially, just the activities tab but this will change once favourites and recommendations tabs are added in the respective issues) Updating the template code to render the tabs provided by the context, including selection of the in focus tab.
11.summary: Update activity chooser to include recommended activities (Frontend)
description: Add templates / JS (ES6) to the activity chooser to display recommended activities. Related user stories: ||User stories||Approaches|| |As a teacher, I can see a list of recommended elements in the modal|Recommended activities are displayed in the appropriate tab.| If there are no activities selected to be recommended, then the recommended tab is not shown. If there is no favourites tab being shown then the recommended tab should be shown. If there are no recommendations then the activity tab should be shown on display. Behat tests to cover the features mentioned above. Includes webservice call /modification. Also requires updated to webservice unit test.
12.summary: Move turn editing on button out of the edit menu on boost
description: Move the turn editing on button (on a course page) out of the edit menu and immediately visible. Please see the screen shot for what this should look like
13.summary: Rework/Redesign the activity chooser
description: Redesign/restructure the activity chooser to fit the current design mock-ups| User stories ||Story||Approach|| |As a teacher, when I click on the activity choose link(the link), I then see the activity picker(the modal), I can then see the activities/resources(the elements) in a grid format and I should not see any tabs(the tabs) in the modal.| | |As a teacher when there are lots of elements in the modal, I can scroll down in the modal to view them.|Allow scrolling| |As a teacher I can find out more information about the elements in the modal.|Click the i icon and be taken to another page with more information.| |As a teacher I should be able to add an element once I have read the detailed information.|A button to add the activity should be present on this page.| |As a teacher I can select and configure an activity.|Click the activity icon and jumps immediately to the activity settings page| . Acceptance criteria All visible activities are listed in the modal. Activities are to be displayed in a grid as per the prototype. Third party activities are listed in the modal when installed (and visible). When there are more activities than will fit in the modal, scrolling down will display them. Clicking on the i (information) icon shows the information about the module. Clicking the i results in a page sliding in from the right to show the information (The same as the activity chooser in H5P). A button to add the activity should be available from the information page. A single click of an activity icon will redirect to the mod_edit page for configuration. Activities can show additional items in the activity chooser. Adding activities works using Jaws and NVDA. Keyboard navigation is possible. Current behat tests should still work. Behat tests are created to cover new functionality (showing information, adding activities from the information page) If new methods / functions are added they are covered by unit tests.
14.summary: Ability to star activities within the activity chooser
description: Add the ability to star any activity in the activity chooser. User stories: ||Story||Approach|| |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| |As a teacher, I should be able to see only my starred elements| | |As a teacher I should be able to unstar an element and it disappears from my list of starred activities.| | .Acceptance criteria Each individual can star any activity listed in the activity chooser. Any item starred is displayed in the starred / favourites tab. Starred items remain in the current tab, as well as being added to the starred tab. Starring should be live. Clicking the star tab should show just starred activities. Activities in the favourite tab can be removed by clicking on the star. This can be done from the starred tab or any other location that the activity is shown. When the activity chooser is opened, if there are starred items, then that tab is selected. If there are no starred items, then the default is the recommended tab. If there are no recommendations, then the activity tab is selected. Behat tests must cover this functionality.
15.summary: Create a modal and templates - Sub task of
description: Create a modal and templates to display activities in the activity chooser. The modal should display all visible activities. See the invisio proto-type for the design| Related user stories || Story || Approach || | As a teacher, when I click on the activity choose link(the link), I then see the activity picker(the modal), I can then see the activities/resources(the elements) in a grid format and I should not see any tabs(the tabs) in the modal. | | | As a teacher when there are lots of elements in the modal, I can scroll down in the modal to view them. | Allow scrolling | | As a teacher I can find out more information about the elements in the modal. | Click the i icon and be taken to another page with more information. | | As a teacher I should be able to add an element once I have read the detailed information. | A button to add the activity should be present on this page. | | As a teacher I can select and configure an activity. | Click the activity icon and jumps immediately to the activity settings page |
16.summary: Create backend code to retrieve activities - Sub task of
description: Create backend code to query all installed activities, checking for visibility, and returning a list / object / whatever of activities to display in the activity chooser. Note There should already be code existing for the current activity picker. Investigate that code. Its likely that we wont need to initially touch it and just update the frontend. Current code for retrieving activities is in course/renderer.php - course_section_add_cm_control() Note 2 course/lib.php get_module_metadata() does a component callback for get_shortcuts which is what adds more activities to the activity chooser. 24/11/19 It has been decided today to retool this MDL to test out the performance of webservice call to fetch the course modules and move away using the json_encode method.
17.summary: Finalise design for manually adding activities to the chooser - Sub task of
description: We have a basic outline on how to implement this functionality. Link to documentation to be provided (prompt Adrian if not linked yet). TODO - Finalise the implementation details. Note course/lib.php get_module_metadata() does a component callback for get_shortcuts which is what adds more activities to the activity chooser.
18.summary: Add search ability to the admin settings page for recommended activities.
description: On the administrator setting page to recommend activities, lets add a search box to help the user find activities to recommend to all users.
19.summary: Ability to add p activities in the activity chooser
description: ||User stories||Approaches|| |As an admin, I can define a list of p activities which can be installed and viewed on the modal. | | |As a teacher, I should be able to see p elements under the p tab| | |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| .Acceptance criteria H5P activities are displayed in the activity chooser exactly like all the other activities. Only installed H5P activities should be displayed in the chooser. H5P activities should be displayed in their own separate tab. H5P activities should be able to be starred and recommended. Behat test are required to cover the above features. Unit tests are created for any new functions / methods created to complete this issue.
| 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: Activity chooser overhaul
description: This epic collects together all the issues related to updating and overhauling the current activity chooser. Invisio prototypes| Please keep the docs| updated with any changes
### Response:
1.summary: Migrate new JavaScript code from AMD to be ES6 - Sub task of
description: Update the new AMD sections to be using ES6. We agreed that from this point onward we should write any new JavaScript in ES6.
2.summary: Create behat tests for the base activity chooser - Sub task of
description: Create behat tests to cover all features of the activity chooser. Acceptance criteria: Existing tests passing New sliding functionality covered (to description, back from it, adding a new mod from description)
3.summary: Accessibility implementation & audit of activity chooser - Sub task of
description: Review the new Activity picker and make sure that it works with: JAWS NVDA Acceptance criteria: Focus lock Tabbing from inside a grid item goes to exit once done rather than the next or previous
4.summary: Create unit tests for the base activity chooser - Sub task of
description: Create unit tests to cover the functionality of the new code for the base level activity chooser.
5.summary: New API for extending the activity chooser and implementation of favouriting
description: Backend implementation of favouriting for the activity chooser. Add unit tests to prove that this is working as intended. Add favourites to webservice displaying the chooser Add webservice for adding a favourite. Add webservice for removing a favourite.
6.summary: Define the API allowing course mod plugins to add multiple activities to the activity chooser
description: It is currently possible to add additional / pre-configured activities to the activity chooser such as external services. We need to retain this ability. We need to finalise our implementation details Ensure backwards compatibility Unit tests must be included User story ||Story||Approach|| |As an admin, I can configure my LTI/H5P tools to be available on the modal| | . Acceptance criteria Mod activities can add one or more items to the activity chooser by implementing the new API Backward compatibility must be maintained. If we create a new way of adding new items to the activity chooser then we must deprecate the old method. Unit tests must be included with any new functions / methods.
7.summary: Add admin page for recommending activities
description: Related user stories: ||User stories||Approaches|| |As an admin, I can set recommended elements to users(teachers/managers)|Site Admin setting page with the list of all activities. Any activity that is present on the page should have the ability to be recommended.| .Acceptance criteria A settings page in Site administration menu should be available which allows the administrator to select any activity as recommended. Barbara to confirm where to place this in the admin tree. The administrator can also remove the recommendation for activities from the activity chooser from the settings page. H5P installation of activities to be dealt with in a different issue. behat tests for recommending activities on the admin page. Unit tests for any functions methods created through this issue. Use the favourites API to store this information.
8.summary: Ability to search in the activity chooser
description: ||User Stories||Approach|| |As a teacher I should be able to search for elements in the modal based on title and information| | |As a teacher, i should be to see searched elements grouped by tabs| | |As a teacher I should be able to go back to the default view of the modal once I finish searching|Either by removing search or pressing back button| |As a teacher when I perform a search I should be able to see what triggered the result|Have this behave like the H5P search. Results are shown, but no context (if the search result is in the more info section).| |As a teacher, after i perform a search, I should be able to navigate between the information and search results seamlessly|When viewing details of an activity, after clicking back, the search should still be active.| .Acceptance criteria A search bar should be located at the top of the activity chooser when it is opened. Typing anything into the search bar should immediately start showing results (no need to click a search button). The search should search both the name, and the information to show a result. Search results should remove the tabs previously shown and show the results on the one page. Results should be categorised i.e. Starred, Recommended, Activities, H5P. There must be a way to quickly get back to the default state. Clearing the search box being one way. A back button being another. Please implement both. If there are no search results then a message should be displayed saying as much. The search results should remain intact while viewing information on an activity, or starring an activity. Behat tests must cover the above features.
9.summary: Front end implementation of indicating favourites with a star
description: Implement the front end of favouriting for the activity chooser. . User stories ||Story||Approach|| |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| |As a teacher, I should be able to see only my starred elements| | |As a teacher I should be able to unstar an element and it disappears from my list of starred activities.| | . Acceptance criteria Each individual can star any activity listed in the activity chooser. Any item starred is displayed in the starred / favourites tab. Starred items remain in the current tab, as well as being added to the starred tab. Starring should be live. Clicking the star tab should show just starred activities. Activities in the favourite tab can be removed by clicking on the star. This can be done from the starred tab or any other location that the activity is shown. Behat tests must cover this functionality.
10.summary: Support categories/tabs in the activity chooser
description: This issue relies on the list of activities (and their associated metadata) provided by changes in . This issue is scoped with: Translating the list of activities, via display logic, into a template context for the activity chooser template -- Context should provide tabs/categories each of which contain activities. For now, hard limited to just Activities -- Context should indicate which cat/tab is the focus (initially, just the activities tab but this will change once favourites and recommendations tabs are added in the respective issues) Updating the template code to render the tabs provided by the context, including selection of the in focus tab.
11.summary: Update activity chooser to include recommended activities (Frontend)
description: Add templates / JS (ES6) to the activity chooser to display recommended activities. Related user stories: ||User stories||Approaches|| |As a teacher, I can see a list of recommended elements in the modal|Recommended activities are displayed in the appropriate tab.| If there are no activities selected to be recommended, then the recommended tab is not shown. If there is no favourites tab being shown then the recommended tab should be shown. If there are no recommendations then the activity tab should be shown on display. Behat tests to cover the features mentioned above. Includes webservice call /modification. Also requires updated to webservice unit test.
12.summary: Move turn editing on button out of the edit menu on boost
description: Move the turn editing on button (on a course page) out of the edit menu and immediately visible. Please see the screen shot for what this should look like
13.summary: Rework/Redesign the activity chooser
description: Redesign/restructure the activity chooser to fit the current design mock-ups| User stories ||Story||Approach|| |As a teacher, when I click on the activity choose link(the link), I then see the activity picker(the modal), I can then see the activities/resources(the elements) in a grid format and I should not see any tabs(the tabs) in the modal.| | |As a teacher when there are lots of elements in the modal, I can scroll down in the modal to view them.|Allow scrolling| |As a teacher I can find out more information about the elements in the modal.|Click the i icon and be taken to another page with more information.| |As a teacher I should be able to add an element once I have read the detailed information.|A button to add the activity should be present on this page.| |As a teacher I can select and configure an activity.|Click the activity icon and jumps immediately to the activity settings page| . Acceptance criteria All visible activities are listed in the modal. Activities are to be displayed in a grid as per the prototype. Third party activities are listed in the modal when installed (and visible). When there are more activities than will fit in the modal, scrolling down will display them. Clicking on the i (information) icon shows the information about the module. Clicking the i results in a page sliding in from the right to show the information (The same as the activity chooser in H5P). A button to add the activity should be available from the information page. A single click of an activity icon will redirect to the mod_edit page for configuration. Activities can show additional items in the activity chooser. Adding activities works using Jaws and NVDA. Keyboard navigation is possible. Current behat tests should still work. Behat tests are created to cover new functionality (showing information, adding activities from the information page) If new methods / functions are added they are covered by unit tests.
14.summary: Ability to star activities within the activity chooser
description: Add the ability to star any activity in the activity chooser. User stories: ||Story||Approach|| |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| |As a teacher, I should be able to see only my starred elements| | |As a teacher I should be able to unstar an element and it disappears from my list of starred activities.| | .Acceptance criteria Each individual can star any activity listed in the activity chooser. Any item starred is displayed in the starred / favourites tab. Starred items remain in the current tab, as well as being added to the starred tab. Starring should be live. Clicking the star tab should show just starred activities. Activities in the favourite tab can be removed by clicking on the star. This can be done from the starred tab or any other location that the activity is shown. When the activity chooser is opened, if there are starred items, then that tab is selected. If there are no starred items, then the default is the recommended tab. If there are no recommendations, then the activity tab is selected. Behat tests must cover this functionality.
15.summary: Create a modal and templates - Sub task of
description: Create a modal and templates to display activities in the activity chooser. The modal should display all visible activities. See the invisio proto-type for the design| Related user stories || Story || Approach || | As a teacher, when I click on the activity choose link(the link), I then see the activity picker(the modal), I can then see the activities/resources(the elements) in a grid format and I should not see any tabs(the tabs) in the modal. | | | As a teacher when there are lots of elements in the modal, I can scroll down in the modal to view them. | Allow scrolling | | As a teacher I can find out more information about the elements in the modal. | Click the i icon and be taken to another page with more information. | | As a teacher I should be able to add an element once I have read the detailed information. | A button to add the activity should be present on this page. | | As a teacher I can select and configure an activity. | Click the activity icon and jumps immediately to the activity settings page |
16.summary: Create backend code to retrieve activities - Sub task of
description: Create backend code to query all installed activities, checking for visibility, and returning a list / object / whatever of activities to display in the activity chooser. Note There should already be code existing for the current activity picker. Investigate that code. Its likely that we wont need to initially touch it and just update the frontend. Current code for retrieving activities is in course/renderer.php - course_section_add_cm_control() Note 2 course/lib.php get_module_metadata() does a component callback for get_shortcuts which is what adds more activities to the activity chooser. 24/11/19 It has been decided today to retool this MDL to test out the performance of webservice call to fetch the course modules and move away using the json_encode method.
17.summary: Finalise design for manually adding activities to the chooser - Sub task of
description: We have a basic outline on how to implement this functionality. Link to documentation to be provided (prompt Adrian if not linked yet). TODO - Finalise the implementation details. Note course/lib.php get_module_metadata() does a component callback for get_shortcuts which is what adds more activities to the activity chooser.
18.summary: Add search ability to the admin settings page for recommended activities.
description: On the administrator setting page to recommend activities, lets add a search box to help the user find activities to recommend to all users.
19.summary: Ability to add p activities in the activity chooser
description: ||User stories||Approaches|| |As an admin, I can define a list of p activities which can be installed and viewed on the modal. | | |As a teacher, I should be able to see p elements under the p tab| | |As a teacher, I should be able to star an element (applies to any elements in the modal)|When I click on the star, the star turns blue but does not disappear from the list. The element then appears on the starred page| .Acceptance criteria H5P activities are displayed in the activity chooser exactly like all the other activities. Only installed H5P activities should be displayed in the chooser. H5P activities should be displayed in their own separate tab. H5P activities should be able to be starred and recommended. Behat test are required to cover the above features. Unit tests are created for any new functions / methods created to complete this issue.
|
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: Navigation final changes and tweaks
description: This epic covers additional changes to bring Moodle navigation in line with the vision of our UX experts. Issues that are not part of the primary and secondary navigation as well as the initial tertiary changes are to go here.
| Unsolvable | 1.summary: Implement tertiary navigation for plugin set 4 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: Quiz Forum Scorm Survey URL Workshop
2.summary: Move the calendar into the user menu
description: The calendar is to be moved into the user menu as seen in the figma| prototype. -Please (if possible) make it context aware, so that if the user is in a course, it goes to the course calendar.- EDIT: just discussed this with rafaellechugo and barbararamiro. The link should not be context aware. It should go to the full calendar page, month view, showing all courses. E.g.
3.summary: Create user tour for the new navigation.
description: Create a user tour to help users of Moodle with the new interface.
4.summary: Plugin set 2 of 4 tertiary navigation followup
description: Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog. The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues. Please note that all feedback was generated whilst reviewing the following branch and commit branch| commit hash: 669bb28 Items identified during the review are as follows: . Database: Add a new field form buttons order swapped & left aligned CSS template reset and save buttons needs to be aligned beside each other rather than stack to maintain consistency Javascript template reset and save buttons needs to be aligned beside each other rather than stack to maintain consistency Save as preset modal should be centered on the page Confirm if the modal button order can be swapped around Try to make the text input area on the modal to be full width (within col-md-9) Selecting a preset then clicking save throws an error message Confirm if this is a proto site error Confirm if student can view their own database entries, seems consistent with figma but seems inconsistent with Barbaras Moodle cloud instance . Folder: Move the Download folder & edit buttons to the top of the page When editing a folder the Folder secondary navigation tab should be selected . Wiki: Wiki secondary nav tab needs to be active for all items on the dropdown and not just view
5.summary: Migrate between existing navigation and 4.0 navigation
description: . Migrate between existing navigation and 4.0 navigation. Here we aim to make the change between the existing navigation within Moodle to the new Moodle 4.0 navigation. Given the initial epic lands we want to begin the process of removing the old navigation elements, correcting and automated test failures, documenting changes and deprecating any and all now unused navigation functions. color:4653b4Acceptance criteriacolor Both Primary & Secondary navigations are implemented within theme_boost theme_boost Matches the Moodle 4.0 navigation prototype| theme_classic remains unchanged in terms of navigation Behat & PHPUnit tests continue to pass across browsers & themes Hamburger menu and nav drawer removed from Boost Cog icon / action menu removed from pages where secondary navigation now exists Any deprecations follow the Moodle deprecation process| Items follow WCAG AA Tested with accessibility dev tools such as inbuilt chrome tools, Axe etc... Keyboard navigation LTR & RTL compatibility The "Add a block" button is available somewhere to add blocks.
6.summary: On site admin pages the secondary navigation should display as much tabs as fit the menu container
description: On site admin pages the secondary navigation should display as much tabs as fit the menu container
7.summary: Remove the breadcrumb completely from the course pages and some breadcrumb segments in the module context.
description: The prototype for the navigation project has the breadcrumb removed from course/view.php and it seems any page that is linked from the secondary navigation in the course context. Please update the boost navbar class to remove the breadcrumb in these situation. Also there are some requirements to remove only the "My courses" item from the breadcumb displayed in the module context
8.summary: Move the activity modules title, description, and activity completion into a standard module API
description: Currently the activity module is responsible for displaying the activity title, description, and activity completion information. For the purpose of being able to place a select menu, if required, for navigation setting backward compatibility we want to be able to place the select menu with all of the other tertiary navigation buttons. So we need an API which each module can feed information into and we can standardise how this is shown through out all of Moodle. EDIT: after reviewing the final designs for the activity cards and the order of how we will display the information there, we want to ensure that inside the activity the information is displayed in the same order: Completion conditions Activity dates Description It would look like this: !Screen Shot 2021-09-30 at 3.04.09 pm.png|width=442,height=429,thumbnail!
9.summary: Remove section navigation on one section per page
description: When a course uses the new course index we no longer need the section navigation See the choices navigation !sectionnavigation.png|thumbnail! This includes the menu shown below the activities with the jumpto menu
10.summary: Reimplement breadcrumbs in site administration.
description: -After discussion both inside and outside of Moodle it has been decided upon that we need to investigate and implement a back button that behaves in a similar fashion to the back button within the browser.- -It would be preferable if we could store the anchor of the previous page so that when we navigate back we can set focus to the actioned item.- -The back button should show on pages where a combination of primary & secondary navigation items does not allow the user to navigate back easily i.e. when on the admin settings page navigating to online text assignment you should be able to navigate back to admin settings > plugins rather than navigating back to the top page of site administration.- -This may be of interest: -Cheers,- For now we are going to put the breadcrumbs back for the site administration pages. Things to do: Items that exist in the primary and secondary navigation should be removed. e.g Site administration/Plugins. These are in the primary and secondary navigation respectively. has been reverted. (y) So we want to check that the behaviour that we had in 3.11 is still present here.
11.summary: Remove the next and previous activity links from all activity modules in Boost
description: With the introduction of the course index, that will be the primary means for navigating around the course. If possible, make this change only for boost and not classic.
12.summary: Plugin set 1 of 4 tertiary navigation followup
description: Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog. The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues. Please note that all feedback was generated whilst reviewing the following branch and commit branch| commit hash: 669bb28 Items identified during the review are as follows: . Assignment: Margin required between the following buttons: View all submissions & Grade Margin required between View all submissions & Grade buttons & the Grading summary header When creating a Group submission an error occurs when constructing the actionmenu Check group functionality once this is resolved against Figma Remove the question mark between Edit submission & Remove submission buttons when on the page as a student with a submission Change submission status text from No attempt to No submission made yet then remove the help tool tip from add submission button Margin required between Add submission button and Submission status header . Book: Add Print dropdown to the tertiary area Remove chapter names from previous and next buttons so they purely read Previous or Next . Chat: Click here to enter the chat should become Enter the chat Use more accessible interface needs to become a button View past chat sessions link should be removed Styling around The next chat session will start XXXX should be highlighted Student user does not have a secondary navigation, they require one to show Past sessions link . Choice: Responses link should show Responses then a badge with the number of responses rather than View X responses Save template button should be primary on the Templates page . Lesson: Rearrange description and calls to action Start button needs to change to primary Adding override should keep overrides tab highlighted Group overrides page should highlight overrides navigation tab Completion criteria should not be on the reports page Completion criteria should not show when editing the lesson content Editing the lesson should highlight the lesson secondary nav tab
13.summary: Dynamic (AJAX) tabs in Moodle LMS
description: Workplace team will be happy to contribute our AJAX tabs api to Moodle core in 4.0 How it works: - Each tab has unique URL that can be navigated to directly (in case of Workplace we use anchors but they can be completely different URLs too) - once user clicks on the tab heading, the page does not reload but the content of the respective tab loads in AJAX request, URL is changed in the browser and gets added to the history (so that the "Back" button works in the browser) How it is implemented: - Each tab content is a class that extends a base class (tab) that has methods such as checking access, defining the URL, outputting the content - There is another class (tabs) that defines the collection of tabs. - Also there are JS module that switches tabs and the WS that returns the tab contents. If you have seen Moodle Workplace in action, we have these dynamic tabs in many places, they work great and provide better UX because the page does not reloads too much. Also we have additional little module that allows to add dynamic forms inside the tabs (we already contributed dynamic forms, see ). So when user submits the form inside the tab, the page does not reload too. Additional JS can be defined on form submission, for example, switch to the next tab. !Screencast 2021-06-15 112317.gif! Attached a quick demo of the tabs in Workplace
14.summary: Ensure that navigation tabs are highlighted.
description: . Scenario 1: At all times when navigating around the site, a primary navigation tab should be highlighted. We created to help with this, but if it looks like we need to add that command to every page, then we need to find a different solution. Approach (simple, no frills): In a course context, highlight "My courses" Home and Dashboard maps directly Everything else is "Site admin" Also make sure that primary navigation text does not change based on default homepage . Scenario 2: Specifically in site admin, we need to ensure that when on deep nested links, the secondary navigation is properly highlighted . Additional updates Remove mycourses link in pages for unauthenticated and guest users
15.summary: Add tertiary navigation to the gradebook
description: To have the gradebook fit in with the new navigation changes, please do the following: Grade report - Move the select menu to the left. On the Gradebook Settings page: Put "Add grade item" and "Add category" to the tertiary nav. On the Scales page: Move "Add a new scale" into the tertiary nav. On the letters page: No need for a view tab. Move the edit tab into the tertiary nav as a button. On the import page: Default to showing the CSV file page. Put CSV file, Paste from spreadsheet, XML file into a select menu and put that menu into the tertiary nav. On the Export page: Default on OpenDocument spreadsheet. Put OpenDocument spreadsheet, Plain text file, Excel spreadsheet, XML file into a select menu and put that menu into the tertiary nav. Select navigation menu Reorder view section to Grader report, User report, Single view, Overview report, Grade history, Outcomes report Remove Scales, Letters, Import, Export and replace with "More" "More" should have under it Grade letters, Scales, Import, Export The figma prototype|
16.summary: Convert course admin pages from link farms to dropdowns
description: Given the supplied figma design| we need to convert the /course/admin.php?courseid= page from being a link farm to now contain a single dropdown that only contains the navigation items not already found within the secondary navigation. Further work with Barbara will likely be required here regarding to how the user interacts with this dropdown and whether it remains in place whilst navigating backups and restores for instance. Note: the existing course admin is used extensively in behat steps, so changes are likely needed.
17.summary: Add tertiary navigation to the participants page
description: This page also needs to be updated so that users have access to removed settings related to the "users" category. We need a navigation select menu with the following elements: Enrolments: Enrolled users, Enrolment methods, Groups: Groups, Groupings, Overview, Permissions: Permissions, Check permissions, Assigned roles (Currently other users) On the groups page. The tabs should not be shown. We can navigate using the navigation select menu. On the participants page the enrol users button should be next to the navigation select menu and set as a primary button. On the Assigned roles page the Assign roles button should be a primary button. Please refer to the figma design| to check that your end result matches. Note The navigation can be extended and items can be added to the user category. Please ensure that the solution here will also display these third party navigation nodes.
18.summary: Plugin set 3 of 4 tertiary navigation followup
description: Investigate and separate the export entries and export to portfolio links as per the figma design. -Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog.- -The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues.- -Please note that all feedback was generated whilst reviewing the following branch and commit- -branch| commit hash: 669bb28- -Items identified during the review are as follows:- . -Feedback:- -Make Templates section match Figma / confirm against zero state as well (Templates content should instead be in the feedback tab zero state) (Back & dropdown should not be here)- -Templates page is missing a public templates heading & section- -Secondary nav tab for responses is not highlighted when on the responses tab- -Preview & answer questions buttons need to be swapped with the description as a student- . -Glossary:- - Waiting approval needs to become Pending approval - -When appearance is set to entries the Browse by items should become a select box- -Re-arrange tertiary items to match figma- -Choose select box needs to change to ellipsis button with dropdown (if accessible problem it can be changed to more and left as is)-
19.summary: Add tertiary navigation to the badges pages
description: To have the badges pages in site/course administration fit in with the new navigation changes, please do the following: On the Badges page Add "Manage badges" and "Add a new badge" buttons to the tertiary navigation. On the Manage badges page Add "Back" and "Add a new badge" buttons to the tertiary navigation. On the management page for a certain Badge Add "Back" button, a navigation select menu and a Edit details button in the tertiary navigation. The navigation select menu should have the following elements: Overview, Criteria, Message, Recipients, Endorsement, Related badges, Alignments. Edit 1: The breadcrumbs should be in the format of "My courses / Course Name / Manage badges / Badge name" All crumbs preceding the badge name should have links The last node (Badge name) should be the only crumb without a link
| 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: Navigation final changes and tweaks
description: This epic covers additional changes to bring Moodle navigation in line with the vision of our UX experts. Issues that are not part of the primary and secondary navigation as well as the initial tertiary changes are to go here.
### Response:
1.summary: Implement tertiary navigation for plugin set 4 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: Quiz Forum Scorm Survey URL Workshop
2.summary: Move the calendar into the user menu
description: The calendar is to be moved into the user menu as seen in the figma| prototype. -Please (if possible) make it context aware, so that if the user is in a course, it goes to the course calendar.- EDIT: just discussed this with rafaellechugo and barbararamiro. The link should not be context aware. It should go to the full calendar page, month view, showing all courses. E.g.
3.summary: Create user tour for the new navigation.
description: Create a user tour to help users of Moodle with the new interface.
4.summary: Plugin set 2 of 4 tertiary navigation followup
description: Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog. The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues. Please note that all feedback was generated whilst reviewing the following branch and commit branch| commit hash: 669bb28 Items identified during the review are as follows: . Database: Add a new field form buttons order swapped & left aligned CSS template reset and save buttons needs to be aligned beside each other rather than stack to maintain consistency Javascript template reset and save buttons needs to be aligned beside each other rather than stack to maintain consistency Save as preset modal should be centered on the page Confirm if the modal button order can be swapped around Try to make the text input area on the modal to be full width (within col-md-9) Selecting a preset then clicking save throws an error message Confirm if this is a proto site error Confirm if student can view their own database entries, seems consistent with figma but seems inconsistent with Barbaras Moodle cloud instance . Folder: Move the Download folder & edit buttons to the top of the page When editing a folder the Folder secondary navigation tab should be selected . Wiki: Wiki secondary nav tab needs to be active for all items on the dropdown and not just view
5.summary: Migrate between existing navigation and 4.0 navigation
description: . Migrate between existing navigation and 4.0 navigation. Here we aim to make the change between the existing navigation within Moodle to the new Moodle 4.0 navigation. Given the initial epic lands we want to begin the process of removing the old navigation elements, correcting and automated test failures, documenting changes and deprecating any and all now unused navigation functions. color:4653b4Acceptance criteriacolor Both Primary & Secondary navigations are implemented within theme_boost theme_boost Matches the Moodle 4.0 navigation prototype| theme_classic remains unchanged in terms of navigation Behat & PHPUnit tests continue to pass across browsers & themes Hamburger menu and nav drawer removed from Boost Cog icon / action menu removed from pages where secondary navigation now exists Any deprecations follow the Moodle deprecation process| Items follow WCAG AA Tested with accessibility dev tools such as inbuilt chrome tools, Axe etc... Keyboard navigation LTR & RTL compatibility The "Add a block" button is available somewhere to add blocks.
6.summary: On site admin pages the secondary navigation should display as much tabs as fit the menu container
description: On site admin pages the secondary navigation should display as much tabs as fit the menu container
7.summary: Remove the breadcrumb completely from the course pages and some breadcrumb segments in the module context.
description: The prototype for the navigation project has the breadcrumb removed from course/view.php and it seems any page that is linked from the secondary navigation in the course context. Please update the boost navbar class to remove the breadcrumb in these situation. Also there are some requirements to remove only the "My courses" item from the breadcumb displayed in the module context
8.summary: Move the activity modules title, description, and activity completion into a standard module API
description: Currently the activity module is responsible for displaying the activity title, description, and activity completion information. For the purpose of being able to place a select menu, if required, for navigation setting backward compatibility we want to be able to place the select menu with all of the other tertiary navigation buttons. So we need an API which each module can feed information into and we can standardise how this is shown through out all of Moodle. EDIT: after reviewing the final designs for the activity cards and the order of how we will display the information there, we want to ensure that inside the activity the information is displayed in the same order: Completion conditions Activity dates Description It would look like this: !Screen Shot 2021-09-30 at 3.04.09 pm.png|width=442,height=429,thumbnail!
9.summary: Remove section navigation on one section per page
description: When a course uses the new course index we no longer need the section navigation See the choices navigation !sectionnavigation.png|thumbnail! This includes the menu shown below the activities with the jumpto menu
10.summary: Reimplement breadcrumbs in site administration.
description: -After discussion both inside and outside of Moodle it has been decided upon that we need to investigate and implement a back button that behaves in a similar fashion to the back button within the browser.- -It would be preferable if we could store the anchor of the previous page so that when we navigate back we can set focus to the actioned item.- -The back button should show on pages where a combination of primary & secondary navigation items does not allow the user to navigate back easily i.e. when on the admin settings page navigating to online text assignment you should be able to navigate back to admin settings > plugins rather than navigating back to the top page of site administration.- -This may be of interest: -Cheers,- For now we are going to put the breadcrumbs back for the site administration pages. Things to do: Items that exist in the primary and secondary navigation should be removed. e.g Site administration/Plugins. These are in the primary and secondary navigation respectively. has been reverted. (y) So we want to check that the behaviour that we had in 3.11 is still present here.
11.summary: Remove the next and previous activity links from all activity modules in Boost
description: With the introduction of the course index, that will be the primary means for navigating around the course. If possible, make this change only for boost and not classic.
12.summary: Plugin set 1 of 4 tertiary navigation followup
description: Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog. The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues. Please note that all feedback was generated whilst reviewing the following branch and commit branch| commit hash: 669bb28 Items identified during the review are as follows: . Assignment: Margin required between the following buttons: View all submissions & Grade Margin required between View all submissions & Grade buttons & the Grading summary header When creating a Group submission an error occurs when constructing the actionmenu Check group functionality once this is resolved against Figma Remove the question mark between Edit submission & Remove submission buttons when on the page as a student with a submission Change submission status text from No attempt to No submission made yet then remove the help tool tip from add submission button Margin required between Add submission button and Submission status header . Book: Add Print dropdown to the tertiary area Remove chapter names from previous and next buttons so they purely read Previous or Next . Chat: Click here to enter the chat should become Enter the chat Use more accessible interface needs to become a button View past chat sessions link should be removed Styling around The next chat session will start XXXX should be highlighted Student user does not have a secondary navigation, they require one to show Past sessions link . Choice: Responses link should show Responses then a badge with the number of responses rather than View X responses Save template button should be primary on the Templates page . Lesson: Rearrange description and calls to action Start button needs to change to primary Adding override should keep overrides tab highlighted Group overrides page should highlight overrides navigation tab Completion criteria should not be on the reports page Completion criteria should not show when editing the lesson content Editing the lesson should highlight the lesson secondary nav tab
13.summary: Dynamic (AJAX) tabs in Moodle LMS
description: Workplace team will be happy to contribute our AJAX tabs api to Moodle core in 4.0 How it works: - Each tab has unique URL that can be navigated to directly (in case of Workplace we use anchors but they can be completely different URLs too) - once user clicks on the tab heading, the page does not reload but the content of the respective tab loads in AJAX request, URL is changed in the browser and gets added to the history (so that the "Back" button works in the browser) How it is implemented: - Each tab content is a class that extends a base class (tab) that has methods such as checking access, defining the URL, outputting the content - There is another class (tabs) that defines the collection of tabs. - Also there are JS module that switches tabs and the WS that returns the tab contents. If you have seen Moodle Workplace in action, we have these dynamic tabs in many places, they work great and provide better UX because the page does not reloads too much. Also we have additional little module that allows to add dynamic forms inside the tabs (we already contributed dynamic forms, see ). So when user submits the form inside the tab, the page does not reload too. Additional JS can be defined on form submission, for example, switch to the next tab. !Screencast 2021-06-15 112317.gif! Attached a quick demo of the tabs in Workplace
14.summary: Ensure that navigation tabs are highlighted.
description: . Scenario 1: At all times when navigating around the site, a primary navigation tab should be highlighted. We created to help with this, but if it looks like we need to add that command to every page, then we need to find a different solution. Approach (simple, no frills): In a course context, highlight "My courses" Home and Dashboard maps directly Everything else is "Site admin" Also make sure that primary navigation text does not change based on default homepage . Scenario 2: Specifically in site admin, we need to ensure that when on deep nested links, the secondary navigation is properly highlighted . Additional updates Remove mycourses link in pages for unauthenticated and guest users
15.summary: Add tertiary navigation to the gradebook
description: To have the gradebook fit in with the new navigation changes, please do the following: Grade report - Move the select menu to the left. On the Gradebook Settings page: Put "Add grade item" and "Add category" to the tertiary nav. On the Scales page: Move "Add a new scale" into the tertiary nav. On the letters page: No need for a view tab. Move the edit tab into the tertiary nav as a button. On the import page: Default to showing the CSV file page. Put CSV file, Paste from spreadsheet, XML file into a select menu and put that menu into the tertiary nav. On the Export page: Default on OpenDocument spreadsheet. Put OpenDocument spreadsheet, Plain text file, Excel spreadsheet, XML file into a select menu and put that menu into the tertiary nav. Select navigation menu Reorder view section to Grader report, User report, Single view, Overview report, Grade history, Outcomes report Remove Scales, Letters, Import, Export and replace with "More" "More" should have under it Grade letters, Scales, Import, Export The figma prototype|
16.summary: Convert course admin pages from link farms to dropdowns
description: Given the supplied figma design| we need to convert the /course/admin.php?courseid= page from being a link farm to now contain a single dropdown that only contains the navigation items not already found within the secondary navigation. Further work with Barbara will likely be required here regarding to how the user interacts with this dropdown and whether it remains in place whilst navigating backups and restores for instance. Note: the existing course admin is used extensively in behat steps, so changes are likely needed.
17.summary: Add tertiary navigation to the participants page
description: This page also needs to be updated so that users have access to removed settings related to the "users" category. We need a navigation select menu with the following elements: Enrolments: Enrolled users, Enrolment methods, Groups: Groups, Groupings, Overview, Permissions: Permissions, Check permissions, Assigned roles (Currently other users) On the groups page. The tabs should not be shown. We can navigate using the navigation select menu. On the participants page the enrol users button should be next to the navigation select menu and set as a primary button. On the Assigned roles page the Assign roles button should be a primary button. Please refer to the figma design| to check that your end result matches. Note The navigation can be extended and items can be added to the user category. Please ensure that the solution here will also display these third party navigation nodes.
18.summary: Plugin set 3 of 4 tertiary navigation followup
description: Investigate and separate the export entries and export to portfolio links as per the figma design. -Given lands the following issues have been identified as follow ups or items regarding more thought and input in regards to its respective plugin set, these items need to be addressed as a part of the navigation push and should be prioritised on the backlog.- -The goal behind handling identified issues within a followup rather than the initial issues is that we want the team to focus on working on the primary and secondary navigation issues identified after its review whilst we created this list of issues.- -Please note that all feedback was generated whilst reviewing the following branch and commit- -branch| commit hash: 669bb28- -Items identified during the review are as follows:- . -Feedback:- -Make Templates section match Figma / confirm against zero state as well (Templates content should instead be in the feedback tab zero state) (Back & dropdown should not be here)- -Templates page is missing a public templates heading & section- -Secondary nav tab for responses is not highlighted when on the responses tab- -Preview & answer questions buttons need to be swapped with the description as a student- . -Glossary:- - Waiting approval needs to become Pending approval - -When appearance is set to entries the Browse by items should become a select box- -Re-arrange tertiary items to match figma- -Choose select box needs to change to ellipsis button with dropdown (if accessible problem it can be changed to more and left as is)-
19.summary: Add tertiary navigation to the badges pages
description: To have the badges pages in site/course administration fit in with the new navigation changes, please do the following: On the Badges page Add "Manage badges" and "Add a new badge" buttons to the tertiary navigation. On the Manage badges page Add "Back" and "Add a new badge" buttons to the tertiary navigation. On the management page for a certain Badge Add "Back" button, a navigation select menu and a Edit details button in the tertiary navigation. The navigation select menu should have the following elements: Overview, Criteria, Message, Recipients, Endorsement, Related badges, Alignments. Edit 1: The breadcrumbs should be in the format of "My courses / Course Name / Manage badges / Badge name" All crumbs preceding the badge name should have links The last node (Badge name) should be the only crumb without a link
|
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: Develop new Gradebook history report
description: take the netspot grade history module and integrate extend the netspot module, and provide functionality to find editing periods, and then provide a diff report from a specific period in time with current.
| Unsolvable | 1.summary: Clone and integrate NetSpots gradehistory report
description: - Pull the module in, keep git history - Remove README file - Add the missing copyrights and file headers - Complete the PHP docs - Fix the coding style - Make sure all terms comply with
2.summary: Clean up the history report
description: - Removing unnecessary or unused methods - Removing the language strings static cache - Check the module for security issues (privacy, unauthorised access, ...)
3.summary: Migrate the history report to use table_sql
description: - Migrate the table to a table_sql -- Enable and check the column sorting -- Enable and check the collapsible columns - Implement autoloading of the different classes - Use the download feature, rather than the export button - Reconsider the columns (which ones to display, what order to use) - Make the name of the grader, graded users and grade item clickable -- Grader and graded go to their profile -- Grade item could go somewhere, maybe... - Do not capitalise the source column values - Page navigation should not be displayed above the filter form
4.summary: Convert gradebook javascript to a YUI module
description: - Convert the YUI code into a shifter compatible module - Move ajax.php logic into a class, or another location
5.summary: Write Unit Tests for the history report
description: Write Unit Tests to ensure that the queries are returning the expected result.
6.summary: Write a simple behat test for the history report
description: Write a simple behat test for the history report. quote As a teacher, I can see the grade history of a grade I just gave to a student quote
7.summary: Improve the SQL queries of the history report
description: - Fix the query not to be based on ID, but timestamps -- With unit tests confirming - Ensure that the queries include alternate name fields - Ensure the queries are cross DB
8.summary: Add the event grade_report_viewed for the history report
description: Create and use a new event \gradereport_history\event\grade_report_viewed.
| 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: Develop new Gradebook history report
description: take the netspot grade history module and integrate extend the netspot module, and provide functionality to find editing periods, and then provide a diff report from a specific period in time with current.
### Response:
1.summary: Clone and integrate NetSpots gradehistory report
description: - Pull the module in, keep git history - Remove README file - Add the missing copyrights and file headers - Complete the PHP docs - Fix the coding style - Make sure all terms comply with
2.summary: Clean up the history report
description: - Removing unnecessary or unused methods - Removing the language strings static cache - Check the module for security issues (privacy, unauthorised access, ...)
3.summary: Migrate the history report to use table_sql
description: - Migrate the table to a table_sql -- Enable and check the column sorting -- Enable and check the collapsible columns - Implement autoloading of the different classes - Use the download feature, rather than the export button - Reconsider the columns (which ones to display, what order to use) - Make the name of the grader, graded users and grade item clickable -- Grader and graded go to their profile -- Grade item could go somewhere, maybe... - Do not capitalise the source column values - Page navigation should not be displayed above the filter form
4.summary: Convert gradebook javascript to a YUI module
description: - Convert the YUI code into a shifter compatible module - Move ajax.php logic into a class, or another location
5.summary: Write Unit Tests for the history report
description: Write Unit Tests to ensure that the queries are returning the expected result.
6.summary: Write a simple behat test for the history report
description: Write a simple behat test for the history report. quote As a teacher, I can see the grade history of a grade I just gave to a student quote
7.summary: Improve the SQL queries of the history report
description: - Fix the query not to be based on ID, but timestamps -- With unit tests confirming - Ensure that the queries include alternate name fields - Ensure the queries are cross DB
8.summary: Add the event grade_report_viewed for the history report
description: Create and use a new event \gradereport_history\event\grade_report_viewed.
|
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 receive notifications from MoodleNet both in-app and by email
description: Users receive notifications from MoodleNet both in-app and by email.
| Unsolvable | 1.summary: Provide link to all recent activity and users recent activity
description: Weve discussed this in passing, but I noticed on Changemap how useful it is to have an all activity and my activity view. --- After discussion with I suggest we create two views in the sidebar: 1. All recent activity - all activities from all actors (i.e. users, communities, collections) 2. Your recent activity - all activities from one actor (i.e. the logged-in user) This issue will probably need a corresponding backend issue.
2.summary: Calculate numbers of active users
description: This is probably further out, but would be good to know how many people have been recently active (and display that somewhere) (also on profiles, potentially) Store date last active (action = created, posted, or upvoted something) per user, and calculate/store the total number of recently active (in last X days) per: instance community collection For quick and general stats on an instance, we could start by storing some basic in-memory stats based on certain GraphQL queries e.g. For all MoodleNet instances, the numbers could be exposed as part of federation and HQ API, see
3.summary: Sort communities by more than recent
description: Currently, the all communities view show most recently created communities. However, we should create options so that users can sort by: Recently active (new default) Most collections Most members Maybe also: Most resources Most discussions (in last X weeks) Recently created
4.summary: Send weekly emails to users about latest changes in MoodleNet
description: In future, we want personalised emails but, for now, regular updates about whats been added over the last week is good enough. bernini - please look into 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: MoodleNet
summary: Users receive notifications from MoodleNet both in-app and by email
description: Users receive notifications from MoodleNet both in-app and by email.
### Response:
1.summary: Provide link to all recent activity and users recent activity
description: Weve discussed this in passing, but I noticed on Changemap how useful it is to have an all activity and my activity view. --- After discussion with I suggest we create two views in the sidebar: 1. All recent activity - all activities from all actors (i.e. users, communities, collections) 2. Your recent activity - all activities from one actor (i.e. the logged-in user) This issue will probably need a corresponding backend issue.
2.summary: Calculate numbers of active users
description: This is probably further out, but would be good to know how many people have been recently active (and display that somewhere) (also on profiles, potentially) Store date last active (action = created, posted, or upvoted something) per user, and calculate/store the total number of recently active (in last X days) per: instance community collection For quick and general stats on an instance, we could start by storing some basic in-memory stats based on certain GraphQL queries e.g. For all MoodleNet instances, the numbers could be exposed as part of federation and HQ API, see
3.summary: Sort communities by more than recent
description: Currently, the all communities view show most recently created communities. However, we should create options so that users can sort by: Recently active (new default) Most collections Most members Maybe also: Most resources Most discussions (in last X weeks) Recently created
4.summary: Send weekly emails to users about latest changes in MoodleNet
description: In future, we want personalised emails but, for now, regular updates about whats been added over the last week is good enough. bernini - please look into 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: Improve usability on notifications preferences
description: Hi!! In the Apps team were talking about rethinking the notifications settings page. For some of us is pretty difficult to configure and take too much time. For this reason I thought about rethinking the whole notifications system regarding settings. The user should be able to easily disable all notifications per plug-in. I.e. Disable all e-mail notifications. All mobile push, etc. Disabling will grey out all the column. PROS: Easily disconnect all notifications on e-mail. Each "notification type" i.e "Assignment notifications" should have a "greater setting" that enables/disables all notifications of this type but also implies that enabling it will enable the current "Web" Notification plug-ins. Of course we should remove that "Web" notification plug-in from the list. Disabling it will grey out all the row. PROS: Having a greater hierarchy on notifications per type will make the notifications drawer on web and mobile a "notifications center" with all the history of notifications received. Also, many people misses the push notification and they cannot see it again because web is disabled. (The notification drawer is EXACTLY the same on mobile than on web) I would simplify Online/Offline setting to "On"/"Only when offline"/"Off" or even only "On/Off" without Online/Offline distinction. it would imply losing some freedom but IMO it would be more helpful. PROS: Less switches to configure. The LMS uses 5 minutes time check to know if someone is online or offline. If the user goes away (without closing session) and a notification is send on the next 5 minutes it cannot be received if only offline is selected. Extra: Change ON/OFF by modern switches. Extra 2: Adds info, per notification when this is delivered (ie. Notification 1: Delivered by mail and mobile). Additionally, literal of the "mobile" notification plug-in should change to Push notification on mobile. Something that implies that its a push notification. A quick mock-up: !mockup.png|width=394,height=250,thumbnail! Also we can show the settings like they do on Facebook: !facebook.png|width=330,height=157,thumbnail! I think this will imply a huge improvement because some people are complaining about lost notifications (not received, or even not shown anywhere). Changing the meaning for the notification drawer to have all the history of the notifications sent will be a great improvement. Cross link to the forum discussion with a different explanation here:
| Solvable | 1.summary: Remove online-offline options on notifications.
description: Simplify Online/Offline setting to "On"/"Off" without Online/Offline distinction. It would imply losing some freedom but it increases the usability a lot by reducing the number of switches to set and solve the following big problem: The LMS uses 5 minutes time check to know if someone is online or offline. If the user goes away (without closing session) and a notification is send on the next 5 minutes it cannot be received if only offline is selected. Also Change ON/OFF on notifications preferences by modern switches. The migration of the data has some taken decisions: To avoid loose of data on notifications: If Online or Offline has been set to On then it will be kept as On. If both are Off, then it will be kept as Off. On default notification preferences: Permitted / Disallowed / Forced have been removed and now we have two switches: Locked and Enabled, with the combination of both we can have the same behaviour as before, with reduced number of clicks. On db/messages.php file now, Weve deprecated constants MESSAGE_DEFAULT_LOGGEDIN and MESSAGE_DEFAULT_LOGGEDOFF in favour of MESSAGE_DEFAULT_ENABLED. However they will maintain same functionality as in point 1 (if any is provided, then its enabled. Also regarding to db/messages configuration file: MESSAGE_PERMITTED / MESSAGE_DISALLOWED and MESSAGE_FORCED have been maintained to allow backwards compatibility.
| 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 usability on notifications preferences
description: Hi!! In the Apps team were talking about rethinking the notifications settings page. For some of us is pretty difficult to configure and take too much time. For this reason I thought about rethinking the whole notifications system regarding settings. The user should be able to easily disable all notifications per plug-in. I.e. Disable all e-mail notifications. All mobile push, etc. Disabling will grey out all the column. PROS: Easily disconnect all notifications on e-mail. Each "notification type" i.e "Assignment notifications" should have a "greater setting" that enables/disables all notifications of this type but also implies that enabling it will enable the current "Web" Notification plug-ins. Of course we should remove that "Web" notification plug-in from the list. Disabling it will grey out all the row. PROS: Having a greater hierarchy on notifications per type will make the notifications drawer on web and mobile a "notifications center" with all the history of notifications received. Also, many people misses the push notification and they cannot see it again because web is disabled. (The notification drawer is EXACTLY the same on mobile than on web) I would simplify Online/Offline setting to "On"/"Only when offline"/"Off" or even only "On/Off" without Online/Offline distinction. it would imply losing some freedom but IMO it would be more helpful. PROS: Less switches to configure. The LMS uses 5 minutes time check to know if someone is online or offline. If the user goes away (without closing session) and a notification is send on the next 5 minutes it cannot be received if only offline is selected. Extra: Change ON/OFF by modern switches. Extra 2: Adds info, per notification when this is delivered (ie. Notification 1: Delivered by mail and mobile). Additionally, literal of the "mobile" notification plug-in should change to Push notification on mobile. Something that implies that its a push notification. A quick mock-up: !mockup.png|width=394,height=250,thumbnail! Also we can show the settings like they do on Facebook: !facebook.png|width=330,height=157,thumbnail! I think this will imply a huge improvement because some people are complaining about lost notifications (not received, or even not shown anywhere). Changing the meaning for the notification drawer to have all the history of the notifications sent will be a great improvement. Cross link to the forum discussion with a different explanation here:
### Response:
1.summary: Remove online-offline options on notifications.
description: Simplify Online/Offline setting to "On"/"Off" without Online/Offline distinction. It would imply losing some freedom but it increases the usability a lot by reducing the number of switches to set and solve the following big problem: The LMS uses 5 minutes time check to know if someone is online or offline. If the user goes away (without closing session) and a notification is send on the next 5 minutes it cannot be received if only offline is selected. Also Change ON/OFF on notifications preferences by modern switches. The migration of the data has some taken decisions: To avoid loose of data on notifications: If Online or Offline has been set to On then it will be kept as On. If both are Off, then it will be kept as Off. On default notification preferences: Permitted / Disallowed / Forced have been removed and now we have two switches: Locked and Enabled, with the combination of both we can have the same behaviour as before, with reduced number of clicks. On db/messages.php file now, Weve deprecated constants MESSAGE_DEFAULT_LOGGEDIN and MESSAGE_DEFAULT_LOGGEDOFF in favour of MESSAGE_DEFAULT_ENABLED. However they will maintain same functionality as in point 1 (if any is provided, then its enabled. Also regarding to db/messages configuration file: MESSAGE_PERMITTED / MESSAGE_DISALLOWED and MESSAGE_FORCED have been maintained to allow backwards compatibility.
|
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 Atto back to core, and add the required features to make it the best thing ever
description: Add Atto back to Moodle core and add or improve it enough to be suitable as the default text editor in Moodle.
| Unsolvable | 1.summary: Atto: add image drag and drop capability in editing window
description: One of the most common activities. Should be a doddle to code for you guys. Dont get confused or distracted with other aspects such as image resizing. Those are merely Nice to Have.
2.summary: Import code from Atto back to core.
description: Bump versions, import the code back from github, add to standard plugins, move pix_icons into core folder etc. Note: Coordinate with David Mudrak about AMOS strings again.
3.summary: Import collapse plugin from prototype.moodle.net
description: The code for the collapse plugin was only done for the prototype.moodle.net site - get and check the code for it.
4.summary: Implement a new equation editor for Atto
description: We have several sources to choose from. The requirements of the equation editor seem to be: 1/ Work with existing equations created with dragmath etc. 2/ Provide tabs with buttons for adding common latex elements (See mathquill) 3/ Provide live equation preview while editing the equation 4/ Show preview of equation in text editor (even before content is saved) 5/ Allow access to the tex source of the equation 6/ Allow editing of an existing equation without downloading/uploading files. This is tied to the choice for filter for rendering equations, because the filter should be responsible for displaying the equations in the live preview, and/or the content editable region. There is an equation editor in the prototype.moodle.net site which uses mathjax, but it does not give you a list of tabs/buttons for common functions (not a useful one anyway).
5.summary: Auto cleanup Atto HTML
description: Especially from paste and paste from word functions. I have an experimental branch for this somewhere based on regexes. The hard thing here is getting sufficient testing data - access to several versions of word would help.
6.summary: New Atto plugin Insert Character
description: Add an insert character plugin to atto.
7.summary: New Atto plugin Insert Smiley
description: Add insert smiley plugin
8.summary: New Atto plugin switch language LTR/RTL
description: Add a plugin for this (disabled by default?)
9.summary: Plugins for font/background colours in Atto
description: Disabled by default. Accessibilty concerns around contrast.
10.summary: Add mediamanager plugin for Atto
description: This requires an iframe in the popup because it uses an mform (which has dependencies etc to load).
11.summary: Add Undo/Redo plugins to Atto
description: Even though you can already do this with your native undo/redo shortcuts for your OS - it has been asked for.
12.summary: Add a toolbar editor to Atto
description: Allow re-ordering and grouping buttons via an admin page.
13.summary: Add a content accessibility checker plugin for Atto
description: Research either online tools or javascript libraries for checking the accessibility of a block of html and giving recommendations. Ckeditor has a plugin like this.
14.summary: Atto: input text should not have for parent the contenteditable tag
description: Input texts should be wrapped in a tag if some of the input content has for parent the contenteditable tag. pasted texts should be encapsulated into a tag if it contains element for which the parent is the contenteditable tag. same on key pressed. These points are for both html and source mode. .Why do we need that if you trigger an action on a "section" which has contenteditable for parent tag, all other sections that have contenteditable for parent tag will be impacted (if the action is dealing with parent tag of course). It is not a behavior that a user will expect, and most contenteditable editors do wrap any input text into tags to avoid this issue. .Example My first section My second section My new section => if the user tries to right align this section, as we apply the action on the parent tag, the first section will be impacted too. It is not the expected user behavior. The user just want to apply the action on the new section. My third section
15.summary: Atto - add function to format the currently selected block.
description: This is needed by several issues in the sprint so Im adding this new issue to do it once and handle all the edge cases: Plugins needing this: blockquote fix, nolink, ltr/rtl
16.summary: Atto: subscript superscript button
description: Just getting this on the agenda. From Andrew on Moodle News: "From a science teacher s perspective, superscript and subscript are non-negotiables" (The old debate over what is important)
17.summary: Atto Hot keys for Headings & Styles
description: There has been a lot of discussion on design vs content. If hotkeys in some nice logical sense (remember Wordstar?) such as Shft-Ctrl 1 for H1 (etc) MAY help our users use more of the built in styles. The click to reach dropdowns is a pain. Would also help create consistency, improve the users . . .
18.summary: Add a mathjax filter
description: A demo mathjax filter was added to the prototype.moodle.net text editor demo. This is a pretty good implementation, but there are 2 problems with it. 1/ The full mathjax library is hundreds of megabytes (fonts) - its just too big to include the whole thing in Moodle. So - some fonts were stripped etc to keep the size of that one down - and it was still over 30MB. An alternative is to use the CDN mathjax library by default - and provide a method to download and install the full version into moodledata for people who require it (firewall/proxy etc). 2/ It does things properly (moodley) by wrapping the mathjax library a yui module and including it from the footer. This means that the loading of mathjax does not block the rest of the page displaying. The downside is that the alternative method of installing mathjax is to link to it in additionalhtmlhead. This includes mathjax earlier, so the equations on the page are rendered earlier - and some people prefer that option. Maybe there is an alternative way of including it that will load it earlier. 3/ However it is loaded/linked etc. In the forum samples I have seen, it is linked to from the head with almost a default configuration. This is a XSS risk - the tex allows some tokens which can produce e.g. javascript after rendering. MathJax has an option specifically for disabling those dangerous commands and this needs to be enabled.
19.summary: Refactor Atto code
description: Ive put together a (mostly) working PoC to restructure the atto code. At present, the code is based around a structure which must be aware of every editor on the page. We have to pass around an elementid, and each plugin adds buttons to their own element, but with a single click handler. The code also does not meet the coding style guidelines. IMO, we need to refactor this to: not pass around the elementid; comply with coding style requirements; include API documentation to assist plugin developers; have one editor instance per editor; have instances of the plugins on each editor rather than globally. This will: make our lives far easier in the future to maintain because well be reducing the code duplication; allow people to write plugins more easily and with much less code duplication; which will allow for a greater diversity of plugins in a shorter period; give better confidence from third-party developers writing plugins for the new editor, and as a result the community as a whole (just think how much weve complained about the TinyMCE plugin structure). Personally, I feel that this needs to be done before integration, and certainly before release. Ive been working on a PoC which is semi-functional (35 of plugins are already done and the others arent far off) and it only took a few hours to write including appropriate API docs.
20.summary: Integrate Atto
description: Final blocker issue for all chained issues in the epic.
21.summary: Add an active state to the buttons, when the text under the cursor has the style applied.
description: E.g. if the cursor is in some bold text, the bold icon should visually change.
22.summary: Additional Accessibility checker sniffs
description: Lack of headings Tables: - Missing caption - Missing headers - Using colspan/rowspan This requires the accessibility checker to be rewritten a bit, the function _addWarnings should be able to get text to display for the warning. For instance, Id like one section for table warnings, and on each lines I could say "Caption missing ", "Table is using rowspan", ...
23.summary: Atto: update the toolbar order to match tinymce
description: Atto: update the toolbar order to match tinymce
24.summary: Atto: fix the alignment of the form in the table dialogue
description: fix the alignment of the form in the table dialogue
25.summary: Atto: New plugin to select the text alignment
description: - Left aligned - Right aligned - Centered
26.summary: Small tweaks to Atto
description: Raised in scrum toolbar order (base it on tinymce) change plain to paragraph default for collapse plugin should be 5 groups fix alignment of table dialogue form insert newlines in html generated by table plugin rename accessibility helper to screenreader helper fix some broken plugin names table captions look separate from the table.
27.summary: Atto Improve API when a plugin wants multiple buttons.
description: There is a bit of code in there expecting a 1 to 1 mapping of plugins to buttons. This need not be true. Should be used by lrt/rtl, justify (link could do it too).
28.summary: Atto: The media plugin is missing a preview
description: The media plugin is missing a preview
29.summary: Atto: Convert the code to use class instances rather than static classes
description: Convert the code to use class instances rather than static classes
30.summary: Atto: Combine plugins indent/outdent into one.
description: Combine plugins indent/outdent into one.
31.summary: Atto: Combine plugins link/unlink into one
description: Combine plugins link/unlink into one.
32.summary: Atto: Ability to click on the reports from the accessibility checker to select the text automatically
description: Ability to click on the reports from the accessibility checker to select the text automatically
33.summary: Atto: Prettifying the HTML when switching to HTML view
description: Prettifying the HTML when switching to HTML view. We can use js-beautify (MIT License) for this purpose.
34.summary: Atto: Video previews should be displayed directly in the editor
description: Video previews should be displayed directly in the editor.
35.summary: Atto: Develop a word count plugin
description: Should this be part of core, or an add-on?
36.summary: Atto: cant drag the image selector.
description: Not sure whether this is a core bug or an Atto bug. Treating it initially as an Atto bug because that is where I noticed it. I found this while getting frustrated about . Select a large image (before has been fixed) and note that it is not constrained. Your only hope of getting to the button is to drag the dialogue. But you cant!
37.summary: Make atto the default editor during upgrade
description: We do this for new installs, but should do so for ugrades too.
38.summary: Explain the meaning of the group names in the toolbar configuration
description: They have no real meaning ATM but they need to be unique. This just needs explaining in the admin setting help.
39.summary: Atto plugins are using different icons for the plugin / toolbar
description: Examples are the accessibility plugins - and some of the combined plugins.
40.summary: Atto collapse plugin setting help update
description: Change description to: "Show first (n) groups when collapsed"
41.summary: Change TeX help link in equation editor to point to a moodle docs page
description: And then the moodle docs page can point to good external references.
42.summary: Atto menu styles are inconsistent
description: Atto drop down menu styles are currently using a new invented style - they should be changed to match other drop down menus in Moodle. Other menu styles in moodle are the course editing menus and the edit pdf menus. The Edit PDF menus were designed by Barbara, and the course editing ones were done by Sam. We should aim to make all 3 the same - but that is not this issue, this issue is just to pick a winner and make Atto look like that.
43.summary: Display the list of keyboard short cuts somewhere (in the alt for the buttons?)
description: And should take into account the current browser etc.
44.summary: Atto image plugin - remove the word "Preview" from the dialogue.
description: Its unnecessary.
45.summary: Change wording in Atto image plugin
description: This is about the alt / decorative only fields. New wording: Describe this image for someone who cannot see it / Description not necessary"
46.summary: Show previews for media files linked in Atto
description: This is a bit of work, it probably requires changes to the file repositories, Atto, the filter etc. The goal is to show a poster image of a linked video in the content of the editor.
47.summary: Atto: Save cursor position with undo/redo stack and restore it
description: This was a suggestion from Fred in the Atto demo.
48.summary: Atto Table plugin caption field should be a text input, not a textarea
description: Simples.
49.summary: Change table context menu, to open from the table button, not the table cell
description: Also maybe change the wording to e.g. "Insert column after current cell".
50.summary: Atto : show html view with a monospace font
description: what it says
51.summary: Make Atto equation editor dialogue wider
description: just a bit (keep mobile in mind too please)
52.summary: Atto Equation Editor example toolbar should have consistently sized buttons
description: Set a min-width on the buttons in the examples toolbar, so they will line up better.
53.summary: Atto equation editor, put a border around the preview
description: What it says
54.summary: Atto: Tables should be modifiable using the the table dialogue after they are created
description: At present, when you are in a table and you click the Table plugin button, a context menu appears allowing you to add or delete rows. Using this context menu you cannot adjust the header row settings or remove the caption row. It would be good if there was an "Edit table" option in the context menu that allowed you to edit the table in the creation dialogue.
55.summary: Atto Table plugin forces caption and headers
description: For accessibility reasons we are encouraging users to add captions and headers to their tables. However captions and headers are not always relevant, so while we should encourage their use, we should not be forcing users to use them. Looking at the WCAG, captions and headers are not mandatory ( and allowing for layout tables that, while we might frown upon them, are allowed and will be used by our users. When creating a table you can add a caption, however there is no way to not add a caption to a table. The only way to remove a table caption is to edit the HTML of a table. For headers, I think there should be a forth option for "Neither" so that users can have a table without header row or column. For the caption, I think it should be possible to delete a caption row after the table is created using the context menu. During creation, if a user does not specify a caption, no caption should be added; alternately there could be an explicit control for captions, perhaps like the alt tag control.
56.summary: Atto Table plugin does not allow border and padding to be altered
description: The tables that can be created using Atto have no border and no cell padding or spacing. Text in such tables has no separation. It should be possible to adjust the table border, padding and spacing during table creation and afterwards.
57.summary: Atto Too many image alignment options
description: I think superscript and subscript can be removed - probably some others too. We want to keep these interfaces simple.
58.summary: Write behat tests for Atto functionalities
description: This issue should probably become an epic, but Im filing it so we do not forget.
59.summary: Automatically and periodically save WYSIWYG editor content as a draft/concept
description: This emerged during the discussion at . Shortly: use AJAX to automatically and periodically (eg. every minute) save the content of a WYSIWYG editor to the concepts (drafts) space. See GMail for the working example. It seems to me that we could use table mdl_post for this therefore not DB changes should be required. There will be a flag for a rich text field definitions that enables this feature. Every WYSIWYG will have to have some uniq identifier. Concepts are accessible to their owners only (and admins?) - maybe via a card in their profiles? Their lifetime is a subject of configuration - couple of hours 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: Add Atto back to core, and add the required features to make it the best thing ever
description: Add Atto back to Moodle core and add or improve it enough to be suitable as the default text editor in Moodle.
### Response:
1.summary: Atto: add image drag and drop capability in editing window
description: One of the most common activities. Should be a doddle to code for you guys. Dont get confused or distracted with other aspects such as image resizing. Those are merely Nice to Have.
2.summary: Import code from Atto back to core.
description: Bump versions, import the code back from github, add to standard plugins, move pix_icons into core folder etc. Note: Coordinate with David Mudrak about AMOS strings again.
3.summary: Import collapse plugin from prototype.moodle.net
description: The code for the collapse plugin was only done for the prototype.moodle.net site - get and check the code for it.
4.summary: Implement a new equation editor for Atto
description: We have several sources to choose from. The requirements of the equation editor seem to be: 1/ Work with existing equations created with dragmath etc. 2/ Provide tabs with buttons for adding common latex elements (See mathquill) 3/ Provide live equation preview while editing the equation 4/ Show preview of equation in text editor (even before content is saved) 5/ Allow access to the tex source of the equation 6/ Allow editing of an existing equation without downloading/uploading files. This is tied to the choice for filter for rendering equations, because the filter should be responsible for displaying the equations in the live preview, and/or the content editable region. There is an equation editor in the prototype.moodle.net site which uses mathjax, but it does not give you a list of tabs/buttons for common functions (not a useful one anyway).
5.summary: Auto cleanup Atto HTML
description: Especially from paste and paste from word functions. I have an experimental branch for this somewhere based on regexes. The hard thing here is getting sufficient testing data - access to several versions of word would help.
6.summary: New Atto plugin Insert Character
description: Add an insert character plugin to atto.
7.summary: New Atto plugin Insert Smiley
description: Add insert smiley plugin
8.summary: New Atto plugin switch language LTR/RTL
description: Add a plugin for this (disabled by default?)
9.summary: Plugins for font/background colours in Atto
description: Disabled by default. Accessibilty concerns around contrast.
10.summary: Add mediamanager plugin for Atto
description: This requires an iframe in the popup because it uses an mform (which has dependencies etc to load).
11.summary: Add Undo/Redo plugins to Atto
description: Even though you can already do this with your native undo/redo shortcuts for your OS - it has been asked for.
12.summary: Add a toolbar editor to Atto
description: Allow re-ordering and grouping buttons via an admin page.
13.summary: Add a content accessibility checker plugin for Atto
description: Research either online tools or javascript libraries for checking the accessibility of a block of html and giving recommendations. Ckeditor has a plugin like this.
14.summary: Atto: input text should not have for parent the contenteditable tag
description: Input texts should be wrapped in a tag if some of the input content has for parent the contenteditable tag. pasted texts should be encapsulated into a tag if it contains element for which the parent is the contenteditable tag. same on key pressed. These points are for both html and source mode. .Why do we need that if you trigger an action on a "section" which has contenteditable for parent tag, all other sections that have contenteditable for parent tag will be impacted (if the action is dealing with parent tag of course). It is not a behavior that a user will expect, and most contenteditable editors do wrap any input text into tags to avoid this issue. .Example My first section My second section My new section => if the user tries to right align this section, as we apply the action on the parent tag, the first section will be impacted too. It is not the expected user behavior. The user just want to apply the action on the new section. My third section
15.summary: Atto - add function to format the currently selected block.
description: This is needed by several issues in the sprint so Im adding this new issue to do it once and handle all the edge cases: Plugins needing this: blockquote fix, nolink, ltr/rtl
16.summary: Atto: subscript superscript button
description: Just getting this on the agenda. From Andrew on Moodle News: "From a science teacher s perspective, superscript and subscript are non-negotiables" (The old debate over what is important)
17.summary: Atto Hot keys for Headings & Styles
description: There has been a lot of discussion on design vs content. If hotkeys in some nice logical sense (remember Wordstar?) such as Shft-Ctrl 1 for H1 (etc) MAY help our users use more of the built in styles. The click to reach dropdowns is a pain. Would also help create consistency, improve the users . . .
18.summary: Add a mathjax filter
description: A demo mathjax filter was added to the prototype.moodle.net text editor demo. This is a pretty good implementation, but there are 2 problems with it. 1/ The full mathjax library is hundreds of megabytes (fonts) - its just too big to include the whole thing in Moodle. So - some fonts were stripped etc to keep the size of that one down - and it was still over 30MB. An alternative is to use the CDN mathjax library by default - and provide a method to download and install the full version into moodledata for people who require it (firewall/proxy etc). 2/ It does things properly (moodley) by wrapping the mathjax library a yui module and including it from the footer. This means that the loading of mathjax does not block the rest of the page displaying. The downside is that the alternative method of installing mathjax is to link to it in additionalhtmlhead. This includes mathjax earlier, so the equations on the page are rendered earlier - and some people prefer that option. Maybe there is an alternative way of including it that will load it earlier. 3/ However it is loaded/linked etc. In the forum samples I have seen, it is linked to from the head with almost a default configuration. This is a XSS risk - the tex allows some tokens which can produce e.g. javascript after rendering. MathJax has an option specifically for disabling those dangerous commands and this needs to be enabled.
19.summary: Refactor Atto code
description: Ive put together a (mostly) working PoC to restructure the atto code. At present, the code is based around a structure which must be aware of every editor on the page. We have to pass around an elementid, and each plugin adds buttons to their own element, but with a single click handler. The code also does not meet the coding style guidelines. IMO, we need to refactor this to: not pass around the elementid; comply with coding style requirements; include API documentation to assist plugin developers; have one editor instance per editor; have instances of the plugins on each editor rather than globally. This will: make our lives far easier in the future to maintain because well be reducing the code duplication; allow people to write plugins more easily and with much less code duplication; which will allow for a greater diversity of plugins in a shorter period; give better confidence from third-party developers writing plugins for the new editor, and as a result the community as a whole (just think how much weve complained about the TinyMCE plugin structure). Personally, I feel that this needs to be done before integration, and certainly before release. Ive been working on a PoC which is semi-functional (35 of plugins are already done and the others arent far off) and it only took a few hours to write including appropriate API docs.
20.summary: Integrate Atto
description: Final blocker issue for all chained issues in the epic.
21.summary: Add an active state to the buttons, when the text under the cursor has the style applied.
description: E.g. if the cursor is in some bold text, the bold icon should visually change.
22.summary: Additional Accessibility checker sniffs
description: Lack of headings Tables: - Missing caption - Missing headers - Using colspan/rowspan This requires the accessibility checker to be rewritten a bit, the function _addWarnings should be able to get text to display for the warning. For instance, Id like one section for table warnings, and on each lines I could say "Caption missing ", "Table is using rowspan", ...
23.summary: Atto: update the toolbar order to match tinymce
description: Atto: update the toolbar order to match tinymce
24.summary: Atto: fix the alignment of the form in the table dialogue
description: fix the alignment of the form in the table dialogue
25.summary: Atto: New plugin to select the text alignment
description: - Left aligned - Right aligned - Centered
26.summary: Small tweaks to Atto
description: Raised in scrum toolbar order (base it on tinymce) change plain to paragraph default for collapse plugin should be 5 groups fix alignment of table dialogue form insert newlines in html generated by table plugin rename accessibility helper to screenreader helper fix some broken plugin names table captions look separate from the table.
27.summary: Atto Improve API when a plugin wants multiple buttons.
description: There is a bit of code in there expecting a 1 to 1 mapping of plugins to buttons. This need not be true. Should be used by lrt/rtl, justify (link could do it too).
28.summary: Atto: The media plugin is missing a preview
description: The media plugin is missing a preview
29.summary: Atto: Convert the code to use class instances rather than static classes
description: Convert the code to use class instances rather than static classes
30.summary: Atto: Combine plugins indent/outdent into one.
description: Combine plugins indent/outdent into one.
31.summary: Atto: Combine plugins link/unlink into one
description: Combine plugins link/unlink into one.
32.summary: Atto: Ability to click on the reports from the accessibility checker to select the text automatically
description: Ability to click on the reports from the accessibility checker to select the text automatically
33.summary: Atto: Prettifying the HTML when switching to HTML view
description: Prettifying the HTML when switching to HTML view. We can use js-beautify (MIT License) for this purpose.
34.summary: Atto: Video previews should be displayed directly in the editor
description: Video previews should be displayed directly in the editor.
35.summary: Atto: Develop a word count plugin
description: Should this be part of core, or an add-on?
36.summary: Atto: cant drag the image selector.
description: Not sure whether this is a core bug or an Atto bug. Treating it initially as an Atto bug because that is where I noticed it. I found this while getting frustrated about . Select a large image (before has been fixed) and note that it is not constrained. Your only hope of getting to the button is to drag the dialogue. But you cant!
37.summary: Make atto the default editor during upgrade
description: We do this for new installs, but should do so for ugrades too.
38.summary: Explain the meaning of the group names in the toolbar configuration
description: They have no real meaning ATM but they need to be unique. This just needs explaining in the admin setting help.
39.summary: Atto plugins are using different icons for the plugin / toolbar
description: Examples are the accessibility plugins - and some of the combined plugins.
40.summary: Atto collapse plugin setting help update
description: Change description to: "Show first (n) groups when collapsed"
41.summary: Change TeX help link in equation editor to point to a moodle docs page
description: And then the moodle docs page can point to good external references.
42.summary: Atto menu styles are inconsistent
description: Atto drop down menu styles are currently using a new invented style - they should be changed to match other drop down menus in Moodle. Other menu styles in moodle are the course editing menus and the edit pdf menus. The Edit PDF menus were designed by Barbara, and the course editing ones were done by Sam. We should aim to make all 3 the same - but that is not this issue, this issue is just to pick a winner and make Atto look like that.
43.summary: Display the list of keyboard short cuts somewhere (in the alt for the buttons?)
description: And should take into account the current browser etc.
44.summary: Atto image plugin - remove the word "Preview" from the dialogue.
description: Its unnecessary.
45.summary: Change wording in Atto image plugin
description: This is about the alt / decorative only fields. New wording: Describe this image for someone who cannot see it / Description not necessary"
46.summary: Show previews for media files linked in Atto
description: This is a bit of work, it probably requires changes to the file repositories, Atto, the filter etc. The goal is to show a poster image of a linked video in the content of the editor.
47.summary: Atto: Save cursor position with undo/redo stack and restore it
description: This was a suggestion from Fred in the Atto demo.
48.summary: Atto Table plugin caption field should be a text input, not a textarea
description: Simples.
49.summary: Change table context menu, to open from the table button, not the table cell
description: Also maybe change the wording to e.g. "Insert column after current cell".
50.summary: Atto : show html view with a monospace font
description: what it says
51.summary: Make Atto equation editor dialogue wider
description: just a bit (keep mobile in mind too please)
52.summary: Atto Equation Editor example toolbar should have consistently sized buttons
description: Set a min-width on the buttons in the examples toolbar, so they will line up better.
53.summary: Atto equation editor, put a border around the preview
description: What it says
54.summary: Atto: Tables should be modifiable using the the table dialogue after they are created
description: At present, when you are in a table and you click the Table plugin button, a context menu appears allowing you to add or delete rows. Using this context menu you cannot adjust the header row settings or remove the caption row. It would be good if there was an "Edit table" option in the context menu that allowed you to edit the table in the creation dialogue.
55.summary: Atto Table plugin forces caption and headers
description: For accessibility reasons we are encouraging users to add captions and headers to their tables. However captions and headers are not always relevant, so while we should encourage their use, we should not be forcing users to use them. Looking at the WCAG, captions and headers are not mandatory ( and allowing for layout tables that, while we might frown upon them, are allowed and will be used by our users. When creating a table you can add a caption, however there is no way to not add a caption to a table. The only way to remove a table caption is to edit the HTML of a table. For headers, I think there should be a forth option for "Neither" so that users can have a table without header row or column. For the caption, I think it should be possible to delete a caption row after the table is created using the context menu. During creation, if a user does not specify a caption, no caption should be added; alternately there could be an explicit control for captions, perhaps like the alt tag control.
56.summary: Atto Table plugin does not allow border and padding to be altered
description: The tables that can be created using Atto have no border and no cell padding or spacing. Text in such tables has no separation. It should be possible to adjust the table border, padding and spacing during table creation and afterwards.
57.summary: Atto Too many image alignment options
description: I think superscript and subscript can be removed - probably some others too. We want to keep these interfaces simple.
58.summary: Write behat tests for Atto functionalities
description: This issue should probably become an epic, but Im filing it so we do not forget.
59.summary: Automatically and periodically save WYSIWYG editor content as a draft/concept
description: This emerged during the discussion at . Shortly: use AJAX to automatically and periodically (eg. every minute) save the content of a WYSIWYG editor to the concepts (drafts) space. See GMail for the working example. It seems to me that we could use table mdl_post for this therefore not DB changes should be required. There will be a flag for a rich text field definitions that enables this feature. Every WYSIWYG will have to have some uniq identifier. Concepts are accessible to their owners only (and admins?) - maybe via a card in their profiles? Their lifetime is a subject of configuration - couple of hours 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: MoodleNet
summary: User Experience (UX) Improvements
description: We are making several user experience (UX) improvements as a result of a design sprint.
| Unsolvable | 1.summary: GDPR Review
description: Per this issue: This would allow all tracking cookies to be turned off by the user (i.e. Google Analytics).
2.summary: URLs of collections should only use the key and ignore the rest.
description: I noticed that when I changed the name of a collection (or resource), that the URL does not change to match and keeps the original name. I feel like this is not the best we can do. What is the point of putting this long random unique key in the title if we dont even rely on it to find the right record? It also means that typos in the creation of the record can not be fixed, and that records can never be improved or updated. What would be better: - We rely on the key only, and ignore all the text following it. - The key is shorter and less invasive on the URL. The current key is overkill for the number of resources one could have on a server. (36^12 = 4.7383813e+18) There is a possible issue with this, in that trolls could then invent URLs that will be misleading. But they could also just invent any old URL like this with a new collection any time they like anyway, or as a query param, so I dont see this as an additional problem.
3.summary: Use only approved users to compute num followers
description: When checking the followers we might find different number of users as the number displayed on the profile page. This is because we are counting any user on the followers parameter but only displaying the approved users on the followers page. We need to agree on a solution. Either we display all users on the followers page, either we do not count the non approved users on the followers counter.
4.summary: Resource format
description: I have uploaded a SCORM package (which is a .zip file). System recognised it its format and displayed as "application/zip", which is accurate of course but its not meaningful for educators. When I edited the resource I couldnt specify things more. That would be an issue for Moodle activities/backups. For educator it is important to know if an .mbz file is a backup of a Quiz activity, Assignment activity, a Book resource or a whole course file.
5.summary: Trending subjects
description: Trending subjects display "not further defined" and "not elsewhere classified" subjects... arent they hidden from the ISCED-f list?
6.summary: See the followers
description: Currently I see that a couple of people are following me, but I cant see whos following me.
7.summary: Change icons of Publication status and License to have the same colour
description: Change icons to have the same colour
8.summary: Global variable changes
description: Changeable global variables from the interface.
9.summary: Remove intro card from landing page
description: We have seen that the introductory card can be removed, as the title and the content make the purpose of the site self-explanatory enough. And so now we have more room to show material and eye-catching images. Before: !image-2022-02-23-14-35-11-168.png|width=527,height=311! After: !image-2022-02-23-14-35-54-669.png|width=531,height=312!
10.summary: Hiding organization field of users
description: For the time being the organization name is not relevant as we dont let users edit them and so everyone has the instance name as a default and uneditable. We might want to make it editable and give the option to the instance managers if they want to make the editable or not. Personally I would add it asap, it is an important element to know better the users and their background. What do you think paul.hodgson alessandrogiansanti annakrassa ? Before: !image-2022-02-23-14-42-11-228.png|width=483,height=171! !image-2022-02-23-14-42-39-614.png|width=344,height=120! After: !image-2022-02-23-14-47-01-314.png|width=478,height=153! !image-2022-02-23-14-48-11-579.png|width=270,height=114!
11.summary: Default Images
description: The default images for when a user does not add cover images to their resources or collections are grey (see attached file grey boxes). We should improve this to provide a more appealing user experience.
12.summary: Get rid of the "popup" you get when you click on images
description: The popup you get when you click on the image of a resource is completely useless. !image-2022-04-08-10-40-46-866.png|thumbnail! We should just get rid of that immediately, and perhaps think about replacing later with a dialog that offers options that the user has with this resources, eg to "download" and "send to Moodle" etc
13.summary: Improve text in messages
description: The text in messages are a bit confusing... user receives a message, but he doesnt realise wheres the message... !Screenshot.png!
14.summary: Kudos - show who gave them
description: A user should be able to see who gave them a kudo.
15.summary: "Reply" to the message option
description: It would be useful to have at some point a way to "reply". Adding a simple communication system would be ideal here, otherwise just a reply button on the email that opens the profil page and the message modal.
16.summary: See followers
description: A user should be able to see who are their followers.
17.summary: We need a browser plugin, or a clever bookmark to grab current pages
description: We need a browser plugin, or a clever bookmark, to make it easy to grab ANY current page you are currently looking at. Clicking it would take you straight to your preferred MoodleNet server (moodle.net default) and into "Add a resource" mode, with fields already filled in from the page.
18.summary: MoodleNet should be good at identifying sites better
description: If I link to a video on Youtube, eg. then MoodleNet should be able to indicate its a Youtube video. Or much much better, embed the video preview. Same for other sites, lets make MoodleNet smart about common ones and do more of the work of showcasing those things, and also giving us better understanding of where the resource is from.
19.summary: react-app UI : Appearance/customization config & storage
description: finalize UI and hook to backend services
20.summary: organization/instance package UI
description: finalize UI for organization info config and fetch
21.summary: react-app UI: Manage root user client-session
description: Manage user-session as it could be of a root user. Consider reviewing data struct for `clientSession: ClientSession` in auth context to make it easier to use
22.summary: profile package : frontend
description: finalize UI and hooks to BE
23.summary: Brand Guidelines Update
description: Update the logos and colour palettes in moodle.net and published packages in accordance with new Moodle brand guidelines.
| 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 Experience (UX) Improvements
description: We are making several user experience (UX) improvements as a result of a design sprint.
### Response:
1.summary: GDPR Review
description: Per this issue: This would allow all tracking cookies to be turned off by the user (i.e. Google Analytics).
2.summary: URLs of collections should only use the key and ignore the rest.
description: I noticed that when I changed the name of a collection (or resource), that the URL does not change to match and keeps the original name. I feel like this is not the best we can do. What is the point of putting this long random unique key in the title if we dont even rely on it to find the right record? It also means that typos in the creation of the record can not be fixed, and that records can never be improved or updated. What would be better: - We rely on the key only, and ignore all the text following it. - The key is shorter and less invasive on the URL. The current key is overkill for the number of resources one could have on a server. (36^12 = 4.7383813e+18) There is a possible issue with this, in that trolls could then invent URLs that will be misleading. But they could also just invent any old URL like this with a new collection any time they like anyway, or as a query param, so I dont see this as an additional problem.
3.summary: Use only approved users to compute num followers
description: When checking the followers we might find different number of users as the number displayed on the profile page. This is because we are counting any user on the followers parameter but only displaying the approved users on the followers page. We need to agree on a solution. Either we display all users on the followers page, either we do not count the non approved users on the followers counter.
4.summary: Resource format
description: I have uploaded a SCORM package (which is a .zip file). System recognised it its format and displayed as "application/zip", which is accurate of course but its not meaningful for educators. When I edited the resource I couldnt specify things more. That would be an issue for Moodle activities/backups. For educator it is important to know if an .mbz file is a backup of a Quiz activity, Assignment activity, a Book resource or a whole course file.
5.summary: Trending subjects
description: Trending subjects display "not further defined" and "not elsewhere classified" subjects... arent they hidden from the ISCED-f list?
6.summary: See the followers
description: Currently I see that a couple of people are following me, but I cant see whos following me.
7.summary: Change icons of Publication status and License to have the same colour
description: Change icons to have the same colour
8.summary: Global variable changes
description: Changeable global variables from the interface.
9.summary: Remove intro card from landing page
description: We have seen that the introductory card can be removed, as the title and the content make the purpose of the site self-explanatory enough. And so now we have more room to show material and eye-catching images. Before: !image-2022-02-23-14-35-11-168.png|width=527,height=311! After: !image-2022-02-23-14-35-54-669.png|width=531,height=312!
10.summary: Hiding organization field of users
description: For the time being the organization name is not relevant as we dont let users edit them and so everyone has the instance name as a default and uneditable. We might want to make it editable and give the option to the instance managers if they want to make the editable or not. Personally I would add it asap, it is an important element to know better the users and their background. What do you think paul.hodgson alessandrogiansanti annakrassa ? Before: !image-2022-02-23-14-42-11-228.png|width=483,height=171! !image-2022-02-23-14-42-39-614.png|width=344,height=120! After: !image-2022-02-23-14-47-01-314.png|width=478,height=153! !image-2022-02-23-14-48-11-579.png|width=270,height=114!
11.summary: Default Images
description: The default images for when a user does not add cover images to their resources or collections are grey (see attached file grey boxes). We should improve this to provide a more appealing user experience.
12.summary: Get rid of the "popup" you get when you click on images
description: The popup you get when you click on the image of a resource is completely useless. !image-2022-04-08-10-40-46-866.png|thumbnail! We should just get rid of that immediately, and perhaps think about replacing later with a dialog that offers options that the user has with this resources, eg to "download" and "send to Moodle" etc
13.summary: Improve text in messages
description: The text in messages are a bit confusing... user receives a message, but he doesnt realise wheres the message... !Screenshot.png!
14.summary: Kudos - show who gave them
description: A user should be able to see who gave them a kudo.
15.summary: "Reply" to the message option
description: It would be useful to have at some point a way to "reply". Adding a simple communication system would be ideal here, otherwise just a reply button on the email that opens the profil page and the message modal.
16.summary: See followers
description: A user should be able to see who are their followers.
17.summary: We need a browser plugin, or a clever bookmark to grab current pages
description: We need a browser plugin, or a clever bookmark, to make it easy to grab ANY current page you are currently looking at. Clicking it would take you straight to your preferred MoodleNet server (moodle.net default) and into "Add a resource" mode, with fields already filled in from the page.
18.summary: MoodleNet should be good at identifying sites better
description: If I link to a video on Youtube, eg. then MoodleNet should be able to indicate its a Youtube video. Or much much better, embed the video preview. Same for other sites, lets make MoodleNet smart about common ones and do more of the work of showcasing those things, and also giving us better understanding of where the resource is from.
19.summary: react-app UI : Appearance/customization config & storage
description: finalize UI and hook to backend services
20.summary: organization/instance package UI
description: finalize UI for organization info config and fetch
21.summary: react-app UI: Manage root user client-session
description: Manage user-session as it could be of a root user. Consider reviewing data struct for `clientSession: ClientSession` in auth context to make it easier to use
22.summary: profile package : frontend
description: finalize UI and hooks to BE
23.summary: Brand Guidelines Update
description: Update the logos and colour palettes in moodle.net and published packages in accordance with new Moodle brand guidelines.
|
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: Workshop module improvements
description: While running the MOOC at learn.moodle.net, couple of small usability issues with the current Workshop module raised. This META epic is here to summarize them all so they can be converted into separate issues. Ideas and notes are freely worded here with undefined order. When the final grades are re-calculated during the grading evaluation phase, we were missing settings like "Require at least X received assessments" and "Require at least X given reviews". If the participant did not pass these conditions, the grade (or grading grade respectively) would not be calculated to them. This is to prevent a situation when the final grade is based on a single received peer-assessment. The X number would actually be interpreted as a "weighted count" - if 3 received assessment were required, it would be enough to have a single assessment from a teacher with the weight set to 3. We were missing a possibility to hide enrolled students who did not actually participate in the Workshop. In our MOOC, roughly 10 of enrolled students actually participated in the Workshop (i.e. submitted their own work). Having all enrolled students listed in the grades overview made the grades report harder to navigate. When an additional assessment was done, or an assessment weight was changed etc. during the grading evaluation phase, there should be a warning/notice reminding to recalculate grades. Number of pending assessments to be displayed so the teacher knows "where are we", what the progress is. Ability to filter submissions that need an extra assessment (by the teacher typically). This mostly covers submissions that were allocated to reviewers who then did not review anything. It could also be more sophisticated to detect submissions where the teachers assessment would be good to have as the existing assessments do not support (match) each other. When grades are re-calculated during the grading evaluation phase, some sort of report would be nice to have. It would show new/changed grades so the teacher can see and compare the effect of various evaluation parameters. Ability to flag submissions and assessments (like questions in the quiz attempt or e-mails in Gmail). The flag would be shared by all teachers so they could use it as a communication tool (e.g. to mark and remember submissions to look closely at) Ability to search for and filter submissions in the grades report (by the authors name etc) - including a way to display just one submission per page. Teachers cant see the calculated grading grade for an assessment when viewing the submissions assessments. Make the planner tool (the one with phases) responsive, using the 100 container width and collapsible. Ability to rename and delete submissions. New "overview" allocation method. It would not actually allocate anything, but it would provide some detailed stats about the situation (and it would become the default allocation screen). Beside these, more conceptual issues (mostly the problem with isolated and distinct phases that are forced to everybody) were confirmed. But those will be addressed in a separate epic. Edit: Two great blog posts with very useful suggestions to be considered:
| Solvable | 1.summary: Prepare UI mockups for the new Workshop version
description: Mobile first AMD + jQuery + AJAX + Mustache based
| 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: Workshop module improvements
description: While running the MOOC at learn.moodle.net, couple of small usability issues with the current Workshop module raised. This META epic is here to summarize them all so they can be converted into separate issues. Ideas and notes are freely worded here with undefined order. When the final grades are re-calculated during the grading evaluation phase, we were missing settings like "Require at least X received assessments" and "Require at least X given reviews". If the participant did not pass these conditions, the grade (or grading grade respectively) would not be calculated to them. This is to prevent a situation when the final grade is based on a single received peer-assessment. The X number would actually be interpreted as a "weighted count" - if 3 received assessment were required, it would be enough to have a single assessment from a teacher with the weight set to 3. We were missing a possibility to hide enrolled students who did not actually participate in the Workshop. In our MOOC, roughly 10 of enrolled students actually participated in the Workshop (i.e. submitted their own work). Having all enrolled students listed in the grades overview made the grades report harder to navigate. When an additional assessment was done, or an assessment weight was changed etc. during the grading evaluation phase, there should be a warning/notice reminding to recalculate grades. Number of pending assessments to be displayed so the teacher knows "where are we", what the progress is. Ability to filter submissions that need an extra assessment (by the teacher typically). This mostly covers submissions that were allocated to reviewers who then did not review anything. It could also be more sophisticated to detect submissions where the teachers assessment would be good to have as the existing assessments do not support (match) each other. When grades are re-calculated during the grading evaluation phase, some sort of report would be nice to have. It would show new/changed grades so the teacher can see and compare the effect of various evaluation parameters. Ability to flag submissions and assessments (like questions in the quiz attempt or e-mails in Gmail). The flag would be shared by all teachers so they could use it as a communication tool (e.g. to mark and remember submissions to look closely at) Ability to search for and filter submissions in the grades report (by the authors name etc) - including a way to display just one submission per page. Teachers cant see the calculated grading grade for an assessment when viewing the submissions assessments. Make the planner tool (the one with phases) responsive, using the 100 container width and collapsible. Ability to rename and delete submissions. New "overview" allocation method. It would not actually allocate anything, but it would provide some detailed stats about the situation (and it would become the default allocation screen). Beside these, more conceptual issues (mostly the problem with isolated and distinct phases that are forced to everybody) were confirmed. But those will be addressed in a separate epic. Edit: Two great blog posts with very useful suggestions to be considered:
### Response:
1.summary: Prepare UI mockups for the new Workshop version
description: Mobile first AMD + jQuery + AJAX + Mustache based
|
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 issues
description: This epic consolidates the issues with messaging.
| Unsolvable | 1.summary: Remove any old messaging styles in core
description: We are creating a whole new UI - which comes with new styles. Get rid of the others!
2.summary: Deprecate/remove any unused lang strings in core
description: Some strings may no longer be used - deprecate them.
3.summary: Write unit tests for all new web services
description: This needs to be done.
4.summary: Write behat tests for new messaging UI
description: Currently we do not have an extensive range of Behat tests for the new messaging UI.
5.summary: Write unit tests for all new API functions
description: We added a new API in message/classes that requires unit tests. There currently already exists a file called api_test.php which needs extending.
6.summary: Ensure searching does not reveal information it shouldnt
description: The user should not be able to search courses they do not have access to, or see students belonging to those courses.
7.summary: Message area should update with ajax rather than page reload
description: When viewing a conversation in the message area we should do an ajax request for new messages in the background and update the page if there are any, rather than just waiting for the user to reload the whole page. The request frequency to back off over time to ensure we arent spamming the server. E.g. wait 5 seconds and check, if no results then wait 10 seconds, if no results then wait 30 etc. If you get results at any point it can reset the frequency.
8.summary: Write behat tests for notification popover
description: Write behat tests to cover the new notification popover
9.summary: Write behat tests for messages popover
description: Write behat tests for the messages popover
10.summary: Add keyboard navigation to stand alone notifications page
description: Add keyboard navigation to stand alone notifications page. Up and down to navigate the list of notifications.
11.summary: Web service is not available error when clicking messaging icon after expected timeout
description: I clicked the Messaging icon in the header on the prototype site after being inactive for a day and I was given the following error message: noformat Web service is not available (it doesnt exist or might be disabled) File: .../lib/externallib.php Line: 214 Stack trace: Error code: servicenotavailable noformat Replication steps. Log in as a user. Run php admin/cli/kill_all_sessions.php. Click on the messaging icon in the top-right.
12.summary: Improve notification preferences on/off buttons so they fit better with non-English strings
description: We have this problem using french : On = Activer Off = D sactiver Theses words are to large to be used in a square button (see screenshot) I think other language may have this problem too. Here is some solutions : Use power On / Off symbols instead: | and O (see Keep On / Off in all language Instead of using the on / off lang string, create and use a specific on / off strings (ex. switch.on, switch.off) to allow local translation of this. It may be also be used to create specific local strings for admin of user instance to differentiate this strings from other on / off strings. Adapt the font size to fit the container width (not possible in pure css) See : Use a standard checkbox (half joking!)
13.summary: notification_processor_settings.js uses the tool_lp/dialogue
description: Err yeah... we should fix this. message/amd/src/notification_processor_settings.js: code define(jquery, core/ajax, core/notification, core/fragment, core/templates, core/str, tool_lp/dialogue, code
14.summary: Existing notifications are not shown in popover if all notifications are disabled
description: If the user has existing notifications (read or unread) and then decides to disable all future notifications by checking the "disable all notifications" checkbox in their notification preferences we no longer show the existing notifications in the popover. It might be better to keep displaying existing notifications and only prevent further notifications from showing rather than not displaying the existing notifications. This would bring the behaviour in line with how we handle turning off individual notifications where we continue to show any previous notifications of that type that the user received.
15.summary: Notifications displays red 0 when there are no notifications
description: Login to Moodle as anyone. Click the notifications icon to show the list of notifications. Click it again to close the list of notifications. View the red "0" is now displayed next to the notifications icon. There are other things that could be improved but should be done in a different issue (why are unread notifications "red" - no error has occurred).
16.summary: Cleanup task for message_popup_notifications table
description: messaging_cleanup_task removes old read and unread message notifications based on $CFG->messagingdeletereadnotificationsdelay and $CFG->messagingdeleteallnotificationsdelay settings. But doesnt remove any record from message_popup_notifications. So there are some orphaned records in message_popup_notifications table remaining with no related message_notifications record. There should be a cleanup task to remove all orphaned records in message_popup_notifications table.
| 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 issues
description: This epic consolidates the issues with messaging.
### Response:
1.summary: Remove any old messaging styles in core
description: We are creating a whole new UI - which comes with new styles. Get rid of the others!
2.summary: Deprecate/remove any unused lang strings in core
description: Some strings may no longer be used - deprecate them.
3.summary: Write unit tests for all new web services
description: This needs to be done.
4.summary: Write behat tests for new messaging UI
description: Currently we do not have an extensive range of Behat tests for the new messaging UI.
5.summary: Write unit tests for all new API functions
description: We added a new API in message/classes that requires unit tests. There currently already exists a file called api_test.php which needs extending.
6.summary: Ensure searching does not reveal information it shouldnt
description: The user should not be able to search courses they do not have access to, or see students belonging to those courses.
7.summary: Message area should update with ajax rather than page reload
description: When viewing a conversation in the message area we should do an ajax request for new messages in the background and update the page if there are any, rather than just waiting for the user to reload the whole page. The request frequency to back off over time to ensure we arent spamming the server. E.g. wait 5 seconds and check, if no results then wait 10 seconds, if no results then wait 30 etc. If you get results at any point it can reset the frequency.
8.summary: Write behat tests for notification popover
description: Write behat tests to cover the new notification popover
9.summary: Write behat tests for messages popover
description: Write behat tests for the messages popover
10.summary: Add keyboard navigation to stand alone notifications page
description: Add keyboard navigation to stand alone notifications page. Up and down to navigate the list of notifications.
11.summary: Web service is not available error when clicking messaging icon after expected timeout
description: I clicked the Messaging icon in the header on the prototype site after being inactive for a day and I was given the following error message: noformat Web service is not available (it doesnt exist or might be disabled) File: .../lib/externallib.php Line: 214 Stack trace: Error code: servicenotavailable noformat Replication steps. Log in as a user. Run php admin/cli/kill_all_sessions.php. Click on the messaging icon in the top-right.
12.summary: Improve notification preferences on/off buttons so they fit better with non-English strings
description: We have this problem using french : On = Activer Off = D sactiver Theses words are to large to be used in a square button (see screenshot) I think other language may have this problem too. Here is some solutions : Use power On / Off symbols instead: | and O (see Keep On / Off in all language Instead of using the on / off lang string, create and use a specific on / off strings (ex. switch.on, switch.off) to allow local translation of this. It may be also be used to create specific local strings for admin of user instance to differentiate this strings from other on / off strings. Adapt the font size to fit the container width (not possible in pure css) See : Use a standard checkbox (half joking!)
13.summary: notification_processor_settings.js uses the tool_lp/dialogue
description: Err yeah... we should fix this. message/amd/src/notification_processor_settings.js: code define(jquery, core/ajax, core/notification, core/fragment, core/templates, core/str, tool_lp/dialogue, code
14.summary: Existing notifications are not shown in popover if all notifications are disabled
description: If the user has existing notifications (read or unread) and then decides to disable all future notifications by checking the "disable all notifications" checkbox in their notification preferences we no longer show the existing notifications in the popover. It might be better to keep displaying existing notifications and only prevent further notifications from showing rather than not displaying the existing notifications. This would bring the behaviour in line with how we handle turning off individual notifications where we continue to show any previous notifications of that type that the user received.
15.summary: Notifications displays red 0 when there are no notifications
description: Login to Moodle as anyone. Click the notifications icon to show the list of notifications. Click it again to close the list of notifications. View the red "0" is now displayed next to the notifications icon. There are other things that could be improved but should be done in a different issue (why are unread notifications "red" - no error has occurred).
16.summary: Cleanup task for message_popup_notifications table
description: messaging_cleanup_task removes old read and unread message notifications based on $CFG->messagingdeletereadnotificationsdelay and $CFG->messagingdeleteallnotificationsdelay settings. But doesnt remove any record from message_popup_notifications. So there are some orphaned records in message_popup_notifications table remaining with no related message_notifications record. There should be a cleanup task to remove all orphaned records in message_popup_notifications table.
|
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: Action logging improvements META
description: There are multiple known problems in the logging infrastructure such as: weird definition of log actions (SQL commands stored in SQL table, missing definition, wrong data used, ...) performance very many actions are not logged (the problem is if we add more logging performance will suffer) etc. This is a meta issue that should help us plan major cleanup in this area.
| Unsolvable | 1.summary: remove sql code from log_display
description: Eloy Lafuente (stronk7) added a comment - 03/Aug/10 06:07 PM BTW, next step should be to create a bunch of: LOG_DISPLAY_USER_FULLNAME LOG_DISPLAY_MD_AGE_IN_DAYS ... constants to be used in the logs.php definitions, replacing any DB-dependent bit and implement the necessary logic in logs output to handle them properly. Ciao
2.summary: New event when a file was viewed by user (for optional logging)
description: Recently, i tried to get a log report of students viewing some files (they were not supposed to) and i found out that there is no logging of such activity. (In Moodle 1.9.x and Moodle 2.x) I suggest adding a log entry function to /file.php for both Moodle versions maybe: add_to_log($course->id, file, view, "/file.php/$course->id/$file", "$course->id"); (not sure if the above syntax is good for both Moodle 1.9 and 2.x)
3.summary: Add logging of activity when a user is logged in as another user
description: When a user with the moodle/user:loginas capability logs in as another user and performs any activity, this activity is not logged. It would be nice if it was logged and clearly denoted in the logs as "X user logged in as Y user". This would probably mean rewriting the add_to_log function in some way - currently, it prevents logging if the userids are not the same.
4.summary: Log insert performance can be improved for busy sites that use Postgres
description: Inserts to mdl_log are among the most significant database queries on our system - they dont take that long to run, but we usually do somewhere in the range of 3-10 log inserts per second, so it adds up. On Postgres, running single insert 100 times is much slower than running 100 inserts in a single transaction. I made a patch which allows you to select a local folder (must be on real local filesystem, not NFS etc, because it relies on file locking working) where log inserts will be cached for a number of seconds. When there is another log insert after that many seconds (eg 30), all the cached inserts are added into log. So your log table is delayed by about 30 seconds. This works fine with multiple servers (each having their own cache file, of course, since they are local). On test servers I saw 20ms improvement per logged page view during a load test. Improvement is less significant if database is not loaded. We are currently most concerned about database performance so time saved per page isnt really the key number for us - however this should also correspond to time/effort saved by the database server as well. Notes This patch applies to OU Moodle only. I can port it to Moodle 1.9 or (more likely) Moodle 2 if desired. We will be deploying this code to our live system on 3 June so it will get significant testing after that... Other proper transactional databases may also receive performance improvement from this patch, but Postgres is the only one I know about. Depending on how many entries are cached, on those requests where it does actually insert a batch, users might notice the slight delay (maybe 1ms per entry). The impact of this is obviously low on pages where the add_to_log call is at the end.
5.summary: Course creation log
description: I want a log of all course creations and who did them. If you add //New course report new => get_string(new), into the $actions array definition in /course/report/log/lib.php then you can get a log of (just) new course creations, who made them when. You need to have the main (Site) course selected. The only new things that come up (for me) are courses which is what I wanted. Due to a bug / duplication (see you need to enter this into BOTH places that $actions is set.
6.summary: Review all Logging actions in Tags and remove any use of phrases
description: As pointed by Eloy in . We should not be using direct phrases (for example tag names etc) in logs instead those should be handled by log.php files. We need to review all logging actions in tags and make appropriate changes wherever possible. Thanks
7.summary: Use base enrollib for logging enrolments instead of different screens
description: At the moment, were using a different system to enrol new users via the manual enrolment method. This creates a problem. The enrol log entry will only be created if someone is manually managing the enrolments for a course. Please move the add_to_log from /enrol/manual/manage.php to /lib/enrollib.php in class enrol_plugin function enrol_user. This might also be valid for unenrolments. The effect this will have is people using automated systems to enrol users, will actually have logs ;-).
| 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: Action logging improvements META
description: There are multiple known problems in the logging infrastructure such as: weird definition of log actions (SQL commands stored in SQL table, missing definition, wrong data used, ...) performance very many actions are not logged (the problem is if we add more logging performance will suffer) etc. This is a meta issue that should help us plan major cleanup in this area.
### Response:
1.summary: remove sql code from log_display
description: Eloy Lafuente (stronk7) added a comment - 03/Aug/10 06:07 PM BTW, next step should be to create a bunch of: LOG_DISPLAY_USER_FULLNAME LOG_DISPLAY_MD_AGE_IN_DAYS ... constants to be used in the logs.php definitions, replacing any DB-dependent bit and implement the necessary logic in logs output to handle them properly. Ciao
2.summary: New event when a file was viewed by user (for optional logging)
description: Recently, i tried to get a log report of students viewing some files (they were not supposed to) and i found out that there is no logging of such activity. (In Moodle 1.9.x and Moodle 2.x) I suggest adding a log entry function to /file.php for both Moodle versions maybe: add_to_log($course->id, file, view, "/file.php/$course->id/$file", "$course->id"); (not sure if the above syntax is good for both Moodle 1.9 and 2.x)
3.summary: Add logging of activity when a user is logged in as another user
description: When a user with the moodle/user:loginas capability logs in as another user and performs any activity, this activity is not logged. It would be nice if it was logged and clearly denoted in the logs as "X user logged in as Y user". This would probably mean rewriting the add_to_log function in some way - currently, it prevents logging if the userids are not the same.
4.summary: Log insert performance can be improved for busy sites that use Postgres
description: Inserts to mdl_log are among the most significant database queries on our system - they dont take that long to run, but we usually do somewhere in the range of 3-10 log inserts per second, so it adds up. On Postgres, running single insert 100 times is much slower than running 100 inserts in a single transaction. I made a patch which allows you to select a local folder (must be on real local filesystem, not NFS etc, because it relies on file locking working) where log inserts will be cached for a number of seconds. When there is another log insert after that many seconds (eg 30), all the cached inserts are added into log. So your log table is delayed by about 30 seconds. This works fine with multiple servers (each having their own cache file, of course, since they are local). On test servers I saw 20ms improvement per logged page view during a load test. Improvement is less significant if database is not loaded. We are currently most concerned about database performance so time saved per page isnt really the key number for us - however this should also correspond to time/effort saved by the database server as well. Notes This patch applies to OU Moodle only. I can port it to Moodle 1.9 or (more likely) Moodle 2 if desired. We will be deploying this code to our live system on 3 June so it will get significant testing after that... Other proper transactional databases may also receive performance improvement from this patch, but Postgres is the only one I know about. Depending on how many entries are cached, on those requests where it does actually insert a batch, users might notice the slight delay (maybe 1ms per entry). The impact of this is obviously low on pages where the add_to_log call is at the end.
5.summary: Course creation log
description: I want a log of all course creations and who did them. If you add //New course report new => get_string(new), into the $actions array definition in /course/report/log/lib.php then you can get a log of (just) new course creations, who made them when. You need to have the main (Site) course selected. The only new things that come up (for me) are courses which is what I wanted. Due to a bug / duplication (see you need to enter this into BOTH places that $actions is set.
6.summary: Review all Logging actions in Tags and remove any use of phrases
description: As pointed by Eloy in . We should not be using direct phrases (for example tag names etc) in logs instead those should be handled by log.php files. We need to review all logging actions in tags and make appropriate changes wherever possible. Thanks
7.summary: Use base enrollib for logging enrolments instead of different screens
description: At the moment, were using a different system to enrol new users via the manual enrolment method. This creates a problem. The enrol log entry will only be created if someone is manually managing the enrolments for a course. Please move the add_to_log from /enrol/manual/manage.php to /lib/enrollib.php in class enrol_plugin function enrol_user. This might also be valid for unenrolments. The effect this will have is people using automated systems to enrol users, will actually have logs ;-).
|
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: Bugs in existing functionality that need fixing ASAP
description: Bugs in existing functionality that need fixing ASAP
| Unsolvable | 1.summary: Interface Language change reverts to default after refresh
description: From tester: "I configure the interface language in Spanish but when I reload the page (F5), the language returns to the predefined one, English."
2.summary: Improve error message when adding title instead of URL
description: From tester: "Submitting a title instead of a URL in the resource submission form results in an error message, and then the user is still taken to the full submission form." !cyeBFi3.png!
3.summary: Make in-browser GraphQL cache expire after 5min
description: eg. when creating (or following?) a community and then going to Joined, it does not appear (caching issue - expire cache after particular time period? 5 mins?)
4.summary: Validate on the backend that a user-submitted url looks like a real url
description: The error message is quite unfriendly if you submit an invalid URL, we should make it better
5.summary: Produce a better error on the backend if fetching a url fails
description: We should improve the message the user sees.
| 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: Bugs in existing functionality that need fixing ASAP
description: Bugs in existing functionality that need fixing ASAP
### Response:
1.summary: Interface Language change reverts to default after refresh
description: From tester: "I configure the interface language in Spanish but when I reload the page (F5), the language returns to the predefined one, English."
2.summary: Improve error message when adding title instead of URL
description: From tester: "Submitting a title instead of a URL in the resource submission form results in an error message, and then the user is still taken to the full submission form." !cyeBFi3.png!
3.summary: Make in-browser GraphQL cache expire after 5min
description: eg. when creating (or following?) a community and then going to Joined, it does not appear (caching issue - expire cache after particular time period? 5 mins?)
4.summary: Validate on the backend that a user-submitted url looks like a real url
description: The error message is quite unfriendly if you submit an invalid URL, we should make it better
5.summary: Produce a better error on the backend if fetching a url fails
description: We should improve the message the user sees.
|
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: File API improvements to handle clustering environments
description: This has been talked about for many years but appears not to have an issue filed for it. Moodle Files currently go into dataroot directory on the server filesystem. This can cause problems when Moodle is used in server cluster environments where there may not even be local filesystems, when synchronisation is required across potentially many web servers. This issue is the starting point for solving this problem. 1) Collect solutions/ideas/hacks from the community and discuss. 2) Define a specification for core implementation in Moodle 3) Split into subtasks under this issue. 4) Complete the implementation.
| Unsolvable | 1.summary: Move file-system specific components of file_storage and stored_file to new overridable API
description: Update the file_storage, and stored_file classes to move all real file operations to a new file_system class. The file_system class should be fully functional on its own, but overridable such that any file operation can be replaced with an alternative file system (e.g. S3, Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.). Ive also taken the liberty of moving all of this to its own namespace such that it supports autoloading.
| 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: File API improvements to handle clustering environments
description: This has been talked about for many years but appears not to have an issue filed for it. Moodle Files currently go into dataroot directory on the server filesystem. This can cause problems when Moodle is used in server cluster environments where there may not even be local filesystems, when synchronisation is required across potentially many web servers. This issue is the starting point for solving this problem. 1) Collect solutions/ideas/hacks from the community and discuss. 2) Define a specification for core implementation in Moodle 3) Split into subtasks under this issue. 4) Complete the implementation.
### Response:
1.summary: Move file-system specific components of file_storage and stored_file to new overridable API
description: Update the file_storage, and stored_file classes to move all real file operations to a new file_system class. The file_system class should be fully functional on its own, but overridable such that any file operation can be replaced with an alternative file system (e.g. S3, Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.). Ive also taken the liberty of moving all of this to its own namespace such that it supports autoloading.
|
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.4 upgrade
description: Moodle 3.4 is scheduled for release on Monday 13 November 2017.
| Unsolvable | 1.summary: Upgrade moodle.org to 3.4
description:
2.summary: Upgrade learn.moodle.net to 3.4
description:
3.summary: Upgrade lang.moodle.org to 3.4
description:
4.summary: Upgrade school.demo.moodle.net to 3.4
description:
5.summary: Upgrade demo.moodle.net to 3.4
description:
6.summary: Upgrade dev.moodle.org to 3.4
description:
7.summary: Upgrade moodle.net to 3.4
description: This will include: Tag latest code in local_hub plugin with tag v3.3 Make modifications to local_hub to make it compatible with Moodle 3.4, bump version and required version Remove core hack made in , instead add the workaround to the local_hub login/signin.php page should be moved to local/hub/signin.php. This will need modification of $CFG->alternateloginurl after moodle.net 3.4 is deployed Add new WS to remove local_sitecheck in the future (see also ) . During transition period local_sitecheck will stay in deploy branch Remove local_linkchecker from deploy branch, it is no longer used
8.summary: Upgrade download.moodle.org to 3.4
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.4 upgrade
description: Moodle 3.4 is scheduled for release on Monday 13 November 2017.
### Response:
1.summary: Upgrade moodle.org to 3.4
description:
2.summary: Upgrade learn.moodle.net to 3.4
description:
3.summary: Upgrade lang.moodle.org to 3.4
description:
4.summary: Upgrade school.demo.moodle.net to 3.4
description:
5.summary: Upgrade demo.moodle.net to 3.4
description:
6.summary: Upgrade dev.moodle.org to 3.4
description:
7.summary: Upgrade moodle.net to 3.4
description: This will include: Tag latest code in local_hub plugin with tag v3.3 Make modifications to local_hub to make it compatible with Moodle 3.4, bump version and required version Remove core hack made in , instead add the workaround to the local_hub login/signin.php page should be moved to local/hub/signin.php. This will need modification of $CFG->alternateloginurl after moodle.net 3.4 is deployed Add new WS to remove local_sitecheck in the future (see also ) . During transition period local_sitecheck will stay in deploy branch Remove local_linkchecker from deploy branch, it is no longer used
8.summary: Upgrade download.moodle.org to 3.4
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: Lesson module
description: Please consider implementing the Lesson module into the Moodle Mobile app. Implementing the Lesson module and enabling users to download and complete Lessons offline would be a significant development for users faced with limited internet access and/or high tariffs for data usage. Users could download contents in areas with wifi access and complete them at another time and place. The issue of Moodle Mobile support for the Lesson module has been discussed in the Lesson module forum at moodle.org.
| Solvable | 1.summary: Implement basic lesson without questions
description: We should start by supporting lessons with only content pages and no extra settings. That is, no progress bar, menu, media file, etc.
2.summary: Support Lesson Appearance options (menu, progress bar, ...)
description: We should support all (or most) of the appearance options of the lesson.
3.summary: Support Lesson time limit and password
description: We should support the Time Limit and passwords in Lessons.
4.summary: Support all type of questions in Lesson
description: We should support all types of questions in Lessons. We should try to reuse code from quiz questions.
5.summary: Support reviewing Lesson attempts (student)
description: We should support reviewing Lesson attempts, just like Moodle web does. Please notice that question attempts can only be reviewed right after finishing them.
6.summary: Implement prefetch and offline for Lessons with no questions and no random jumps
description: We should support prefetch and offline in Lessons. A good start would be to support only content Lessons without random jumps.
7.summary: Implement prefetch and offline for Lessons with questions and random jumps
description: We should support prefetch and offline in Lessons. We should support all cases.
8.summary: Capture lesson links
description: We should capture the lesson links using the content links delegate.
9.summary: Implement teacher view in Lesson
description: We should support teacher view in lessons. The teacher should be able to preview the lesson and see students attempts.
10.summary: Refurbish Lesson to follow UX instructions
description: Apply the design of UX-33 to the lesson.
| 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: Lesson module
description: Please consider implementing the Lesson module into the Moodle Mobile app. Implementing the Lesson module and enabling users to download and complete Lessons offline would be a significant development for users faced with limited internet access and/or high tariffs for data usage. Users could download contents in areas with wifi access and complete them at another time and place. The issue of Moodle Mobile support for the Lesson module has been discussed in the Lesson module forum at moodle.org.
### Response:
1.summary: Implement basic lesson without questions
description: We should start by supporting lessons with only content pages and no extra settings. That is, no progress bar, menu, media file, etc.
2.summary: Support Lesson Appearance options (menu, progress bar, ...)
description: We should support all (or most) of the appearance options of the lesson.
3.summary: Support Lesson time limit and password
description: We should support the Time Limit and passwords in Lessons.
4.summary: Support all type of questions in Lesson
description: We should support all types of questions in Lessons. We should try to reuse code from quiz questions.
5.summary: Support reviewing Lesson attempts (student)
description: We should support reviewing Lesson attempts, just like Moodle web does. Please notice that question attempts can only be reviewed right after finishing them.
6.summary: Implement prefetch and offline for Lessons with no questions and no random jumps
description: We should support prefetch and offline in Lessons. A good start would be to support only content Lessons without random jumps.
7.summary: Implement prefetch and offline for Lessons with questions and random jumps
description: We should support prefetch and offline in Lessons. We should support all cases.
8.summary: Capture lesson links
description: We should capture the lesson links using the content links delegate.
9.summary: Implement teacher view in Lesson
description: We should support teacher view in lessons. The teacher should be able to preview the lesson and see students attempts.
10.summary: Refurbish Lesson to follow UX instructions
description: Apply the design of UX-33 to the lesson.
|
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: Improving the way we deal with synchronisation of entities between Moodle and BigBlueButton
description: When we create a BigblueButton activity in moodle, we match it with a meeting ID in BigblueButton (server). This is fine for most of the case but there has been reported issues when we either delete or copy (or backup and restore) the Moodle activity. Problem that can occur are: Issue when deleting the Bigbluebutton activity ( ) Issue when deleting an activity that has been copied () There might be other issues that are related to this and they will be attached to this ticket for further examination in order to find a more generic solution for these kind of problems.
| Unsolvable | 1.summary: Change the way "recording ready notifications" are handled by the plugin
description: This is required as a consequence of changing the way recordings are handled.
2.summary: Revamp the way of handling groups for meetings and recordings
description: Since the way recordings are handled was updated, we need to change groups accordingly
3.summary: Improve performance when fetching recordings
description: Improve the fetching of recordings from the BBB server to: call in batches (recording persistent object) cache results (recording_proxy), until: an event is triggerd; or a ttl is reached
| 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: Improving the way we deal with synchronisation of entities between Moodle and BigBlueButton
description: When we create a BigblueButton activity in moodle, we match it with a meeting ID in BigblueButton (server). This is fine for most of the case but there has been reported issues when we either delete or copy (or backup and restore) the Moodle activity. Problem that can occur are: Issue when deleting the Bigbluebutton activity ( ) Issue when deleting an activity that has been copied () There might be other issues that are related to this and they will be attached to this ticket for further examination in order to find a more generic solution for these kind of problems.
### Response:
1.summary: Change the way "recording ready notifications" are handled by the plugin
description: This is required as a consequence of changing the way recordings are handled.
2.summary: Revamp the way of handling groups for meetings and recordings
description: Since the way recordings are handled was updated, we need to change groups accordingly
3.summary: Improve performance when fetching recordings
description: Improve the fetching of recordings from the BBB server to: call in batches (recording persistent object) cache results (recording_proxy), until: an event is triggerd; or a ttl is reached
|
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 lesson creation interface
description: During the project week here at HQ I wanted to see if I could create a more user friendly interface to create lessons in Moodle. I have developed a prototype which shows the basic functionality and direction that I am looking at taking. Here is a link to a demonstration I gave during the developer meeting This issue is to actually take the prototype and make it a core feature of Moodle.
| Unsolvable | 1.summary: Create web services for lesson ajax requests.
description: The actions in ajax.php need to be moved into web services. Most of the actions are hacks and need to use the proper lesson API. Actions savepostion createcontent deletelessonpage linklessonpages getjumpoptions getlessondata updatelessonpage movepage getjumprecords
2.summary: Implement drag and drop without using jqueryui
description: The prototype code is using jqueryui, which is not allowed in core. The use of jqueryui in the prototype code is for drag and drop. Change this over to use a standard HTML 5 implementation
3.summary: Use fragments to load edit forms
description: The prototype hard codes the forms for editing data. We have implemented fragments which allows us to use mforms for this situation. The callback (see fragment implementation) may have to call new functions to return new custom forms.
4.summary: Implement drag and drop of page objects directly in a cluster / subcluster.
description: The prototype doesnt behave well trying to drag page elements from the menu bar directly into the cluster / subcluster. This would be the most logical way of adding lesson pages to a cluster.
5.summary: Organise elements in a cluster / subcluster towards the top.
description: When adding lesson pages to a cluster or sub-cluster, the objects sometimes end up in weird locations in the cluster. All of the elements should be towards the top of the cluster / sub-cluster area.
6.summary: Moving items out of a cluster should remove them from the cluster.
description: You can move questions out of the cluster and they appear to be outside the cluster, but no AJAX call is made and so when the page is refreshed the question appears back in the cluster.
7.summary: Implement all lesson page types in the menu bar.
description: The prototype only has a sub-set of the available page types in the menu to drag onto the lesson page. Add the remaining lesson page types.
8.summary: Error check and disable the ability to add too many jumps (answers).
description: Some of the lesson pages should only have a limited number of "jumps" or "answers". The main example is the true or false page type. This should only ever have two answers.
9.summary: Add a function to check if an answer should be classified as correct.
description: The circle on a jump shows if the answer is considered to be correct. Currently this is only determined if a score has been allocated. We could check all of the jumps for a question and colour correct answers in green and incorrect answers in red. Things to consider: There could be multiple correct answers. Score relies on custom scoring and we would need some other way to determine what is correct or not when this is disabled. Content pages should not have their jumps colour coded.
10.summary: Improve the initial positioning of page elements in interactive mode.
description: Currently a very basic algorithm is used to position the page elements on the screen. Sometimes there are very large gaps between elements. This could be improved to make sure that everything is close together.
11.summary: Optimise code for use on other browsers besides Chrome
description: This prototype works okay on Chrome, but is almost unusable on any other browser. Investigate ways to improve performance on other browsers.
| 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 lesson creation interface
description: During the project week here at HQ I wanted to see if I could create a more user friendly interface to create lessons in Moodle. I have developed a prototype which shows the basic functionality and direction that I am looking at taking. Here is a link to a demonstration I gave during the developer meeting This issue is to actually take the prototype and make it a core feature of Moodle.
### Response:
1.summary: Create web services for lesson ajax requests.
description: The actions in ajax.php need to be moved into web services. Most of the actions are hacks and need to use the proper lesson API. Actions savepostion createcontent deletelessonpage linklessonpages getjumpoptions getlessondata updatelessonpage movepage getjumprecords
2.summary: Implement drag and drop without using jqueryui
description: The prototype code is using jqueryui, which is not allowed in core. The use of jqueryui in the prototype code is for drag and drop. Change this over to use a standard HTML 5 implementation
3.summary: Use fragments to load edit forms
description: The prototype hard codes the forms for editing data. We have implemented fragments which allows us to use mforms for this situation. The callback (see fragment implementation) may have to call new functions to return new custom forms.
4.summary: Implement drag and drop of page objects directly in a cluster / subcluster.
description: The prototype doesnt behave well trying to drag page elements from the menu bar directly into the cluster / subcluster. This would be the most logical way of adding lesson pages to a cluster.
5.summary: Organise elements in a cluster / subcluster towards the top.
description: When adding lesson pages to a cluster or sub-cluster, the objects sometimes end up in weird locations in the cluster. All of the elements should be towards the top of the cluster / sub-cluster area.
6.summary: Moving items out of a cluster should remove them from the cluster.
description: You can move questions out of the cluster and they appear to be outside the cluster, but no AJAX call is made and so when the page is refreshed the question appears back in the cluster.
7.summary: Implement all lesson page types in the menu bar.
description: The prototype only has a sub-set of the available page types in the menu to drag onto the lesson page. Add the remaining lesson page types.
8.summary: Error check and disable the ability to add too many jumps (answers).
description: Some of the lesson pages should only have a limited number of "jumps" or "answers". The main example is the true or false page type. This should only ever have two answers.
9.summary: Add a function to check if an answer should be classified as correct.
description: The circle on a jump shows if the answer is considered to be correct. Currently this is only determined if a score has been allocated. We could check all of the jumps for a question and colour correct answers in green and incorrect answers in red. Things to consider: There could be multiple correct answers. Score relies on custom scoring and we would need some other way to determine what is correct or not when this is disabled. Content pages should not have their jumps colour coded.
10.summary: Improve the initial positioning of page elements in interactive mode.
description: Currently a very basic algorithm is used to position the page elements on the screen. Sometimes there are very large gaps between elements. This could be improved to make sure that everything is close together.
11.summary: Optimise code for use on other browsers besides Chrome
description: This prototype works okay on Chrome, but is almost unusable on any other browser. Investigate ways to improve performance on other browsers.
|