Difference between revisions of "Wiki Monkey"

From ArchWiki
Jump to: navigation, search
(update for 1.9.0)
m (Installation: avoid misunderstandings)
Line 13: Line 13:
 
{{Note|[[Chromium|Chrome/Chromium]] users can try [http://code.google.com/p/tampermonkey/ Tampermonkey], but Wiki Monkey is not tested against it and does not currently support it.}}
 
{{Note|[[Chromium|Chrome/Chromium]] users can try [http://code.google.com/p/tampermonkey/ Tampermonkey], but Wiki Monkey is not tested against it and does not currently support it.}}
  
Now just click on the link of one of the following Wiki Monkey configurations and Firefox should ask you to install it:
+
Now just click on the link of '''one''' of the following Wiki Monkey configurations and Firefox should ask you to install it:
 
*[https://raw.github.com/kynikos/wiki-monkey/master/src/configurations/WikiMonkey-archwikieditor.user.js Editor]: provides manual-editing aid functions in editor pages, like automatic style fixes
 
*[https://raw.github.com/kynikos/wiki-monkey/master/src/configurations/WikiMonkey-archwikieditor.user.js Editor]: provides manual-editing aid functions in editor pages, like automatic style fixes
 
*[https://raw.github.com/kynikos/wiki-monkey/master/src/configurations/WikiMonkey-archwikipatrol.user.js Patrol]: Editor + quick-report functions in diff pages
 
*[https://raw.github.com/kynikos/wiki-monkey/master/src/configurations/WikiMonkey-archwikipatrol.user.js Patrol]: Editor + quick-report functions in diff pages
Line 20: Line 20:
 
Otherwise you can [https://github.com/kynikos/wiki-monkey/wiki/Custom-configuration create your own configuration].
 
Otherwise you can [https://github.com/kynikos/wiki-monkey/wiki/Custom-configuration 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.}}
+
{{Warning|Although it is possible to keep multiple configurations of Wiki Monkey installed together, make sure to enable only '''one''' at a time.}}
  
 
===Automatic updates===
 
===Automatic updates===

Revision as of 21:01, 18 April 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. Wiki Monkey is run as a Scriptish script for Firefox 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.

Note: For those upgrading from version 1.8.2 (or older) to 1.9.0: due to a change in the naming of the configuration scripts you must manually reinstall the configuration from one of the links in the #Installation section, which are already using the new naming: the configuration will be installed as a new script, so you will have to uninstall the old script from Firefox's Add-ons Manager -> User Scripts; if you were using #Automatic updates, you will have to set them up again for the new script. Starting from version 1.9.0 the old names are used for more generic configurations without ArchWiki-specific tools.

Installation

Make sure you have installed Scriptish for Firefox.

Note: Chrome/Chromium users can try Tampermonkey, but Wiki Monkey is not tested against it and does not currently support it.

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

  • Editor: provides manual-editing aid functions in editor pages, like automatic style fixes
  • Patrol: Editor + quick-report functions in diff pages
  • 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.

Automatic updates

If you want to enable automatic updates, 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.

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" 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 bundled plugins are:

  • Quick report adds a row with a link to the visited diff in a specialized table of a predefined article, see User:Kynikos/RC Patrol for an example.
  • Save discussion does pretty much the same thing in another article but with less details, and can be useful to save a discussion for replying later, see User:Kynikos/Discussions for an example.

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 and the External links search tool.

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