Extension:WikiEditor

This extension comes with MediaWiki 1.18 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

MediaWiki extensions manual

WikiEditor Release status: stable
Description	Provides an extendable wikitext editing interface and many feature-providing modules
Author(s)	Derk-Jan Hartman Trevor Parscal Roan Kattouw (WMF) Nimish Gautam Adam Miller
Latest version	Continuous updates
MediaWiki	>= 1.43
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README
Help	Help:Extension:WikiEditor
Example	Test Wikipedia
Parameters $wgWikiEditorRealtimePreview $wgWikiEditorRealtimePreviewDebounce $wgWikiEditorRealtimeDisableDuration
Hooks used ChangeTagsListActive EditPage::attemptSave EditPage::attemptSave:after EditPage::showEditForm:fields EditPage::showEditForm:initial EditPageGetPreviewContent GetPreferences ListDefinedTags RecentChange_save
Quarterly downloads	553 (Ranked 5th)
Public wikis using	13,753 (Ranked 9th)
Translate the WikiEditor extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The WikiEditor extension provides an improved interface (primarily a toolbar) for editing wikitext. It is the wikitext editing interface that Wikipedia started using in 2010 for desktop users, and so it is sometimes called the 2010 wikitext editor.

Installation

• Download and move the extracted WikiEditor folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiEditor
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'WikiEditor' );
  

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

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

Note for IIS setup: By default, IIS doesn't understand .svg files. WikiEditor uses them to represents the icons. To fix this, you have to add the MIME type.

Configuration

Enabling/disabling the toolbar

No configuration is needed "out of the box". By default, when installed, this extension will be available to all users, and logged-in users can disable it from their preferences via the "Enable the editing toolbar" option (under the "Editing" tab).

If you wish all users to have it, and be unable to disable it, add it to $wgHiddenPrefs in your LocalSettings.php file:

$wgHiddenPrefs[] = 'usebetatoolbar';

MediaWiki version:

≤ 1.31

If you are using a version before REL1_31 and would want the toolbar to be default for users when they first join, add this line to your LocalSettings.php:

$wgDefaultUserOptions['usebetatoolbar'] = 1;

Realtime Preview

MediaWiki version:

≥ 1.39

Enable the Realtime Preview feature with the following:

$wgWikiEditorRealtimePreview = true;

This configuration parameter defaults to true starting with version 1.41.0 of MediaWiki.

Signature button

The button for adding user signatures (four tildes) is available on talk pages and in namespaces specified in $wgExtraSignatureNamespaces .

See also

• Extension:WikiEditor/Toolbar customization – technical details of customizing the toolbar.
• Extension:WikiEditor/Toolbar customization/Library – snippets of code for common additions to the toolbar.
• RefToolbar 2.0, on-wiki JavaScript that adds Cite template tools to WikiEditor's UI.
• 2017 wikitext editor
• Extension:MsWikiEditor – allows you to easily add or remove buttons from the WikiEditor toolbar via configuration
• Extension:EventLogging – If installed, WikiEditor will make use of it.