Dario Giovannetti edited this page Aug 23, 2018 · 22 revisions

Wiki Monkey is a MediaWiki user script that provides editor-assisting and bot functionality.

Installation

Note: since version 4.0.0 the Greasemonkey/Tampermonkey/Violentmonkey and standalone versions are no longer released. Also existing users of the user-script versions are encouraged to update the script's url, since the old paths are still supported but may be deprecated in the future.

Installing Wiki Monkey is as simple as adding one of the following lines to your User:Example/common.js page:

For ArchWiki:

mw.loader.load('https://rawcdn.githack.com/kynikos/wiki-monkey/v4.2.2/dist/WikiMonkey-ArchWiki.min.js');

For Wikipedia:

mw.loader.load('https://rawcdn.githack.com/kynikos/wiki-monkey/v4.2.2/dist/WikiMonkey-Wikipedia.min.js');

Refresh any wiki page and Wiki Monkey will start working with the default configuration.

The example scripts above use githack.com, but you can use rawgit.com as an equivalent alternative, for example:

mw.loader.load('https://cdn.rawgit.com/kynikos/wiki-monkey/v4.2.2/dist/WikiMonkey-ArchWiki.min.js');

The *.min.js scripts are minified versions recommended for most users. If you want to install the "human-readable" bundle, perhaps for debugging purposes, just remove .min from the script's extension, for example:

mw.loader.load('https://cdn.rawgit.com/kynikos/wiki-monkey/v4.2.2/dist/WikiMonkey-ArchWiki.js');

In case you were wondering, mw.loader.load() properly makes use of the browser's cache, it will not download the script at every page request.

See Manual:Interface/JavaScript for more information on MediaWiki user scripts.

Caveats:

  • Do specify the version number in the script's URL; CDNs rely on long-term caching and using a more generic reference such as master as an attempt to automate updates will not work; Wiki Monkey has an update notification and installation system, see the Updates section below for more information.
  • Do not try to download the script from raw.githubusercontent.com, since it purposely serves Javascript files with a text/plain header and most modern browsers will not execute them. See http://stackoverflow.com/questions/7180099/including-js-from-raw-github-com for more details.

Usage

Wiki Monkey's functions are provided by plugins whose interfaces can be accessed from within some particular pages in the wiki. Also some modifications to MediaWiki's interface are installed.

See Usage and Bundled plugins for more information.

Updates

As noted in the Installation section, the Wiki Monkey script must be referenced with a specific version. Nonetheless, the application will periodically and automatically check for an updated version, by default once a week, on Saturday, or the first time that you access a wiki page 7 days after the previous update check.

If an updated version is detected, Wiki Monkey will notify and prompt you to trigger an automated upgrade edit, which simply checks for the mw.loader.load() line in your User:Example/common.js page and changes the version number to the latest release.

Configuration

See Configuration for instructions.

See also

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.