MDL-10724 Finished help strings for grade and outcome item edit forms

diff --git a/grade/edit/tree/grade_form.php b/grade/edit/tree/grade_form.php
index 1e2894ac48256b3c3a94a0d149c0431ed121b254..40c679517c18857b067050e1792b912517486e7f 100755 (executable)
--- a/grade/edit/tree/grade_form.php
+++ b/grade/edit/tree/grade_form.php
@@ -20,15 +20,17 @@ class edit_grade_form extends moodleform {
         if ($grade_item->gradetype == GRADE_TYPE_VALUE) {
             // numeric grade
             $mform->addElement('text', 'finalgrade', get_string('finalgrade', 'grades'));
+            $mform->setHelpButton('finalgrade', array(false, get_string('finalgrade', 'grades'),
+                    false, true, false, get_string('finalgradehelp', 'grades')));
 
         } else if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
             // scale grade
             $scaleopt = array();
 
             if (empty($grade_item->outcomeid)) {
-                $scaleopt[-1] = get_string('nograde'); 
+                $scaleopt[-1] = get_string('nograde');
             } else {
-                $scaleopt[-1] = get_string('nooutcome', 'grades'); 
+                $scaleopt[-1] = get_string('nooutcome', 'grades');
             }
 
             $i = 1;
@@ -40,25 +42,37 @@ class edit_grade_form extends moodleform {
             }
 
             $mform->addElement('select', 'finalgrade', get_string('finalgrade', 'grades'), $scaleopt);
+            $mform->setHelpButton('finalgrade', array(false, get_string('finalgrade', 'grades'),
+                    false, true, false, get_string('finalgradehelp', 'grades')));
         }
 
         $mform->addElement('advcheckbox', 'overridden', get_string('overridden', 'grades'));
+        $mform->setHelpButton('overridden', array(false, get_string('overridden', 'grades'),
+                false, true, false, get_string('overriddenhelp', 'grades')));
         $mform->addElement('advcheckbox', 'excluded', get_string('excluded', 'grades'));
+        $mform->setHelpButton('excluded', array(false, get_string('excluded', 'grades'),
+                false, true, false, get_string('excludedhelp', 'grades')));
 
         /// hiding
         /// advcheckbox is not compatible with disabledIf !!
         $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
+        $mform->setHelpButton('hidden', array('hidden', get_string('hidden', 'grades'), 'grade'));
         $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
+        $mform->setHelpButton('hiddenuntil', array('hiddenuntil', get_string('hiddenuntil', 'grades'), 'grade'));
         $mform->disabledIf('hiddenuntil', 'hidden', 'checked');
 
         /// locking
         $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
+        $mform->setHelpButton('locked', array('locked', get_string('locked', 'grades'), 'grade'));
         $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
+        $mform->setHelpButton('locktime', array('locktime', get_string('locktime', 'grades'), 'grade'));
         $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
 
         // Feedback format is automatically converted to html if user has enabled editor
         $mform->addElement('htmleditor', 'feedback', get_string('feedback', 'grades'),
             array('rows'=>'15', 'course'=>$COURSE->id, 'cols'=>'45'));
+        $mform->setHelpButton('feedback', array(false, get_string('feedback', 'grades'),
+                false, true, false, get_string('feedbackhelp', 'grades')));
         $mform->setType('text', PARAM_RAW); // to be cleaned before display, no XSS risk
         $mform->addElement('format', 'feedbackformat', get_string('format'));
         $mform->setHelpButton('feedbackformat', array('textformat', get_string('helpformatting')));
@@ -139,4 +153,4 @@ class edit_grade_form extends moodleform {
     }
 }
 
-?>
\ No newline at end of file
+?>

diff --git a/grade/edit/tree/outcomeitem_form.php b/grade/edit/tree/outcomeitem_form.php
index a5d575fbac5412d4ae3a3609bf3578162fd3a71d..2d63253a0b221de0d0816eb17caee3b8227d1bf2 100644 (file)
--- a/grade/edit/tree/outcomeitem_form.php
+++ b/grade/edit/tree/outcomeitem_form.php
@@ -15,8 +15,12 @@ class edit_outcomeitem_form extends moodleform {
         $mform->addRule('itemname', get_string('required'), 'required', null, 'client');
 
         $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades'));
+        $mform->setHelpButton('iteminfo', array(false, get_string('iteminfo', 'grades'),
+                false, true, false, get_string('iteminfohelp', 'grades')));
 
         $mform->addElement('text', 'idnumber', get_string('idnumber'));
+        $mform->setHelpButton('idnumber', array(false, get_string('idnumber'),
+                false, true, false, get_string('idnumberhelp', 'grades')));
 
         // allow setting of outcomes on module items too
         $options = array();
@@ -26,6 +30,8 @@ class edit_outcomeitem_form extends moodleform {
             }
         }
         $mform->addElement('select', 'outcomeid', get_string('outcome', 'grades'), $options);
