Open main menu

Extension:OpenBadges

MediaWiki extensions manual
OOjs UI icon advanced.svg
OpenBadges
Release status: unmaintained
Mozilla OpenBadges.png
Implementation MyWiki , API
Description Allow the wiki to become an OpenBadges issuer
Author(s) Tyler Romeo, André Costa
Latest version 0.2.0 (2017-08-18)
MediaWiki 1.23+
Database changes Yes
Tables openbadges_class
openbadges_assertion
License GNU General Public License 2.0 or later
Download
  • $wgOpenBadgesThumb
  • $wgOpenBadgesRequireEmail
  • $wgOpenBadgesRequireEmailConfirmation
  • createbadge
  • issuebadge
  • viewbadge
Translate the OpenBadges extension if it is available at translatewiki.net
Check usage and version matrix.
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 createbadge right, using a png or svg image as an illustration through Special:BadgeCreate.
  • A badge can be awarded, by anyone with the issuebadge right, to other users on the wiki which fulfil the e-mail requirements. Either through Special:BadgeIssue or api.php?action=openbadgesissue.
  • Any user can view their awarded badges through Special:BadgeView.
  • Anyone can use api.php?action=openbadges to access a hosted assertion an awarded badge, in accordence with the Open Badges specification: 1.1, if the recipient users on the wiki still fulfil the e-mail requirements.

InstallationEdit

  • Download and place the file(s) in a directory called OpenBadges in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/OpenBadges/OpenBadges.php";
    
  • 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.

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;

See alsoEdit