Extension:OpenBadges

MediaWiki extensions manual

OpenBadges Release status: stable
Implementation	MyWiki , API
Description	Allow the wiki to become an OpenBadges issuer
Author(s)	Tyler Romeo André Costa
Maintainer(s)	Tom Fellows
Latest version	0.3.0
MediaWiki	>= 1.35.3
Database changes	Yes
Tables	openbadges_class openbadges_assertion
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgOpenBadgesThumb $wgOpenBadgesRequireEmail $wgOpenBadgesRequireEmailConfirmation
Added rights createbadge issuebadge viewbadge
Hooks used LoadExtensionSchemaUpdates
Quarterly downloads	1 (Ranked 131st)
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 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 (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.

Installation

• Download and move the extracted OpenBadges folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/OpenBadges
• Add the following code at the bottom of your LocalSettings.php file:

  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.

Configuration

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 also

• OpenBadges