MDL-10724 Finished help strings and files (4 new) for item edit form

diff --git a/grade/edit/tree/item_form.php b/grade/edit/tree/item_form.php
index 7243ab34c254f32ab96b5d82340f8ab7333409a5..a4cfde4730cd574211db47359cf9eef54c162ef6 100644 (file)
--- a/grade/edit/tree/item_form.php
+++ b/grade/edit/tree/item_form.php
@@ -13,10 +13,12 @@ class edit_item_form extends moodleform {
 
         $mform->addElement('text', 'itemname', get_string('itemname', 'grades'));
         $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades'));
-        $mform->setHelpButton('iteminfo', array(false, get_string('iteminfo', 'grades'), false, true, false, 'iteminfohelp'));
+        $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', 'grades'), false, true, false, 'idnumberhelp'));
+        $mform->setHelpButton('idnumber', array(false, get_string('idnumber'),
+                false, true, false, get_string('idnumberhelp', 'grades')));
 
         $options = array(GRADE_TYPE_NONE=>get_string('typenone', 'grades'),
                          GRADE_TYPE_VALUE=>get_string('typevalue', 'grades'),
@@ -24,7 +26,8 @@ class edit_item_form extends moodleform {
                          GRADE_TYPE_TEXT=>get_string('typetext', 'grades'));
 
         $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), $options);
-        $mform->setHelpButton('gradetype', array(false, get_string('gradetype', 'grades'), false, true, false, 'gradetypehelp'));
+        $mform->setHelpButton('gradetype', array(false, get_string('gradetype', 'grades'),
+                false, true, false, get_string('gradetypehelp', 'grades')));
         $mform->setDefault('gradetype', GRADE_TYPE_VALUE);
 
         //$mform->addElement('text', 'calculation', get_string('calculation', 'grades'));
@@ -38,53 +41,62 @@ class edit_item_form extends moodleform {
             }
         }
         $mform->addElement('select', 'scaleid', get_string('scale'), $options);
-        $mform->setHelpButton('scaleid', array(false, get_string('scaleid', 'grades'), false, true, false, 'scaleidhelp'));
+        $mform->setHelpButton('scaleid', array(false, get_string('scaleid', 'grades'),
+                false, true, false, get_string('scaleidhelp', 'grades')));
         $mform->disabledIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE);
 
         $mform->addElement('text', 'grademax', get_string('grademax', 'grades'));
-        $mform->setHelpButton('grademax', array(false, get_string('grademax', 'grades'), false, true, false, 'grademaxhelp'));
+        $mform->setHelpButton('grademax', array(false, get_string('grademax', 'grades'),
+                false, true, false, get_string('grademaxhelp', 'grades')));
         $mform->disabledIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
         $mform->setDefault('grademax', 100.0);
 
         $mform->addElement('text', 'grademin', get_string('grademin', 'grades'));
-        $mform->setHelpButton('grademin', array(false, get_string('grademin', 'grades'), false, true, false, 'grademinhelp'));
+        $mform->setHelpButton('grademin', array(false, get_string('grademin', 'grades'),
+                false, true, false, get_string('grademinhelp', 'grades')));
         $mform->disabledIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
         $mform->setDefault('grademin', 0.0);
 
         $mform->addElement('text', 'gradepass', get_string('gradepass', 'grades'));
-        $mform->setHelpButton('gradepass', array(false, get_string('gradepass', 'grades'), false, true, false, 'gradepasshelp'));
+        $mform->setHelpButton('gradepass', array(false, get_string('gradepass', 'grades'),
+                false, true, false, get_string('gradepasshelp', 'grades')));
         $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_NONE);
         $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_TEXT);
         $mform->setDefault('gradepass', 0.0);
 
         $mform->addElement('text', 'multfactor', get_string('multfactor', 'grades'));
-        $mform->setHelpButton('multfactor', array(false, get_string('multfactor', 'grades'), false, true, false, 'multfactorhelp'));
+        $mform->setHelpButton('multfactor', array(false, get_string('multfactor', 'grades'),
+                false, true, false, get_string('multfactorhelp', 'grades')));
         $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
         $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
         $mform->setDefault('multfactor', 1.0);
 
         $mform->addElement('text', 'plusfactor', get_string('plusfactor', 'grades'));
-        $mform->setHelpButton('plusfactor', array(false, get_string('plusfactor', 'grades'), false, true, false, 'plusfactorhelp'));
+        $mform->setHelpButton('plusfactor', array(false, get_string('plusfactor', 'grades'),
+                false, true, false, get_string('plusfactorhelp', 'grades')));
         $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
         $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
         $mform->setDefault('plusfactor', 0.0);
 
         $mform->addElement('text', 'aggregationcoef', get_string('aggregationcoef', 'grades'));
