Extension:Education Program

shortcut EP

MediaWiki extensions manual - list

Education Program Release status: beta
Implementation	Special page, Ajax, User interface
Description	Facilitates educational programs by adding various interfaces to manage courses, students, institutions, mentors, ect, as well as improving workflow for everyone involved and proving several analysis/statistics interfaces.
Author(s)	Jeroen De Dauw
MediaWiki	1.20.0 or higher
PHP	5.3 or above
Database changes	yes
License	GNU GPL v2+
Download	current version all versions snapshots browse source readme release notes
Example	education.wmflabs.org
Hooks used LoadExtensionSchemaUpdates UnitTestsList PersonalUrls GetPreferences SkinTemplateNavigation SkinTemplateNavigation::SpecialPage ArticleFromTitle CanonicalNamespaces TitleIsAlwaysKnown AbortMove NewRevisionFromEditComplete
Check usage (experimental) Bugs: list open list all report

About

Facilitates educational programs by adding various interfaces to manage courses, students, institutions, mentors, ect, as well as improving workflow for everyone involved (enrolment, seeing changes of other students, article and reviewer association) and proving several analysis/statistics interfaces. It was developed for the Wikipedia Education Program but is generic enough to be used by similar programs.

Feature overview

• Browsing interfaces for institutions, courses and terms.
• Pages with summaries and linked items for all institutions, courses and terms.
• Edit page for institutions, courses and terms.
• History pages for institutions, courses and terms.
• Enrollment page for students with optional token requirement (and associated disenroll page).
• Sortable and filterable list of students.
• Personal courses overview at Special:ManageCourses for students, ambassadors and instructors.
• Personal course activity overview at Special:MyCourses.
• Overview of the program status on Special:EducationProgram.
• Overview of student activity on Special:StudentActivity.
• Online Ambassador and Campus Ambassador profiles.
• Lists of Online Ambassadors and Campus Ambassadors.
• Logging of all special education events, such as enrollment and courses association.

Requirements

Education Program requires:

• MediaWiki 1.20 or above
• PHP 5.3 or above

Download

You can find the current version of Education Program on the Google Code download page, as well as a list of legacy downloads.

You can get the code directly from SVN. Tags can be obtained via

svn checkout http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/EducationProgram/REL_version

Where 'version' is the version number of the tag, such as 0_1 (see the available tags). The latest code can be obtained from trunk:

svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/EducationProgram/

Installation

Once you have downloaded the code, place the EducationProgram directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file:

# Education Program
require_once( "$IP/extensions/EducationProgram/EducationProgram.php" );

Configuration

Configuration of Education Program is done by assigning to $egEPSettings in your LocalSettings.php file. The options are listed below and their default is set in the Education Program settings file. You should NOT modify the settings file, but can have a look at it to get an idea of how to use the settings, in case the below descriptions do not suffice.

Example of how to change a setting:

$egEPSettings['defaultWidth'] = 250;

Available settings:

Name	Type	Default	Description
enableTopLink	boolean	true	Enabled the link to Special:MyCourses in the menu on the top (next to the link to MyPreferences).
ambassadorCommonsUrl	string	https://commons.wikimedia.org/wiki/Special:UploadWizard	Link to the upload interface for ambassador profile pictures.
citylessCountries	array	see settings file	List of countries for which to not require a city for institutions.
ambassadorImgWidth	integer	140	Maximum width of ambassador profile images in the ambassador profile lists.
ambassadorImgHeight	integer	140	Maximum height of ambassador profile images in the ambassador profile lists.
recentActivityLimit	integer	24 * 60 * 60	The length of the time period for which to show activity on Special:StudentActivity.
flagWidth	integer	25	The maximum width of flag icons on Special:StudentActivity.
flagHeight	integer	25	The maximum width of flag icons on Special:StudentActivity.
countryFlags	array	see settings file	List of country codes pointing to image names used to figure out which image to use for country flag icons.
fallbackFlag	string	Nuvola unknown flag.svg	A flag image to show for countries that do not have an associated flag set in the countryFlags settings.
courseDescPage	string	MediaWiki:Course description	Name of the page on which the default initial description for courses can be specified.
courseOrgDescPage	string	$2/$1	Name of the page on which the initial description for courses belonging to a specific institution can be specified. $1 is replaced by the name of the institution and $2 is replaced by the value of the courseDescPage setting.
useStudentRealNames	boolean	false	If real names should be shown instead of usernames for students in the education interfaces.
timelineDurationLimit	integer	2 *24 * 60 *60	The length of the time period for which to show activity in the course activity timelines (ie on Special:MyCourses).
timelineCountLimit	integer	42	Maximum number of items to show in the course activity timelines.
timelineUserLimit	integer	3	Maximum number of users to list in an event group in course activity timelines.
dykCategory	string	Wikipedia:Education Program Did You Know	The name of the category from which to use pages as content for the did you know box.
dykOrgCategory	string	$2/$1	The name of the category from which to use pages as content for the did you know box for a specific institution. $1 is replaced by the name of the institution and $2 is replaced by the value of the dykCategory setting.

Developer documentation

• High level database overview
• Low level schema docs
• There is lots of class-and function-level documentation ;)

Version

This is a copy of the release notes file on SVN, which might be more up to date than this page.

Internationalization

Education Program is fully internationalized. Translation of Education Program messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

Authors

Education Program has been written by Jeroen De Dauw as Wikimedia Foundation contractor for the Wikipedia Education Program.

External links

• Education Program on Ohloh