+        $mform->setHelpButton('outcomeid', array(false, get_string('outcomeid', 'grades'),
+                false, true, false, get_string('outcomeidhelp', 'grades')));
         $mform->addRule('outcomeid', get_string('required'), 'required');
 
         $options = array(0=>get_string('none'));
@@ -36,6 +42,8 @@ class edit_outcomeitem_form extends moodleform {
             }
         }
         $mform->addElement('select', 'cmid', get_string('linkedactivity', 'grades'), $options);
+        $mform->setHelpButton('cmid', array(false, get_string('linkedactivity', 'grades'),
+                false, true, false, get_string('linkedactivityhelp', 'grades')));
         $mform->setDefault('cmid', 0);
 
         //$mform->addElement('text', 'calculation', get_string('calculation', 'grades'));
@@ -46,12 +54,16 @@ class edit_outcomeitem_form extends moodleform {
         /// hiding
         /// advcheckbox is not compatible with disabledIf !!
         $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
+        $mform->setHelpButton('hidden', array('hidden', get_string('hidden', 'grades'), 'grade'));
         $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
+        $mform->setHelpButton('hiddenuntil', array('hiddenuntil', get_string('hiddenuntil', 'grades'), 'grade'));
         $mform->disabledIf('hiddenuntil', 'hidden', 'checked');
 
         //locking
         $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
+        $mform->setHelpButton('locked', array('locked', get_string('locked', 'grades'), 'grade'));
         $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
+        $mform->setHelpButton('locktime', array('locktime', get_string('locktime', 'grades'), 'grade'));
 
 /// hidden params
         $mform->addElement('hidden', 'id', 0);

diff --git a/lang/en_utf8/grades.php b/lang/en_utf8/grades.php
index 43c149793e0c75aae49a901443407359c99d449c..0497ecb9d695a000dab6d1023b36babdb00dbf24 100644 (file)
--- a/lang/en_utf8/grades.php
+++ b/lang/en_utf8/grades.php
@@ -121,17 +121,20 @@ $string['errornocourse'] = 'Could not get course information';
 $string['errorreprintheadersnonnumeric'] = 'Received non-numeric value for reprint-headers';
 $string['exceptions'] = 'Exceptions';
 $string['excluded'] = 'Excluded';
+$string['excludedhelp'] = 'If -excluded- is switched on, this grade will be excluded from any aggregation performed by any parent grade item or category.';
 $string['expand'] = 'Expand Category';
 $string['export'] = 'Export';
 $string['exportplugins'] = 'Export plugins';
 $string['extracredit'] = 'Extra Credit';
 $string['extracreditwarning'] = 'Note: Setting all items for a category to extra credit will effectively remove them from the grade calculation. Since there will be no point total';
 $string['feedback'] = 'Feedback';
+$string['feedbackhelp'] = 'Notes added to the grade by the teacher. They can be extensive, personalised feedback or a simple code that refers to an internal system of feedback.';
 $string['feedbackadd'] = 'Add feedback';
 $string['feedbackedit'] = 'Edit feedback';
 $string['feedbackview'] = 'View feedback';
 $string['feedbacksaved'] = 'Feedback saved';
 $string['finalgrade'] = 'Final grade';
+$string['finalgradehelp'] = 'The final grade (cached) after all calculations are performed.';
 $string['forelementtypes'] = ' for the selected $a';
 $string['forstudents'] = 'For Students';
 $string['full'] = 'Full';
@@ -214,6 +217,7 @@ $string['lettergradenonnumber'] = 'Low and/or High grade were non-numeric for';
 $string['letter'] = 'Letter';
 $string['letters'] = 'Letters';
 $string['linkedactivity'] = 'Linked activity';
+$string['linkedactivityhelp'] = 'An optional activity this outcome item is linked to.';
 $string['lock'] = 'Lock';
 $string['locked'] = 'Locked';
 $string['locktime'] = 'Locked until';
@@ -253,6 +257,7 @@ $string['onascaleof'] = ' on a scale of $a->grademin to $a->grademax';
 $string['operations'] = 'Operations';
 $string['outcome'] = 'Outcome';
 $string['outcomecreate'] = 'Add a new outcome';
+$string['outcomeidhelp'] = 'The outcome this grade item represents.';
 $string['outcomeitem'] = 'Outcome item';
 $string['outcomeitemsedit'] = 'Edit outcome item';
 $string['outcomes'] = 'Outcomes';
@@ -269,6 +274,7 @@ $string['outcomesstandardavailable'] = 'Available standard outcomes';
 $string['outcomestandard'] = 'Standard outcome';
 $string['outcomes'] = 'Outcomes';
 $string['overridden'] = 'Overridden';
+$string['overriddenhelp'] = 'When on, the overridden flag prevents any future attempts to automatically adjust the value of the grade. This flag is often set internally by the gradebook, but can be switched on and off manually using this form element.';
 $string['overallavg'] = 'Overall average';
 $string['pctoftotalgrade'] = '%% of total grade';
 $string['percent'] = 'Percent';

diff --git a/lang/en_utf8/help/grade/hidden.html b/lang/en_utf8/help/grade/hidden.html
index f14009378bdb0a6b49dd319b9cc8a0a27d51a2b4..50d16b03074e71068e95242ec64daa9c12b54c48 100644 (file)
--- a/lang/en_utf8/help/grade/hidden.html
+++ b/lang/en_utf8/help/grade/hidden.html
@@ -1,5 +1,5 @@
 <h1>Hidden</h1>
-<p>Whether or not the grades in this grade item are <strong>hidden</strong> to all participants. Usually after the end of the activity and of the grading process.. A typical sequence of events would be:
+<p>Whether or not the grades are <strong>hidden</strong> to participants. Usually after the end of the activity and of the grading process.. A typical sequence of events would be:
 </p>
 <table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
     <tr>

diff --git a/lang/en_utf8/help/grade/hiddenuntil.html b/lang/en_utf8/help/grade/hiddenuntil.html
index 335adf463ac1914b4d541c6891b8dfaa533d5bd4..e7a3609e33e9a2d814bd80424960b2fcd351fbc2 100644 (file)
--- a/lang/en_utf8/help/grade/hiddenuntil.html
+++ b/lang/en_utf8/help/grade/hiddenuntil.html
@@ -1,5 +1,5 @@
 <h1>Hidden until</h1>
-<p>Date until which the grades in this grade item will be <strong>hidden</strong> to all participants. Usually after the end of the activity and of the grading process.. A typical sequence of events would be:
+<p>Date until which the grades will be <strong>hidden</strong> to participants. Usually after the end of the activity and of the grading process.. A typical sequence of events would be:
 </p>
 <table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
     <tr>

diff --git a/lang/en_utf8/help/grade/locked.html b/lang/en_utf8/help/grade/locked.html
index 427f4e1c96677712f2a0055ac897b7ea81e811c3..0014d11f41fc6f2c41cbec29b65498bbf1d4be91 100644 (file)
--- a/lang/en_utf8/help/grade/locked.html
+++ b/lang/en_utf8/help/grade/locked.html
@@ -1,5 +1,5 @@
-<h1>Grade item Locked attribute</h1>
-<p>Whether or not this grade item accepts automatic updates from the activity it is linked to. Usually this is switched on (locked) as soon as the activity is finished and submissions are no longer accepted. A typical sequence of events would be:
+<h1>Locked</h1>
+<p>Whether or not the grades accept automatic updates from the activity they are linked to. Usually this is switched on (locked) as soon as the activity is finished and submissions are no longer accepted. A typical sequence of events would be:
 </p>
 <table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
     <tr>

diff --git a/lang/en_utf8/help/grade/lockeduntil.html b/lang/en_utf8/help/grade/lockeduntil.html
index 57b13b09f9febc16f1cf8260cd816ff4cc9a96a3..52f359a9aade199b3954f43138fe1a49b34c5fe0 100644 (file)
--- a/lang/en_utf8/help/grade/lockeduntil.html
+++ b/lang/en_utf8/help/grade/lockeduntil.html
@@ -1,5 +1,5 @@
 <h1>Locked until</h1>
-<p>Date <strong>after</strong> which the grades in this grade item will be <strong>locked</strong>. Usually this date is set to the end of the activity, and the beginning of the grading process.. A typical sequence of events would be:
+<p>Date <strong>after</strong> which the grades will be <strong>locked</strong>. Usually this date is set to the end of the activity, and the beginning of the grading process.. A typical sequence of events would be:
 </p>
 <table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
     <tr>