Issue Details (XML | Word | Printable)

Key: MDL-13663
Type: Improvement Improvement
Status: Resolved Resolved
Resolution: Fixed
Priority: Minor Minor
Assignee: Helen Foster
Reporter: Helen Foster
Votes: 1
Watchers: 6
Operations

Add/Edit UI Mockup to this issue
If you were logged in you would be able to see more operations.
Moodle

Improve gradebook help files

Created: 26/Feb/08 12:45 AM   Updated: 06/Mar/08 11:42 PM
Return to search
Component/s: Documentation, Gradebook
Affects Version/s: 1.9
Fix Version/s: 1.9

Issue Links:
Dependency
 
Duplicate
 
Relates
 

Participants: Helen Foster, Martin Dougiamas and Nicolas Connault
Security Level: None
Resolved date: 03/Mar/08
Affected Branches: MOODLE_19_STABLE
Fixed Branches: MOODLE_19_STABLE


 All   Comments   Change History   Version Control      Sort Order: Ascending order - Click to sort in descending order
Helen Foster made changes - 26/Feb/08 12:45 AM
Field Original Value New Value
Link This issue will help resolve MDLSITE-347 [ MDLSITE-347 ]
Helen Foster added a comment - 26/Feb/08 01:03 AM
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).


Helen Foster added a comment - 26/Feb/08 01:06 AM
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?


Nicolas Connault committed 2 files to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 26/Feb/08 06:56 PM
Nicolas Connault committed 2 files to 'Moodle CVS' - 26/Feb/08 07:00 PM
MDL-13663 Docs updated. Merging from MOODLE_19_STABLE
MODIFY grade/report/grader/preferences_form.php   Rev. 1.44    (+4 -2 lines)
MODIFY lang/en_utf8/grades.php   Rev. 1.148    (+15 -12 lines)
Nicolas Connault added a comment - 26/Feb/08 07:03 PM
Yes to your last question, Helen.

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


Helen Foster added a comment - 26/Feb/08 09:10 PM
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.


Martin Dougiamas made changes - 26/Feb/08 10:18 PM
Fix Version/s 1.9 [ 10190 ]
Helen Foster added a comment - 27/Feb/08 12:02 AM
Edit:

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


Helen Foster added a comment - 27/Feb/08 12:46 AM
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!)


Nicolas Connault committed 1 file to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 27/Feb/08 01:25 AM
MDL-13663 Docs updated.
MODIFY lang/en_utf8/grades.php   Rev. 1.111.2.39    (+5 -5 lines)
Nicolas Connault committed 1 file to 'Moodle CVS' - 27/Feb/08 01:27 AM
MDL-13663 Docs updated. Merging from MOODLE_19_STABLE
MODIFY lang/en_utf8/grades.php   Rev. 1.150    (+5 -9 lines)
Nicolas Connault added a comment - 27/Feb/08 01:28 AM
Strings updated!

martignoni committed 1 file to 'Lang CVS' - 27/Feb/08 04:55 AM
MDL-13663: strings enhanced for grade documentation
MODIFY fr_utf8/grades.php   Rev. 1.156    (+11 -11 lines)
martignoni committed 1 file to 'Lang CVS' - 27/Feb/08 05:06 AM
MDL-13663: more strings modification for better grades documentation
MODIFY fr_utf8/grades.php   Rev. 1.158    (+4 -4 lines)
Helen Foster added a comment - 28/Feb/08 01:02 AM
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?


Nicolas Connault committed 1 file to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 28/Feb/08 04:04 AM
MDL-13663 Docs updated.
MODIFY lang/en_utf8/grades.php   Rev. 1.111.2.45    (+7 -7 lines)
Nicolas Connault committed 1 file to 'Moodle CVS' - 28/Feb/08 04:04 AM
MDL-13663 Docs updated. Merging from MOODLE_19_STABLE
MODIFY lang/en_utf8/grades.php   Rev. 1.155    (+7 -7 lines)
Nicolas Connault added a comment - 28/Feb/08 04:04 AM
All done

martignoni committed 1 file to 'Lang CVS' - 28/Feb/08 04:55 AM
MDL-13663 Docs updated.
MODIFY fr_utf8/grades.php   Rev. 1.163    (+6 -6 lines)
Helen Foster made changes - 28/Feb/08 06:31 PM
Link This issue has been marked as being related by MDL-13709 [ MDL-13709 ]
Martin Dougiamas added a comment - 29/Feb/08 11:10 PM
Grade to pass - If an item has a grade that users must equal or exceed to pass that item, you can set that here.

Nicolas Connault committed 1 file to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 01/Mar/08 07:17 AM
MDL-13663 Last lang string change.
MODIFY lang/en_utf8/grades.php   Rev. 1.111.2.49    (+2 -2 lines)
Nicolas Connault committed 1 file to 'Moodle CVS' - 01/Mar/08 07:18 AM
MDL-13663 Last lang string change. Merging from MOODLE_19_STABLE
MODIFY lang/en_utf8/grades.php   Rev. 1.159    (+2 -2 lines)
Martin Dougiamas added a comment - 01/Mar/08 09:06 AM
I'm guessing this can be closed?

