MDL-84577 badges: Reorganise badge creation form

Author: sarjona

badges/classes/form/badge.php

@@ -62,15 +62,14 @@ public function definition() {
 
         $mform->addElement('text', 'version', get_string('version', 'badges'), ['size' => '70']);
         $mform->setType('version', PARAM_TEXT);
-        $mform->addHelpButton('version', 'version', 'badges');
 
         $languages = get_string_manager()->get_list_of_languages();
         $mform->addElement('select', 'language', get_string('language'), $languages);
-        $mform->addHelpButton('language', 'language', 'badges');
 
         $mform->addElement('textarea', 'description', get_string('description', 'badges'), 'wrap="virtual" rows="8" cols="70"');
         $mform->setType('description', PARAM_NOTAGS);
         $mform->addRule('description', null, 'required');
+        $mform->addElement('static', 'descriptioninfo', null, get_string('descriptioninfo', 'badges'));
 
         $str = $action == 'new' ? get_string('badgeimage', 'badges') : get_string('newimage', 'badges');
         $imageoptions = ['maxbytes' => 262144, 'accepted_types' => ['optimised_image']];
@@ -82,10 +81,11 @@ public function definition() {
             $currentimage = $mform->createElement('static', 'currentimage', get_string('currentimage', 'badges'));
             $mform->insertElementBefore($currentimage, 'image');
         }
-        $mform->addHelpButton('image', 'badgeimage', 'badges');
+        $mform->addElement('static', 'imageinfo', null, get_string('badgeimageinfo', 'badges'));
+
         $mform->addElement('text', 'imagecaption', get_string('imagecaption', 'badges'), ['size' => '70']);
         $mform->setType('imagecaption', PARAM_TEXT);
-        $mform->addHelpButton('imagecaption', 'imagecaption', 'badges');
+
         $mform->addElement('tags', 'tags', get_string('tags', 'badges'), ['itemtype' => 'badge', 'component' => 'core_badges']);
 
         $mform->addElement('header', 'issuerdetails', get_string('issuerdetails', 'badges'));
@@ -96,15 +96,14 @@ public function definition() {
         $site = get_site();
         $issuername = $CFG->badges_defaultissuername ?: $site->fullname;
         $mform->setDefault('issuername', $issuername);
-        $mform->addHelpButton('issuername', 'issuername', 'badges');
 
         $mform->addElement('text', 'issuercontact', get_string('contact', 'badges'), ['size' => '70']);
         if (isset($CFG->badges_defaultissuercontact)) {
             $mform->setDefault('issuercontact', $CFG->badges_defaultissuercontact);
         }
         $mform->setType('issuercontact', PARAM_RAW);
         $mform->addRule('issuercontact', null, 'email');
-        $mform->addHelpButton('issuercontact', 'contact', 'badges');
+
         // Set issuer URL.
         // Have to parse URL because badge issuer origin cannot be a subfolder in wwwroot.
         $url = parse_url($CFG->wwwroot);
@@ -124,7 +123,6 @@ public function definition() {
         $issuancedetails[] = $mform->createElement('static', 'expiryperiods_break', null, get_string('after', 'badges'));
 
         $mform->addGroup($issuancedetails, 'expirydategr', get_string('expirydate', 'badges'), [' '], false);
-        $mform->addHelpButton('expirydategr', 'expirydate', 'badges');
         $mform->setDefault('expiry', 0);
         $mform->setDefault('expiredate', strtotime('+1 year'));
         $mform->disabledIf('expiredate[day]', 'expiry', 'neq', 1);

lang/en/badges.php

@@ -146,7 +146,7 @@
 $string['badges'] = 'Badges';
 $string['badgedetails'] = 'Badge details';
 $string['badgeimage'] = 'Image';
-$string['badgeimage_help'] = 'The image should be at least 300 x 300 pixels in size. It will be displayed as 300 x 300 pixels on the badge page and 100 x 100 pixels on the user\'s profile page.';
+$string['badgeimageinfo'] = 'For best results, upload a square image with a minimum size of 300 x 300 pixels.';
 $string['badgeissued'] = 'Badge issued';
 $string['badgeprivacysetting'] = 'Badge privacy settings';
 $string['badgeprivacysetting_help'] = 'Badges you earn can be displayed on your account profile page. This setting allows you to automatically set the visibility of the newly earned badges.
@@ -179,7 +179,6 @@
 $string['balignment'] = 'Alignments ({$a})';
 $string['bydate'] = ' complete by';
 $string['imagecaption'] = 'Image caption';
-$string['imagecaption_help'] = 'If specified, an image caption is displayed on the badge page.';
 $string['claim'] = 'Claim';
 $string['claimcomment'] = 'Endorsement comment';
 $string['claimid'] = 'Claim URL';
@@ -191,8 +190,7 @@
 $string['connect'] = 'Connect';
 $string['connected'] = 'Connected';
 $string['connecting'] = 'Connecting...';
-$string['contact'] = 'Issuer contact';
-$string['contact_help'] = 'An email address associated with the badge issuer.';
+$string['contact'] = 'Email';
 $string['copy'] = 'Copy';
 $string['copyof'] = 'Copy of {$a}';
 $string['course'] = 'Course: {$a}';
@@ -288,6 +286,7 @@
 $string['delcritconfirm'] = 'Are you sure that you want to delete this criterion?';
 $string['delparamconfirm'] = 'Are you sure that you want to delete this parameter?';
 $string['description'] = 'Description';
+$string['descriptioninfo'] = 'What does this badge represent?';
 $string['disconnect'] = 'Disconnect';
 $string['donotaward'] = 'Currently, this badge is not active, so it cannot be awarded to users. If you would like to award this badge, please set its status to active.';
 $string['enablebadges'] = 'Enable badges';
@@ -310,7 +309,6 @@
 $string['error:noactivities'] = 'There are no activities with completion criteria enabled in this course.';
 $string['error:nobadges'] = 'There are currently no badges with access enabled to be added as criteria. A site badge can only have other site badges as criteria. A course badge can have other course badges or site badges as criteria.';
 $string['error:invalidparamcohort'] = 'Cohort does not exist. ';
-$string['error:noactivities'] = 'There are no activities with completion criteria enabled in this course.';
 $string['error:nocohorts'] = 'No cohorts';
 $string['error:nocourses'] = 'Course completion is not enabled for any of the courses in this site, so none can be displayed. Course completion may be enabled in the course settings.';
 $string['error:nogroupssummary'] = '<p>There are no public collections of badges available in your backpack. </p>';
@@ -355,14 +353,13 @@
 $string['expireperiodm'] = 'This badge expires {$a} minute(s) after being issued.';
 $string['expireperiods'] = 'This badge expires {$a} second(s) after being issued.';
 $string['expirydate'] = 'Expiry date';
-$string['expirydate_help'] = 'Optionally, badges can expire on a specific date, or the date can be calculated based on the date when the badge was issued to a user. ';
 $string['existsinbackpack'] = 'Badge already exists in backpack';
 $string['externalconnectto'] = 'To display external badges you need to <a href="{$a}">connect to a backpack</a>.';
 $string['externalbackpack_required'] = 'Backpack provider can\'t be blank';
 $string['externalbadges'] = 'My badges from other web sites';
 $string['externalbadgesp'] = 'Badges from other web sites:';
 $string['externalbadges_help'] = 'This area displays badges from your external backpack.';
-$string['fixed'] = 'Fixed date';
+$string['fixed'] = 'Fixed date: this badge expires on the following date:';
 $string['hidden'] = 'Hidden';
 $string['hiddenbadge'] = 'Unfortunately, the badge owner has not made this information available.';
 $string['hostedurl'] = 'External URL';
@@ -375,14 +372,12 @@
 $string['issuerdetails'] = 'Issuer details';
 $string['issueremail'] = 'Email';
 $string['issueremail_help'] = 'A contact email address of the organisation issuing the endorsement.';
-$string['issuername'] = 'Issuer name';
-$string['issuername_help'] = 'Name of the issuing agent or authority.';
+$string['issuername'] = 'Name';
 $string['issuername_endorsement'] = 'Endorser name';
 $string['issuername_endorsement_help'] = 'The name of the endorser.';
-$string['issuerurl'] = 'Issuer URL';
+$string['issuerurl'] = 'URL';
 $string['issuerurl_help'] = 'The website of the organisation issuing the endorsement. The URL should have a prefix http:// or https://.';
 $string['language'] = 'Language';
-$string['language_help'] = 'The language used on the badge page.';
 $string['listbackpacks'] = 'List of backpacks';
 $string['localconnectto'] = 'To share these badges outside this web site you need to <a href="{$a}">connect to a backpack</a>.';
 $string['localbadges'] = 'My badges from {$a} web site';
@@ -410,7 +405,7 @@
 $string['mybadges'] = 'My badges';
 $string['mybackpack'] = 'My backpack settings';
 $string['namewithlink'] = 'Name with link';
-$string['never'] = 'Never';
+$string['never'] = 'Never: this badge does not expire.';
 $string['newbackpack'] = 'Add a new backpack';
 $string['newbadge'] = 'Add a new badge';
 $string['newbadgedeprecated'] = 'You have been redirected from badges/newbadge.php. Please note that badges/newbadge.php will be removed in the near future.
@@ -504,7 +499,7 @@
 $string['recipient'] = 'Badge recipient';
 $string['recipients'] = 'Badge recipients';
 $string['recipientvalidationproblem'] = 'This user cannot be verified as a recipient of this badge.';
-$string['relative'] = 'Relative date';
+$string['relative'] = 'Relative date: this badge expires after a period of time:';
 $string['relatedbages'] = 'Related badges';
 $string['revoke'] = 'Revoke badge';
 $string['requiredcohort'] = 'At least one cohort should be added to the cohort criterion.';
@@ -582,7 +577,6 @@
 $string['viewbadge'] = 'View issued badge';
 $string['visible'] = 'Visible';
 $string['version'] = 'Version';
-$string['version_help'] = 'The version field may be used to keep track of the badge\'s development. If specified, the version is displayed on the badge page.';
 $string['warnexpired'] = ' (This badge has expired!)';
 $string['year'] = 'Year(s)';
 $string['includeauthdetails'] = "Include authentication details with the backpack";
@@ -603,3 +597,10 @@
 $string['imageauthorname_help'] = 'If specified, the name of the badge image author is displayed on the badge page.';
 $string['imageauthorurl'] = 'Image author\'s URL';
 $string['imageauthorurl_help'] = 'If specified, a link to the badge image author\'s website is displayed on the badge page. The URL should have a prefix http:// or https://.';
+$string['version_help'] = 'The version field may be used to keep track of the badge\'s development. If specified, the version is displayed on the badge page.';
+$string['language_help'] = 'The language used on the badge page.';
+$string['badgeimage_help'] = 'The image should be at least 300 x 300 pixels in size. It will be displayed as 300 x 300 pixels on the badge page and 100 x 100 pixels on the user\'s profile page.';
+$string['imagecaption_help'] = 'If specified, an image caption is displayed on the badge page.';
+$string['issuername_help'] = 'Name of the issuing agent or authority.';
+$string['contact_help'] = 'An email address associated with the badge issuer.';
+$string['expirydate_help'] = 'Optionally, badges can expire on a specific date, or the date can be calculated based on the date when the badge was issued to a user. ';

lang/en/deprecated.txt

@@ -156,3 +156,10 @@ imageauthorname,core_badges
 imageauthorname_help,core_badges
 imageauthorurl,core_badges
 imageauthorurl_help,core_badges
+version_help,core_badges
+language_help,core_badges
+badgeimage_help,core_badges
+imagecaption_help,core_badges
+issuername_help,core_badges
+contact_help,core_badges
+expirydate_help,core_badges