Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
Wiki Monkey is a MediaWiki user script that provides editor-assisting and bot functionality.
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:
Refresh any wiki page and Wiki Monkey will start working with the default configuration.
*.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:
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.
- Do specify the version number in the script's URL; CDNs rely on long-term
caching and using a more generic reference such as
masteras 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,
text/plainheader and most modern browsers will not execute them. See http://stackoverflow.com/questions/7180099/including-js-from-raw-github-com for more details.
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.
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.
See Configuration for instructions.