WikiEdit

WikiEdit is a tool for quickly editing content without leaving the page. WikiEdit makes editing easy, fast and intuitive, especially on mobile devices.

Demo on the Spanish Wikipedia.
Demo on a mobile device.

Installation

If WikiEdit is already available as a gadget in your wiki, simply go to the gadgets tab in your preferences and enable it. If not, then you can install it just for you by adding the following code to your common.js in the wiki where you want it available (Wikimedia or not) or to your global.js if you want it available in every Wikimedia wiki:

/**
 * WikiEdit is a tool for quickly editing content without leaving the page
 * Documentation at https://www.mediawiki.org/wiki/WikiEdit
 */
mw.loader.load( '//www.mediawiki.org/wiki/MediaWiki:WikiEdit.js?action=raw&ctype=text/javascript' );

If you want to make WikiEdit available as a gadget in your wiki, first create MediaWiki:Gadget-WikiEdit.js with the code above and any configuration. Then create MediaWiki:Gadget-WikiEdit with a short description of the tool. Finally, add the following to MediaWiki:Gadgets-definition (see Extension:Gadgets#Usage for details):

* WikiEdit [ResourceLoader|targets=desktop,mobile|actions=view] | WikiEdit.js

Configuration

WikiEdit requires no configuration. However, the following options are available. Add them anywhere before or after the initialization code. They are shown along with their default values:

// Documentation page to link from the edit summaries
mw.config.set( 'wikiedit-page', 'mw:WikiEdit' );

// Change tag to track edits made with the tool
mw.config.set( 'wikiedit-tag', null );

Note that all edits made with WikiEdit are automatically tagged with the #wikiedit hashtag and can be easily tracked via https://hashtags.wmcloud.org across all Wikimedia wikis. Thus, setting a change tag is generally unnecessary, but may be useful for third-party wikis or for specific purposes.

Usage

Once installed, simply go to any page and click the little pencil icon that should appear next to most paragraphs.

FAQ

Why did it load the regular editor when I clicked the edit button?

If an element isn't unique enough, then WikiEdit can't find it in the page wikitext, and the regular editor will load as a fallback.

Why does the edit button appear next to some elements but not others?

WikiEdit only shows the edit button next to paragraphs. List items, image captions and talk replies are likely to be supported in the near future.

Development

Clone the Gerrit repository to start contributing (see Gerrit/Tutorial). Once your code gets merged, it will be copied to MediaWiki:WikiEdit.js and become available to all users and all wikis.

Localization

Visit the translation project to help with translations. Your translations will become available automatically to all users and all wikis in a few days, just be patient.