Extension:WikiEditor - MediaWiki (original) (raw)

Languages:

• Bahasa Indonesia
• Bahasa Melayu
• Deutsch
• Deutsch (Sie-Form)
• English
• Tiếng Việt
• Türkçe
• català
• español
• français
• italiano
• magyar
• polski
• português
• português do Brasil
• sicilianu
• svenska
• čeština
• Ελληνικά
• русский
• українська
• العربية
• فارسی
• বাংলা
• 中文
• 日本語
• 한국어

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.46
Parameters wgWikiEditorRealtimePreviewDebouncewgWikiEditorRealtimePreviewDebounce wgWikiEditorRealtimePreviewDebouncewgWikiEditorRealtimePreview $wgWikiEditorRealtimeDisableDuration
Hooks used ChangeTagsListActive EditPage::attemptSave EditPage::attemptSave:after EditPage::showEditForm:fields EditPage::showEditForm:initial EditPageGetPreviewContent GetPreferences ListDefinedTags RecentChange_save
Licence	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarballREADME
Help	Help:Extension:WikiEditor
Example	Test Wikipedia
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

This extension comes with MediaWiki 1.18 and later, so you do not need to download it. The remaining configuration instructions must still be followed.

• 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 represent 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: This is sometimes called the '2010 wikitext editor'. option (under the [Editing](/wiki/Special:Preferences#mw-prefsection-editing "Special:Preferences") 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';

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

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

Realtime Preview is enabled by default. Disable the Realtime Preview feature with the following:

$wgWikiEditorRealtimePreview = false;

Enable the Realtime Preview feature with the following:

$wgWikiEditorRealtimePreview = true;

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.
• Extension:WikiEditor/Keyboard shortcuts – list of built in editing shortcuts
• 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.

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.