Extension:GettingStarted

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
GettingStarted

Release status: beta

Implementation User interface, API
Description Delivers task suggestions to new editors and shows editors how to complete those tasks
Author(s) Munaf Assaf, Matthew Flaschen, Ori Livneh, S Page, Sam Smith
Latest version 1.0
MediaWiki 1.21+
Database changes No
License GNU General Public License 2.0 or later
Download
Hooks used
BeforePageDisplay

BeforeWelcomeCreation
RecentChange_save
CategoryAfterPageAdded
CategoryAfterPageRemoved
ListDefinedTags
MakeGlobalVariablesScript

Translate the GettingStarted extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report

The GettingStarted extension provides an onboarding process for new editors of Wikipedia.

Features[edit | edit source]

UX/UI described in more detail at Onboarding new Wikipedians

GettingStarted provides several interfaces for suggesting introductory tasks to newly-registered editors, and it uses guided tours to show them how to complete their first edits.

GettingStarted assumes users will be redirected back to their internal referrer post-registration, with CentralAuth's $wgCentralAuthSilentLogin set to true. After users are sent back to their internal referrer (or the Main Page, if it is null), they are provided with an invitation to either edit the current page or take a suggestion of something easy to edit.

Task suggestion API[edit | edit source]

Task suggestions are provided via the API. These task suggestions are optional and only appear if the wiki has appropriate task categories set. The GettingStarted API depends on lists of articles stored in Redis and populated from on-wiki categories, which can be configured. You may also exclude certain categories via wmgGettingStartedExcludedCategories in InitialiseSettings.php.

View the help documentation via /w/api.php?action=help&modules=gettingstartedgetpages. The following are some examples of types of pages you call from the API:

Dependencies[edit | edit source]

Installation[edit | edit source]

GettingStarted uses Extension:EventLogging to log and Extension:GuidedTour to provide tours and tooltips. As of January 2013 they are required.

The extension maintains its lists of articles in a Redis in-memory store. See README for the latest requirements and dependencies.

  • Download and extract the files in a directory called GettingStarted in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/GettingStarted/GettingStarted.php" );
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

See also[edit | edit source]