Moodle

Improve gradebook help files

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.9
  • Fix Version/s: 1.9
  • Component/s: Documentation, Gradebook
  • Labels:
    None
  • Affected Branches:
    MOODLE_19_STABLE
  • Fixed Branches:
    MOODLE_19_STABLE

Issue Links

Activity

Hide
Helen Foster added a comment -

Suggested help file improvements for "My report preferences":

Show column averages - Whether to show the mean for each column.

Show groups - Whether to show the mean for each group.

Show user profile images - (no help file needed)

Show user idnumber - Whether to show user id numbers in an additional column.

Show activity icons - Whether to show activity icons next to activity names.

Show ranges - Whether to show the range of grades in an additional column.

Range display type - Specifies how to display ranges. If Inherit is selected, the display type for each column is used.

Decimals shown in ranges - Specifies the number of decimal points to display for each range. This setting may be overridden per grading item.

Column averages display type - Specifies how to display the mean for each column. If Inherit is selected, the display type for each column is used.

Decimals in column averages - Specifies the number of decimal points to display for each column mean. If Inherit is selected, the display type for each column is used.

Grades selected for column averages - Whether cells with no grade should be included when calculating the mean for each column.

Show number of grades in averages - Whether to show the number of grades used when calculating the mean in brackets after each average, for example 45 (34).

Show
Helen Foster added a comment - Suggested help file improvements for "My report preferences": Show column averages - Whether to show the mean for each column. Show groups - Whether to show the mean for each group. Show user profile images - (no help file needed) Show user idnumber - Whether to show user id numbers in an additional column. Show activity icons - Whether to show activity icons next to activity names. Show ranges - Whether to show the range of grades in an additional column. Range display type - Specifies how to display ranges. If Inherit is selected, the display type for each column is used. Decimals shown in ranges - Specifies the number of decimal points to display for each range. This setting may be overridden per grading item. Column averages display type - Specifies how to display the mean for each column. If Inherit is selected, the display type for each column is used. Decimals in column averages - Specifies the number of decimal points to display for each column mean. If Inherit is selected, the display type for each column is used. Grades selected for column averages - Whether cells with no grade should be included when calculating the mean for each column. Show number of grades in averages - Whether to show the number of grades used when calculating the mean in brackets after each average, for example 45 (34).
Hide
Helen Foster added a comment -

All comments from watchers are appreciated!

In several of the help files, I have changed the sentence "Default means to use the display type of each column." to "If Inherit is selected, the display type for each column is used." Is this correct?

Show
Helen Foster added a comment - All comments from watchers are appreciated! In several of the help files, I have changed the sentence "Default means to use the display type of each column." to "If Inherit is selected, the display type for each column is used." Is this correct?
Hide
Nicolas Connault added a comment -

Yes to your last question, Helen.

I've updated the language file with your suggested changes.

Show
Nicolas Connault added a comment - Yes to your last question, Helen. I've updated the language file with your suggested changes.
Hide
Helen Foster added a comment -

Thanks Nicolas

Suggested help string improvements for course settings:

Grade display type - Specifies how to display grades in the grader and user reports. Grades may be shown as actual grades, as percentages (in reference to the minimum and maximum grades) or as letters.

Overall decimal points - Specifies the number of decimal points to display for each grade. This setting may be overridden per grading item.

Show rank - Whether to show the position of each item in relation to the rest of the class.

Show hidden items - Whether to show hidden grade items. This setting does not affect hidden grades.

Some of my suggested improvements are tiny rewordings to ensure style consistency.

Show
Helen Foster added a comment - Thanks Nicolas Suggested help string improvements for course settings: Grade display type - Specifies how to display grades in the grader and user reports. Grades may be shown as actual grades, as percentages (in reference to the minimum and maximum grades) or as letters. Overall decimal points - Specifies the number of decimal points to display for each grade. This setting may be overridden per grading item. Show rank - Whether to show the position of each item in relation to the rest of the class. Show hidden items - Whether to show hidden grade items. This setting does not affect hidden grades. Some of my suggested improvements are tiny rewordings to ensure style consistency.
Hide
Helen Foster added a comment -

Edit:

Show rank - Whether to show the position of the user in relation to the rest of the class, for each grade item.

Show
Helen Foster added a comment - Edit: Show rank - Whether to show the position of the user in relation to the rest of the class, for each grade item.
Hide
Helen Foster added a comment -

Edit:

Show hidden items - Specifies how hidden grade items are shown. If Hide is selected, they are hidden completely. If Show is selected, the hidden grade item row is shown in grey with the grade hidden completely. If "Only hidden until" is selected, grade items with a "hide until" date set are shown in grey with the grades hidden completely until the set date, after which the whole item is shown.

(A collaborative editorial effort with Nicolas!)

Show
Helen Foster added a comment - Edit: Show hidden items - Specifies how hidden grade items are shown. If Hide is selected, they are hidden completely. If Show is selected, the hidden grade item row is shown in grey with the grade hidden completely. If "Only hidden until" is selected, grade items with a "hide until" date set are shown in grey with the grades hidden completely until the set date, after which the whole item is shown. (A collaborative editorial effort with Nicolas!)
Hide
Nicolas Connault added a comment -

Strings updated!

Show
Nicolas Connault added a comment - Strings updated!
Hide
Helen Foster added a comment -

Suggested help string improvements for Edit grade item:

Item info - A space for entering information about the item. Text entered does not appear anywhere else.

ID number - Setting an ID number provides a way of identifying the activity for grade calculation purposes. If the activity is not included in any grade calculation then the ID number field can be left blank. The ID number for an activity-based grade item may be set on the update activity page.

