Extension:WikiEditor

MediaWiki extensions manual - list

WikiEditor Release status: stable
Description	Provides an extendable wikitext editing interface and many feature-providing modules
Author(s)	Trevor Parscal, Roan Kattouw
Last version	0.3.1
MediaWiki	1.19+
License	GPL v2
Download	Download snapshot (Git master) Git [?]: repo summary tree code changes README
Example	Test Wikipedia
Parameters $wgWikiEditorFeatures
Hooks used EditPage::showEditForm:initial GetPreferences MakeGlobalVariablesScript ResourceLoaderRegisterModules
Check usage and version matrix; stats
Bugs: list open list all report

WikiEditor is an extendable framework with a set of feature-based modules that improve the user experience of editing. It is also the editing interface that Wikipedia currently uses.

Installation

• Download and extract the files in a directory called "WikiEditor" in your extensions/ folder.
• Add the following code to your LocalSettings.php (at the bottom)

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

• Done – Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration

# Enables use of WikiEditor by default but still allow users to disable it in preferences
$wgDefaultUserOptions['usebetatoolbar'] = 1;
$wgDefaultUserOptions['usebetatoolbar-cgd'] = 1;
 
# Displays the Preview and Changes tabs
$wgDefaultUserOptions['wikieditor-preview'] = 1;
 
# Displays the Publish and Cancel buttons on the top right side
$wgDefaultUserOptions['wikieditor-publish'] = 1;

In some situations, WikiEditor may not show in your browser after the installation. Clearing your browser cache will solve the problem.

Toolbar customization

See /Toolbar customization.

Extending

Toolbar Module

The WikiEditor.

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

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 in the writing direction of the content language, 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

Actions

Each tool has an action which is executed when the tool is used. The most commonly used action 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. The encapsulate action takes three parameters, pre, peri and post, which can either be raw text or message keys.

Raw Text	Message	Description
pre	preMsg	Text to place before the cursor/selection
peri	periMsg	Text to place at the cursor if there is no selection
post	postMsg	Text to place after the cursor/selection/peri text

Table of Contents Module

Navigable table of content while editing a page to navigate in its sections. This module will enable the HTML iframe version of the text editing control, which is unstable and should only be used in experimental environments.

To enable this module, use the following code :

# Displays a navigation column (summary) on the right side
$wgDefaultUserOptions['usenavigabletoc'] = 1;

The following bug can be one of the potential issues with HTML iframe: 22438

See also

• Manual:Custom edit buttons#Extension:WikiEditor
• RefToolbar 2.0, on-wiki JavaScript that adds a Cite template tools to WikiEditor's UI.