Difference between revisions of "Wiki Monkey"

From ArchWiki
Jump to: navigation, search
(Tampermonkey (Chromium): automatic updates work, verified with 1.10.1)
m (Greasemonkey (Firefox): punct.)
Line 38: Line 38:
  
 
====Greasemonkey (Firefox)====
 
====Greasemonkey (Firefox)====
{{Note|Experimental feature: please check periodically for new releases, and in case Wiki Monkey is not updated please report a bug [https://github.com/kynikos/wiki-monkey/issues here].}}
+
{{Note|Experimental feature: please check periodically for new releases and, in case Wiki Monkey is not updated, report a bug [https://github.com/kynikos/wiki-monkey/issues here].}}
 
Greasemonkey should enable automatic updates by default, you can check opening Firefox's ''Add-ons Manager'' (''Tools -> Add-ons''), selecting ''User Scripts'', right-clicking on Wiki Monkey and verifying ''Automatic check for updates'' is ticked.
 
Greasemonkey should enable automatic updates by default, you can check opening Firefox's ''Add-ons Manager'' (''Tools -> Add-ons''), selecting ''User Scripts'', right-clicking on Wiki Monkey and verifying ''Automatic check for updates'' is ticked.
  

Revision as of 12:07, 1 May 2012

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

Wiki Monkey is a MediaWiki-compatible bot and editor assistant that can be used directly within wiki pages in the browser. It is available for Firefox and Chromium, and can be easily extended through the creation of plugins, exploiting its high-level API.

The project is currently focused on ArchWiki, and as such most plugins address ArchWiki-specific problems.

Installation

Preparation

Firefox

Make sure you have installed either the Scriptish add-on (recommended) or the Greasemonkey add-on.

Chromium

Make sure you have installed the Tampermonkey extension. Even though Chromium has native support for user scripts, this has some limitations, and Tampermonkey is necessary in order to support Wiki Monkey's features.

Installing the script

Now just click on the link of one of the following Wiki Monkey configurations and your browser should ask you to install it:

  • Editor: provides manual-editing aid functions in editor pages, like automatic style fixes
  • Patrol Lite: provides a quick-report function in diff pages
  • Patrol: Editor + Patrol Lite
  • Bot: Patrol + automatic operations on list pages

Otherwise you can create your own configuration.

Warning: Although it is possible to keep multiple configurations of Wiki Monkey installed together, make sure to enable only one at a time.
Note: Chromium will first ask you whether you want to install the script with the native support or through Tampermonkey: of course you need to choose the Tampermonkey option.

Automatic updates

Scriptish (Firefox)

Scriptish does not enable automatic updates by default, so, if you want them, you have to open Firefox's Add-ons Manager (Tools -> Add-ons), select User Scripts, right-click on Wiki Monkey and choose Show More Information, then set Automatic Updates to On.

Scriptish's perferences are available in Firefox's Add-ons Manager (Tools -> Add-ons), selecting the Extensions tab.

Greasemonkey (Firefox)

Note: Experimental feature: please check periodically for new releases and, in case Wiki Monkey is not updated, report a bug here.

Greasemonkey should enable automatic updates by default, you can check opening Firefox's Add-ons Manager (Tools -> Add-ons), selecting User Scripts, right-clicking on Wiki Monkey and verifying Automatic check for updates is ticked.

Greasemonkey's perferences are available in Firefox's Add-ons Manager (Tools -> Add-ons), selecting the Extensions tab.

Tampermonkey (Chromium)

Tampermonkey should enable automatic updates by default, you can check opening Tools -> Extensions, selecting Tampermonkey's options, selecting the Settings tab and verifying the settings for Check Interval in the Script Update section.

Tour of the features

After installing the desired version of Wiki Monkey, start visiting the editor of this very page, you will find Wiki Monkey's interface right below the Save page button row. As you can see there are some buttons, each of which will execute a plugin action (see Bundled plugins for detailed information):

  • Fix header reorders the elements in the header, warns about possible problems (e.g. lack of category), adds Template:i18n if it is missing and so on.
  • Fix headings tries to fix the levels of section headings so that they start from level 2 and do not increase by more than 1 level with relation to the parent section.
  • Use code templates replaces <pre>, <code> and <tt> with Template:bc and Template:ic, taking care of adding numbered parameters or <nowiki> tags when necessary.
  • Expand contractions expands some common English contractions, e.g. "don't" becomes "do not".
  • Multiple line breaks compresses multiple empty lines into one.
  • RegExp substitution lets you perform a regular expression substitution.

By pressing one of them, the text in the editor will be modified, but note that the page will not be saved, so you will still be able to see the diff or the preview and perform other modifications manually. The Execute row and Execute all buttons are used to execute more plugins one after the other, thus saving some clicks.

At the bottom of Wiki Monkey's interface you will always find the log area, on dark background, where Wiki Monkey and its plugins will output their messages.

Now, if you have installed the "Patrol Lite", "Patrol" or "Bot" configuration, visit Special:RecentChanges and select a diff from the list: right below the diff panes you will find Wiki Monkey's interface. Here the only bundled plugin is Quick report, which adds a row with a link to the visited diff in a specialized table of a predefined article.

Note: The predefined article is actually still under development, so this feature is not working yet.

At this point, if you have installed the "Bot" configuration, visit Special:SpecialPages: at the top of the page you will find those plugins that have a generic purpose and are not based on a specific page: the only currently available plugin is a function to update Table of Contents pages.

Finally, if you have installed the "Bot" configuration, visit the Category of this article: right at the top you will find Wiki Monkey's bot interface, whose usage is explained in the upstream documentation. The only currently available plugin is a regular expression substitution function. Other pages where you can find the bot are What Links Here pages, the External links search tool and many of the list pages linked from Special:SpecialPages.

Contributions

Of course any help in the resolution of bugs or the development of new plugins is appreciated: if you are interested, send an email to the original author (or use his talk page) and urge him to finally complete the documentation about the development of plugins, which is actually quite straightforward.

See also