Grade type - Specifies the type of grade used: none (no grading possible), value (enables the maximum and minimum grade settings), scale (enables the scale setting) or text (feedback only). Only value and scale grade types may be aggregated. The grade type for an activity-based grade item is set on the update activity page.

Scale - When using the scale grade type, a scale can be selected. The scale for an activity-based grade item is selected on the update activity page.

Maximum grade - When using the value grade type, a maximum grade can be set. The maximum grade for an activity-based grade item is set on the update activity page.

Minimum grade - When using the value grade type, a minimum grade can be set.

Can anyone explain Grade to pass?

Show
Helen Foster added a comment - Suggested help string improvements for Edit grade item: Item info - A space for entering information about the item. Text entered does not appear anywhere else. ID number - Setting an ID number provides a way of identifying the activity for grade calculation purposes. If the activity is not included in any grade calculation then the ID number field can be left blank. The ID number for an activity-based grade item may be set on the update activity page. Grade type - Specifies the type of grade used: none (no grading possible), value (enables the maximum and minimum grade settings), scale (enables the scale setting) or text (feedback only). Only value and scale grade types may be aggregated. The grade type for an activity-based grade item is set on the update activity page. Scale - When using the scale grade type, a scale can be selected. The scale for an activity-based grade item is selected on the update activity page. Maximum grade - When using the value grade type, a maximum grade can be set. The maximum grade for an activity-based grade item is set on the update activity page. Minimum grade - When using the value grade type, a minimum grade can be set. Can anyone explain Grade to pass?
Hide
Nicolas Connault added a comment -

All done

Show
Nicolas Connault added a comment - All done
Hide
Martin Dougiamas added a comment -

Grade to pass - If an item has a grade that users must equal or exceed to pass that item, you can set that here.

Show
Martin Dougiamas added a comment - Grade to pass - If an item has a grade that users must equal or exceed to pass that item, you can set that here.
Hide
Martin Dougiamas added a comment -

I'm guessing this can be closed?

Show
Martin Dougiamas added a comment - I'm guessing this can be closed?
Hide
Helen Foster added a comment -

Apologies for needing to reopen this issue. All gradebook help files need to be reviewed and improved where necessary BEFORE help strings are moved from lang/en_utf8/grades.php to lang/en_utf8/help/grade - MDL-13709.

Areas of the gradebook still to do:

  • User key
  • Add outcome item

Also, when checking the improvements made so far I noticed the following:

  • Show quick feedback - help string missing
  • Show hidden items - contains \
Show
Helen Foster added a comment - Apologies for needing to reopen this issue. All gradebook help files need to be reviewed and improved where necessary BEFORE help strings are moved from lang/en_utf8/grades.php to lang/en_utf8/help/grade - MDL-13709. Areas of the gradebook still to do:
  • User key
  • Add outcome item
Also, when checking the improvements made so far I noticed the following:
  • Show quick feedback - help string missing
  • Show hidden items - contains \
Hide
Nicolas Connault added a comment -

quickfeedback help is not missing, I just forgot to rename it when I renamed quickfeedback to showquickfeedback.

Show
Nicolas Connault added a comment - quickfeedback help is not missing, I just forgot to rename it when I renamed quickfeedback to showquickfeedback.
Hide
Martin Dougiamas added a comment -

I'm not sure exactly where this is. Who is doing what and what is left?

Show
Martin Dougiamas added a comment - I'm not sure exactly where this is. Who is doing what and what is left?
Hide
Nicolas Connault added a comment -

I am finishing this off Martin. Should be in CVS shortly.

Show
Nicolas Connault added a comment - I am finishing this off Martin. Should be in CVS shortly.
Hide
Martin Dougiamas added a comment -

OK, thanks, let me know ASAP so I can take a look before release

Show
Martin Dougiamas added a comment - OK, thanks, let me know ASAP so I can take a look before release
Hide
Nicolas Connault added a comment -

In fact I think it is fine as it is. There was only the User key strings to review, but they look fine to me. Unless Helen objects, I think we're ready to move the strings.

Show
Nicolas Connault added a comment - In fact I think it is fine as it is. There was only the User key strings to review, but they look fine to me. Unless Helen objects, I think we're ready to move the strings.
Hide
Martin Dougiamas added a comment -

[[configquickfeedback]] is a missing string currently

Show
Martin Dougiamas added a comment - [[configquickfeedback]] is a missing string currently
Hide
Nicolas Connault added a comment -

fixed

Show
Nicolas Connault added a comment - fixed
Hide
Helen Foster added a comment -

User key - Grade publishing is a way of exporting grades via a URL without being logged in to Moodle. A user key is a randomly generated series of characters which is appended to the URL for security purposes.

To publish grades, select "Create a new user key". When the form is submitted, a new user key is created. Alternatively, a key which was created previously may be selected.

I've also checked the add outcome item help strings - they all look fine.

Show
Helen Foster added a comment - User key - Grade publishing is a way of exporting grades via a URL without being logged in to Moodle. A user key is a randomly generated series of characters which is appended to the URL for security purposes. To publish grades, select "Create a new user key". When the form is submitted, a new user key is created. Alternatively, a key which was created previously may be selected. I've also checked the add outcome item help strings - they all look fine.
Hide
Helen Foster added a comment -

Gradebook help file improvements squeezed into Moodle 1.9, thanks to Nicolas' great work!

Show
Helen Foster added a comment - Gradebook help file improvements squeezed into Moodle 1.9, thanks to Nicolas' great work!
Hide
Helen Foster added a comment -

It seems that further gradebook help file improvements are required. Rather than reopening this issue, let's use MDL-13789 from now on.

Show
Helen Foster added a comment - It seems that further gradebook help file improvements are required. Rather than reopening this issue, let's use MDL-13789 from now on.

People

Vote (1)
Watch (6)

Dates

  • Created:
    Updated:
    Resolved: