Extension:WikiEditor

From MediaWiki.org
Jump to: navigation, search

Other languages:
català • ‎Deutsch • ‎English • ‎British English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文

Note Note: This extension is bundled with MediaWiki 1.18 and above. Thus you do not have to download it again.

MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
WikiEditor

Release status:Extension status stable

VectorEditorBasic-en.png
DescriptionTemplate:Extension#description Provides an extendable wikitext editing interface and many feature-providing modules
Author(s)Template:Extension#username Trevor Parscal, Roan Kattouw
Latest versionTemplate:Extension#version 0.5.0 (2016-06-14)
MediaWikiTemplate:Extension#mediawiki 1.19+
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
ExampleTemplate:Extension#example Test Wikipedia
ParametersTemplate:Extension#parameters

$wgWikiEditorFeatures

Hooks usedTemplate:Extension#hook
EditPage::showEditForm:initialManual:Hooks/EditPage::showEditForm:initial
GetPreferencesManual:Hooks/GetPreferences
MakeGlobalVariablesScriptManual:Hooks/MakeGlobalVariablesScript
ResourceLoaderRegisterModulesManual:Hooks/ResourceLoaderRegisterModules

Translate the WikiEditor extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The WikiEditor extension provides an improved interface for editing wikitext. It is the editing interface that Wikipedia currently uses.

It includes an extendable framework with a set of feature-based modules, each of which can be selectively enabled or disabled, aiming to improve the user experience of editing in different ways.


Installation[edit]

  • Download and place the file(s) in a directory called WikiEditor in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'WikiEditor' );

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing extensions using wfLoadExtension(), since MediaWiki 1.25. If you need to install this extension in earlier versions, instead of wfLoadExtension( 'WikiEditor' );, you need to use:

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

Configuration[edit]

# Enables use of WikiEditor by default but still allows users to disable it in preferences
$wgDefaultUserOptions['usebetatoolbar'] = 1;

# Enables link and table wizards by default but still allows users to disable them in preferences
$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;

Add the above code at the bottom of your LocalSettings.php. In some situations, WikiEditor may not show in your browser after the installation. Clearing your browser cache will solve the problem.

Note Note:

Toolbar customization[edit]

See Toolbar customization.

Extending[edit]

Toolbar Module[edit]

The WikiEditor.

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

Sections[edit]

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[edit]

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

Labs Modules[edit]

Part of the WikiEditor extension were a number of alpha quality modules. These alpha modules are now deprecated and are being removed. The modules are: highlighter, toc, templates and template editor. You should not be using them.

See also[edit]