Extension:UsabilityInitiative

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

UsabilityInitiative Release status: beta
Description	Features developed by the Wikipedia Usability Initiative to enhance the usability of MediaWiki
Author(s)	Trevor Parscal, Roan Kattouw
MediaWiki	1.16+
License	GPL v2
Download	Download snapshot Subversion [Help] Browse source code README
Example	Wikipedia Prototype
Hooks used BeforePageDisplay MakeGlobalVariablesScript
check usage (experimental)

The development of this extension is being driven by the Wikipedia Usability Initiative. The features this extension provides are either core features of the objectives of this initiative, or supporting features which assist in the deployment of the core features and statistics gathering for analysis.

There are several components of this extension.

• ClickTracking
• OptIn
• PrefStats
• UserDailyContribs
• Vector
• WikiEditor

[edit] Click Tracking

This feature is used to track users' navigation around the wiki by monitoring each click they make. It has a couple of API modules.

[edit] OptIn

NOTE: OptIn was developed specifically to be run as part of the Beta rollout on Wikimedia wikis; it may or may not be useful to third-party users. The extension can be run on non-WMF wikis, but is hardly documented; we'll write documentation when there is time :)

[edit] PrefStats

NOTE: PrefStats was developed specifically to be run as part of the Beta rollout on Wikimedia wikis; it may or may not be useful to third-party users. The extension can be run on non-WMF wikis, but is hardly documented; we'll write documentation when there is time :)

Give statistics on user preferences about this extension. (upload File:PrefStats.png)

[edit] UserDailyContribs

[edit] Vector

[edit] EditWarning Module

Add a warning to editor when they leave the edit form without saving.

[edit] WikiEditor

An extendable framework with a set of feature-based modules that improve the user experience of editing.

[edit] Installation

require_once("$IP/extensions/UsabilityInitiative/WikiEditor/WikiEditor.php");

[edit] Toolbar Module

The edittoolbar component of this extension.

A toolbar visible on editing pages which replaces the stock toolbar.

[edit] Sections

Toolbar

The bold button tool.

Default select tools: Format, Insert, Special characters, Help

A toolbar is a series of groups, each with a series of tools, rendered from left to right with visible dividers between groups.

Supported Tool Types

• Button - an icon which can be clicked
• Select - a drop-down list which can be selected from

Booklet

Loading help booklet

A booklet is a series of named pages which can be viewed one at a time and navigated through using an index list widget.

Supported Page Types

• Table - a grid of columns and rows
• Characters - a series of rectangular buttons containing text values

[edit] Actions

Each tool has an action which is executed when the tool is used. The only supported action right now is encapsulate which operates on the currently selected text, prepending text, appending text and in the case that no text was selected inserting text at the cursor.

[edit] Table of Contents Module

Navigable table of content while editing a page to navigate in its sections. (upload File:NavigableTOC.png)

[edit] Installation

1. Get the extension with distributor or svn and drop it into MediaWiki directory /extensions
2. Setup your LocalSettings.php as explained in README file.
3. Run php maintenance/update.php from the command line (see update.php and also here)