Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-18083 META: Gradebook improvements - Stage 1
  3. MDL-17991

[PATCH] New visual organization for gradebook user report (including category nesting, ranges)

    Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.9.3
    • Fix Version/s: 1.9.5
    • Component/s: Gradebook
    • Labels:
      None
    • Database:
      Any
    • Affected Branches:
      MOODLE_19_STABLE
    • Fixed Branches:
      MOODLE_19_STABLE

      Description

      The current user grade report for students is fairly confusing if grade categories are used, especially if they are nested; it is very difficult to understand what category totals go with which grades. I was inspired by the nested and colored visualization Nicolas Connault provided for the categories and weights settings page in MDL-15680. As a way of understanding a bit better how the gradebook code works I decided to alter the user report to mimic his style.

      Attached is a first patch that implements the screenshot seen as User-Report-New0.png. The original view of the report is seen as User-Report-1.9.x.png.

      This patch (against 1.9.3+) uses the gradebook tree data structure and a recursive table_fill function to create an intermediate data structure which is then printed out. I threw away the tablelib code (as it seemed poorly documented and limited as to how I needed to use it (using colspan and rowspan table cells extensively).

      Future versions could possibly reveal more information to the user (statistics on each graded item, due dates on future assignments, etc.)

      The one clear and known bug is hidden grades at the user level have not been implemented as the existing code looked hackish and it was noted that it needed to be improved for 2.0.

      Looking for feedback...

        Gliffy Diagrams

          Attachments

          1. editgradettree.jpg
            editgradettree.jpg
            945 kB
          2. userreport_withpatch.jpg
            userreport_withpatch.jpg
            899 kB
          3. User-Report-1.9.x.png
            User-Report-1.9.x.png
            57 kB
          4. user-report-new.patch
            23 kB
          5. User-Report-New0.png
            User-Report-New0.png
            61 kB

            Activity

            Hide
            lael Lael... added a comment -

            patched gradetree showing formatting and colours

            Show
            lael Lael... added a comment - patched gradetree showing formatting and colours
            Hide
            lael Lael... added a comment -

            Here you can see for a more complex grade tree the user report is not formatting the same as the edit categories grade tree.

            Show
            lael Lael... added a comment - Here you can see for a more complex grade tree the user report is not formatting the same as the edit categories grade tree.
            Hide
            lael Lael... added a comment -

            Sorry - I didn't realise the comments on the screenshots showed up as comments on the tracker issue. I've applied the patch, and the result is shown above in the screenshots. The overall effect is excellent, but doesn't seem to apply the new formatting consistently to sub-nested categories. Paul - thanks for the patch and the effort, it is a big step forward.

            Show
            lael Lael... added a comment - Sorry - I didn't realise the comments on the screenshots showed up as comments on the tracker issue. I've applied the patch, and the result is shown above in the screenshots. The overall effect is excellent, but doesn't seem to apply the new formatting consistently to sub-nested categories. Paul - thanks for the patch and the effort, it is a big step forward.
            Hide
            barrysspace Barry Oosthuizen added a comment -

            Our students and staff like the layout of this report, they understand it better. I've hidden the 'percentage' column until hidden grades are implemented.

            Thanks for putting this together, a lot less confusion now.

            Show
            barrysspace Barry Oosthuizen added a comment - Our students and staff like the layout of this report, they understand it better. I've hidden the 'percentage' column until hidden grades are implemented. Thanks for putting this together, a lot less confusion now.
            Hide
            tsala Helen Foster added a comment -

            Paul, thanks for your patch, and Lael, thanks for your screenshots. It looks really good!

            Reassigning to Nicolas for consideration whether this can be included in our gradebook improvements for Moodle 1.9.5.

            Discussion about this issue: http://moodle.org/mod/forum/discuss.php?d=116972

            Show
            tsala Helen Foster added a comment - Paul, thanks for your patch, and Lael, thanks for your screenshots. It looks really good! Reassigning to Nicolas for consideration whether this can be included in our gradebook improvements for Moodle 1.9.5. Discussion about this issue: http://moodle.org/mod/forum/discuss.php?d=116972
            Hide
            nicolasconnault Nicolas Connault added a comment -

            Paul, this patch seems to have been written for PHP5. I'm removing the PHP5 keywords like "private". Please always use PHP4 syntax when writing code for pre 2.0 moodle.

            Show
            nicolasconnault Nicolas Connault added a comment - Paul, this patch seems to have been written for PHP5. I'm removing the PHP5 keywords like "private". Please always use PHP4 syntax when writing code for pre 2.0 moodle.
            Hide
            nicolasconnault Nicolas Connault added a comment -

            Paul, thanks a lot for your patch, it's well-written and works well. I've put it up for testing on the 1.9 test site, so that everyone can take a look at your handiwork I'm confident this will make it into the 1.9.5 release.

            Show
            nicolasconnault Nicolas Connault added a comment - Paul, thanks a lot for your patch, it's well-written and works well. I've put it up for testing on the 1.9 test site, so that everyone can take a look at your handiwork I'm confident this will make it into the 1.9.5 release.
            Hide
            tsala Helen Foster added a comment -

            URL for viewing the user report improvements: http://test.moodle.org/1.9/grade/report/user/index.php?id=2 (username teacher and password testm00dle)

            Nicolas, please could you ensure the colours used are colour-blind friendly i.e. green and red don't appear next to each other.

            Show
            tsala Helen Foster added a comment - URL for viewing the user report improvements: http://test.moodle.org/1.9/grade/report/user/index.php?id=2 (username teacher and password testm00dle) Nicolas, please could you ensure the colours used are colour-blind friendly i.e. green and red don't appear next to each other.
            Hide
            nicolasconnault Nicolas Connault added a comment -

            This is now in HEAD CVS and on the head test server

            Show
            nicolasconnault Nicolas Connault added a comment - This is now in HEAD CVS and on the head test server
            Hide
            tsala Helen Foster added a comment -

            Nicolas, thanks for making the colours colour-blind friendly.

            Just wondering whether the improved user report should include a range column, as the existing user report doesn't.

            Show
            tsala Helen Foster added a comment - Nicolas, thanks for making the colours colour-blind friendly. Just wondering whether the improved user report should include a range column, as the existing user report doesn't.
            Hide
            barrysspace Barry Oosthuizen added a comment -

            IMO, the new range column is a life saver for explaining to students what their marks count out of. Would be very sad to loose it.

            Show
            barrysspace Barry Oosthuizen added a comment - IMO, the new range column is a life saver for explaining to students what their marks count out of. Would be very sad to loose it.
            Hide
            nicolasconnault Nicolas Connault added a comment -

            Gradebook patch applied, resolving this issue.

            Show
            nicolasconnault Nicolas Connault added a comment - Gradebook patch applied, resolving this issue.
            Hide
            tsala Helen Foster added a comment -

            Thanks Nicolas, this improvement is now documented: http://docs.moodle.org/en/User_report

            Show
            tsala Helen Foster added a comment - Thanks Nicolas, this improvement is now documented: http://docs.moodle.org/en/User_report
            Hide
            tsala Helen Foster added a comment -

            Removing 2.0 fix version as instructions state 'Do not include the current HEAD version unless it's the only one.'

            Show
            tsala Helen Foster added a comment - Removing 2.0 fix version as instructions state 'Do not include the current HEAD version unless it's the only one.'

              People

              • Votes:
                6 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  13/May/09