Extension:OpenBadges
 Release status: stable |
|
|---|---|
 |
|
| Implementation | MyWiki, API |
| Description | Allow the wiki to become an OpenBadges issuer |
| Author(s) | |
| Maintainer(s) | Tom Fellows |
| Latest version | 0.3.0 (2018-12-19) |
| MediaWiki | 1.25+ |
| Database changes | Yes |
| Tables | openbadges_class openbadges_assertion |
| License | GNU General Public License 2.0 or later |
| Download | |
|
|
|
|
|
|
| Quarterly downloads | 3 (Ranked 174th) |
| Translate the OpenBadges extension if it is available at translatewiki.net | |
| Vagrant role | openbadges |
| Issues | Open tasks · Report a bug |
The OpenBadges extension allows for Open Badges to be issued through MediaWiki.
- A badge can be created on the wiki, by anyone with the
createbadgeright, using a png or svg image as an illustration throughSpecial:BadgeCreate. - A badge can be awarded, by anyone with the
issuebadgeright, to other users on the wiki which fulfil the e-mail requirements, either throughSpecial:BadgeIssueorapi.php?action=openbadgesissue. - Any user can view their awarded badges through
Special:BadgeView. - Anyone can use
api.php?action=openbadgesto access a hosted assertion (that is, an awarded badge), in accordance with the Open Badges specification: 1.1, if the recipient user on the wiki still fulfills the e-mail requirements.
InstallationEdit
- Download and place the file(s) in a directory called
OpenBadgesin yourextensions/folder. - Add the following code at the bottom of your
LocalSettings.php:wfLoadExtension( 'OpenBadges' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure as required
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.31 or earlier:
The instructions above describe the new way of installing this extension using wfLoadExtension().
If you need to install this extension on these earlier versions (MediaWiki 1.31 and earlier), instead of wfLoadExtension( 'OpenBadges' );, you need to use:
require_once "$IP/extensions/OpenBadges/OpenBadges.php";
ConfigurationEdit
- Require recipients to have set an e-mail address (enabled by default)
$wgOpenBadgesRequireEmail = true;
- Require recipients to have confirmed their e-mail address (disabled by default)
$wgOpenBadgesRequireEmailConfirmation = true;
- Set the width (in px) of png thumbnails for svg badge illustrations delivered in badge assertion (400 by default)
$wgOpenBadgesThumb = 400;