-        $mform->setHelpButton('aggregationcoef', array(false, get_string('aggregationcoef', 'grades'), false, true, false, 'aggregationcoefhelp'));
+        $mform->setHelpButton('aggregationcoef', array(false, get_string('aggregationcoef', 'grades'),
+                false, true, false, get_string('aggregationcoefhelp', 'grades')));
         $mform->setDefault('aggregationcoef', 0.0);
 
         /// 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(false, get_string('locked', 'grades'), false, true, false, 'lockedhelp'));
+        $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(false, get_string('locktime', 'grades'), false, true, false, 'locktimehelp'));
+        $mform->setHelpButton('locktime', array('locktime', get_string('locktime', 'grades'), 'grade'));
         $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
 
         // user preferences

diff --git a/lang/en_utf8/grades.php b/lang/en_utf8/grades.php
index 01a5d3e4c9d7e7b3ab97a22c97b79c3d4a13e01f..51f0ac3524415c171e58bd66e3570bc2660a8d56 100644 (file)
--- a/lang/en_utf8/grades.php
+++ b/lang/en_utf8/grades.php
@@ -25,6 +25,9 @@ $string['aggregateoutcomes'] = 'Include outcomes in aggregation';
 $string['aggregateweightedmeanall'] = 'Weighted mean of all grades';
 $string['aggregateweightedmeangraded'] = 'Weighted mean of non-empty grades';
 $string['aggregation'] = 'Aggregation';
+$string['aggregationcoef'] = 'Aggregation coefficient';
+$string['aggregationcoefhelp'] = 'Weight applied to all grades in this grade item during aggregation with other grade items.';
+$string['aggregation'] = 'Aggregation';
 $string['aggregationposition'] = 'Aggregation position';
 $string['aggregationview'] = 'Aggregation view';
 $string['allgrades'] = 'All grades by category';
@@ -152,21 +155,23 @@ $string['gradeletter'] = 'Grade Letter';
 $string['gradeletterhelp'] = 'Grade Letter Help';
 $string['gradeletternote'] = 'To delete a grade letter just empty any of the<br /> three text areas for that letter and click submit.';
 $string['grademax'] = 'Maximum grade';
+$string['grademaxhelp'] = 'The maximum allowable grade for this grade item.';
 $string['grademin'] = 'Minimum grade';
+$string['grademinhelp'] = 'The minimum allowable grade for this grade item.';
 $string['gradeoutcomeitem'] = 'Grade outcome item';
 $string['gradepass'] = 'Grade to pass';
+$string['gradepasshelp'] = 'What grade is needed to pass?';
 $string['graderreport'] = 'Grader report';
 $string['gradessettings'] = 'Grade settings';
-$string['groupavg'] = 'Group average';
-$string['hidden'] = 'Hidden';
-$string['importplugins'] = 'Import plugins';
-$string['itemsedit'] = 'Edit grade item';
 $string['gradepreferences'] = 'Grade Preferences';
 $string['gradepreferenceshelp'] = 'Grade Preferences Help';
 $string['grades'] = 'Grades';
 $string['gradetype'] = 'Grade type';
+$string['gradetypehelp'] = 'The type of grade this item uses. Can be of 4 types: none, value, scale and text. Only The value and scale types can be aggregated.';
 $string['gradeview'] = 'View Grade';
 $string['gradeweighthelp'] = 'Grade Weight Help';
+$string['groupavg'] = 'Group average';
+$string['hidden'] = 'Hidden';
 $string['hiddenuntil'] = 'Hidden until';
 $string['hideadvanced'] = 'Hide Advanced Features';
 $string['hidecalculations'] = 'Hide calculations';
@@ -180,11 +185,13 @@ $string['hideranges'] = 'Hide ranges';
 $string['highgradeascending'] = 'Sort by high grade ascending';
 $string['highgradedescending'] = 'Sort by high grade descending';
 $string['highgradeletter'] = 'High';
+$string['idnumberhelp'] = 'Arbitrary idnumber provided by the module responsible (must be defined and unique).';
 $string['identifier'] = 'Identify user by';
 $string['import'] = 'Import';
 $string['importcsv'] = 'Import CSV';
 $string['importfailed'] = 'Import failed';
 $string['importfile'] = 'Import file';
+$string['importplugins'] = 'Import plugins';
 $string['importpreview'] = 'Import preview';
 $string['importsuccess'] = 'Grade import success';
 $string['importxml'] = 'Import XML';
@@ -192,8 +199,11 @@ $string['incorrectcourseid'] = 'Course ID was incorrect';
 $string['inherit'] = 'Inherit';
 $string['item'] = 'Item';
 $string['iteminfo'] = 'Item info';
+$string['iteminfohelp'] = 'Info and notes about this item.';
 $string['itemname'] = 'Item name';
+$string['itemnamehelp'] = 'The name of this item, pushed in by the module.';
 $string['items'] = 'Items';
+$string['itemsedit'] = 'Edit grade item';
 $string['keephigh'] = 'Keep the highest';
 $string['left'] = 'Left';
 $string['lettergrade'] = 'Letter Grade';