Martin Dougiamas made changes - 01/Mar/08 09:06 AM
Resolution Fixed [ 1 ]
Status Open [ 1 ] Resolved [ 5 ]
Helen Foster added a comment - 01/Mar/08 04:59 PM
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 \

Helen Foster made changes - 01/Mar/08 04:59 PM
Status Resolved [ 5 ] Reopened [ 4 ]
Resolution Fixed [ 1 ]
Mitsuhiro Yoshida committed 1 file to 'Lang CVS' - 01/Mar/08 05:58 PM
Updated translated strings for grade based on lang/en_utf8 change MDL-13663.
MODIFY ja_utf8/grades.php   Rev. 1.127    (+17 -17 lines)
Mitsuhiro Yoshida committed 1 file to 'Lang CVS' - 01/Mar/08 06:31 PM
Updated translated strings for grade based on lang/en_utf8 change MDL-13663.
MODIFY ja_utf8/grades.php   Rev. 1.128    (+6 -6 lines)
Nicolas Connault added a comment - 02/Mar/08 01:08 AM
quickfeedback help is not missing, I just forgot to rename it when I renamed quickfeedback to showquickfeedback.

Nicolas Connault committed 1 file to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 02/Mar/08 01:56 AM
MDL-13663 More lang string updates.
MODIFY lang/en_utf8/grades.php   Rev. 1.111.2.50    (+4 -4 lines)
Nicolas Connault committed 1 file to 'Moodle CVS' - 02/Mar/08 01:57 AM
MDL-13663 More lang string updates. Merging from MOODLE_19_STABLE
MODIFY lang/en_utf8/grades.php   Rev. 1.160    (+4 -4 lines)
Mitsuhiro Yoshida committed 3 files to 'Lang CVS' - 02/Mar/08 03:10 PM
Updated translated strings for grade based on lang/en_utf8 change MDL-13663.
Updated a translated help file for ID number.
MODIFY ja_utf8/grades.php   Rev. 1.129    (+7 -7 lines)
MODIFY ja_utf8/README   Rev. 1.652    (+1 -1 lines)
MODIFY ja_utf8/help/cmidnumber.html   Rev. 1.2    (+1 -1 lines)
Mitsuhiro Yoshida committed 2 files to 'Lang CVS' - 02/Mar/08 03:59 PM
Translated new strings for auth MDL-13564.
Updated translated strings for grade based on lang/en_utf8 change MDL-13663.
MODIFY ja_utf8/grades.php   Rev. 1.130    (+11 -8 lines)
MODIFY ja_utf8/auth.php   Rev. 1.61    (+6 -2 lines)
martignoni committed 1 file to 'Lang CVS' - 02/Mar/08 09:05 PM
MDL-13663: new string added
MODIFY fr_utf8/grades.php   Rev. 1.166    (+1 -1 lines)
martignoni committed 1 file to 'Lang CVS' - 02/Mar/08 09:09 PM
MDL-13663: More string tweaks
MODIFY fr_utf8/grades.php   Rev. 1.167    (+3 -3 lines)
Martin Dougiamas added a comment - 03/Mar/08 03:01 PM
I'm not sure exactly where this is. Who is doing what and what is left?

Nicolas Connault added a comment - 03/Mar/08 03:07 PM
I am finishing this off Martin. Should be in CVS shortly.

Martin Dougiamas added a comment - 03/Mar/08 03:35 PM
OK, thanks, let me know ASAP so I can take a look before release

Nicolas Connault added a comment - 03/Mar/08 03:39 PM
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.

Martin Dougiamas added a comment - 03/Mar/08 03:59 PM
[[configquickfeedback]] is a missing string currently

Martin Dougiamas made changes - 03/Mar/08 04:13 PM
Fix Version/s 1.9 [ 10190 ]
Fix Version/s 1.9.1 [ 10240 ]
Nicolas Connault committed 1 file to 'Moodle CVS' on branch 'MOODLE_19_STABLE' - 03/Mar/08 04:27 PM
MDL-13663 Updated the link to configshowquickfeedback
MODIFY grade/report/grader/settings.php   Rev. 1.34.2.6    (+2 -2 lines)
Nicolas Connault committed 1 file to 'Moodle CVS' - 03/Mar/08 04:28 PM
MDL-13663 Updated the link to configshowquickfeedback. Merging from MOODLE_19_STABLE
MODIFY grade/report/grader/settings.php   Rev. 1.40    (+2 -2 lines)
Nicolas Connault added a comment - 03/Mar/08 04:28 PM
fixed

Helen Foster added a comment - 03/Mar/08 05:18 PM
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.


Helen Foster added a comment - 03/Mar/08 08:48 PM
Gradebook help file improvements squeezed into Moodle 1.9, thanks to Nicolas' great work!

Helen Foster made changes - 03/Mar/08 08:48 PM
Status Reopened [ 4 ] Resolved [ 5 ]
Resolution Fixed [ 1 ]
Fix Version/s 1.9 [ 10190 ]
Fix Version/s 1.9.1 [ 10240 ]
Helen Foster made changes - 06/Mar/08 11:42 PM
Link This issue duplicates MDL-13789 [ MDL-13789 ]
Helen Foster added a comment - 06/Mar/08 11:42 PM
It seems that further gradebook help file improvements are required. Rather than reopening this issue, let's use MDL-13789 from now on.