@@ -219,6 +229,7 @@ $string['min'] = 'Lowest';
 $string['mode'] = 'Mode';
 $string['movingelement'] = 'Moving $a';
 $string['multfactor'] = 'Multiplicator';
+$string['multfactorhelp'] = 'Factor by which all grades for this grade item will be multiplied.';
 $string['newcategory'] = 'New category';
 $string['no'] = 'No';
 $string['nocategories'] = 'Grade categories could not be added or found for this course';
@@ -263,6 +274,7 @@ $string['percentascending'] = 'Sort by percent ascending';
 $string['percentdescending'] = 'Sort by percent descending';
 $string['percentshort'] = '%%';
 $string['plusfactor'] = 'Offset';
+$string['plusfactorhelp'] = 'Number that will be added to every grade for this grade item, after the Multiplicator is applied.';
 $string['points'] = 'points';
 $string['pointsascending'] = 'Sort by points ascending';
 $string['pointsdescending'] = 'Sort by points descdending';
@@ -287,6 +299,7 @@ $string['right'] = 'Right';
 $string['savechanges'] = 'Save Changes';
 $string['savepreferences'] = 'Save Preferences';
 $string['scaledpct'] = 'Scaled %%';
+$string['scaleidhelp'] = 'The scale upon which this grade item is based.';
 $string['selectdestination'] = 'Select destination of $a';
 $string['septab'] = 'Tab';
 $string['sepcomma'] = 'Comma';

diff --git a/lang/en_utf8/help/grade/hidden.html b/lang/en_utf8/help/grade/hidden.html
new file mode 100644 (file)
index 0000000..f140093
--- /dev/null
+++ b/lang/en_utf8/help/grade/hidden.html
@@ -0,0 +1,23 @@
+<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>
+<table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
+    <tr>
+        <th class="header">Event</th><th class="header">Locked</th><th class="header">Hidden</th>
+    </tr>
+    <tr>
+        <td class="cell">Start of activity and participant submissions</td>
+        <td class="cell">No</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of activity and beginning of grading/feedback</td>
+        <td class="cell">Yes</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of grading/feedback, and release of grades</td>
+        <td class="cell">Yes</td>
+        <td class="cell">No</td>
+    </tr>
+</table>

diff --git a/lang/en_utf8/help/grade/hiddenuntil.html b/lang/en_utf8/help/grade/hiddenuntil.html
new file mode 100644 (file)
index 0000000..335adf4
--- /dev/null
+++ b/lang/en_utf8/help/grade/hiddenuntil.html
@@ -0,0 +1,23 @@
+<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>
+<table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
+    <tr>
+        <th class="header">Event</th><th class="header">Locked</th><th class="header">Hidden</th>
+    </tr>
+    <tr>
+        <td class="cell">Start of activity and participant submissions</td>
+        <td class="cell">No</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of activity and beginning of grading/feedback</td>
+        <td class="cell">Yes</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of grading/feedback, and release of grades</td>
+        <td class="cell">Yes</td>
+        <td class="cell">No</td>
+    </tr>
+</table>

diff --git a/lang/en_utf8/help/grade/locked.html b/lang/en_utf8/help/grade/locked.html
new file mode 100644 (file)
index 0000000..427f4e1
--- /dev/null
+++ b/lang/en_utf8/help/grade/locked.html
@@ -0,0 +1,23 @@
+<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:
+</p>
+<table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
+    <tr>
+        <th class="header">Event</th><th class="header">Locked</th><th class="header">Hidden</th>
+    </tr>
+    <tr>
+        <td class="cell">Start of activity and participant submissions</td>
+        <td class="cell">No</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of activity and beginning of grading/feedback</td>
+        <td class="cell">Yes</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of grading/feedback, and release of grades</td>
+        <td class="cell">Yes</td>
+        <td class="cell">No</td>
+    </tr>
+</table>

diff --git a/lang/en_utf8/help/grade/lockeduntil.html b/lang/en_utf8/help/grade/lockeduntil.html
new file mode 100644 (file)
index 0000000..57b13b0
--- /dev/null
+++ b/lang/en_utf8/help/grade/lockeduntil.html
@@ -0,0 +1,23 @@
+<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>
+<table class="generaltable boxaligncenter" cellpadding="4" cellspacing="1" summary="Principal events in the grading process, and matching locked and hidden states">
+    <tr>
+        <th class="header">Event</th><th class="header">Locked</th><th class="header">Hidden</th>
+    </tr>
+    <tr>
+        <td class="cell">Start of activity and participant submissions</td>
+        <td class="cell">No</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of activity and beginning of grading/feedback</td>
+        <td class="cell">Yes</td>
+        <td class="cell">Yes</td>
+    </tr>
+    <tr>
+        <td class="cell">End of grading/feedback, and release of grades</td>
+        <td class="cell">Yes</td>
+        <td class="cell">No</td>
+    </tr>
+</table>