Difference between revisions of "Wiki Monkey"

From ArchWiki
Jump to: navigation, search
m (Installation: style)
(merged to ArchWiki:Bots#Wiki Monkey after 4.0.0 release, the documentation is maintained at https://github.com/kynikos/wiki-monkey/wiki)
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Internet Applications]]
+
#redirect [[ArchWiki:Bots#Wiki Monkey]]
[https://github.com/kynikos/wiki-monkey/wiki Wiki Monkey] is a MediaWiki-compatible bot and editor assistant that can be used directly within wiki pages in the browser as a user script. Currently it is tested on [[Firefox]], [[Chromium]] and [[Opera]], but it is very likely to work also on other browsers out of the box or with minor adaptations. Wiki Monkey can also be easily extended through the creation of plugins, exploiting its API.
 
 
 
The project is currently focused on ArchWiki, and as such most plugins address ArchWiki-specific problems.
 
 
 
==Installation==
 
 
 
Follow [https://github.com/kynikos/wiki-monkey/wiki/Getting-started the upstream documentation].
 
 
 
{{Note|since the ArchWiki is served through HTTPS, Opera users will have to follow the instructions in the related note.}}
 
 
 
{{Tip|the names of ArchWiki-specific configurations appear in the configurations table with an "ArchWiki-" prefix.}}
 
 
 
==Tour of the features==
 
 
 
Discover the features of Wiki Monkey by following this tour. See [https://github.com/kynikos/wiki-monkey/wiki/Bundled-plugins Bundled plugins] for more detailed information.
 
 
 
{{Tip|at the bottom of Wiki Monkey's interface you will always find a log area, on dark background, where Wiki Monkey and its plugins will output their messages.}}
 
 
 
===Editor pages===
 
 
 
If you have installed the ''ArchWiki-Editor'', ''ArchWiki-Patrol'' or ''ArchWiki-Bot'' configuration, in every ''editor'' page (e.g. [https://wiki.archlinux.org/index.php?title=ArchWiki:Sandbox&action=submit ArchWiki:Sandbox's]) 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:
 
 
 
* ''Fix header'' reorders the elements in the header, warns about possible problems (e.g. lack of category) and tries to fix some.
 
* ''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.
 
* ''Fix links'' tries to turn external links into proper internal/interwiki links (e.g. Wikipedia), or templates (e.g. [[Template:Pkg]]).
 
* ''Use code templates'' replaces {{ic|<pre>}}, {{ic|<code>}} and {{ic|<tt>}} with [[Template:bc]] and [[Template:ic]], taking care of adding numbered parameters or {{ic|<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.
 
* ''Sync interlanguage links'' synchronizes the interlanguage links of the edited page with those of its translations (the Chromium-native, Opera and standalone configurations can only synchronize local languages).
 
* ''Fix old AUR links'' converts direct AUR-1.x package links to instances of [[Template:AUR]] (available only for the Scriptish/Greasemonkey/Tampermonkey configurations).
 
 
 
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.
 
 
 
===Diff pages===
 
 
 
If you have installed the ''ArchWiki-Patrol-Lite'', ''ArchWiki-Patrol'' or ''ArchWiki-Bot'' configuration, in every ''diff'' page (e.g. [https://wiki.archlinux.org/index.php?title=ArchWiki:Sandbox&diff=262475&oldid=261738 one from ArchWiki:Sandbox's history]) you will find Wiki Monkey's interface right below the two diff panes. Here the only bundled plugin is ''Quick report'', which adds a row with a link to the visited diff in the specialized table of [[ArchWiki:Reports]]. See also [[ArchWiki:Maintenance Team]].
 
 
 
===Page lists (Bot)===
 
 
 
If you have installed the ''ArchWiki-Bot'' configuration you will find Wiki Monkey's Bot interface in many pages that show lists of pages (e.g. [[Special:Categories|Category pages]], [[Special:WhatLinksHere|What Links Here pages]] and many [[Special:SpecialPages|Special pages]]; see [[:Category:Sandbox]] for a specific example). The usage of the Bot interface is explained in [https://github.com/kynikos/wiki-monkey/wiki/Bot-interface the upstream documentation].
 
 
 
{{Note|the Bot interface is hidden by default, you will have to show it by clicking on the dedicated link.}}
 
 
 
The available plugins for the Bot are a regular expression substitution function and a tool for synchronizing the interlanguage links of the pages with those of their translations (the Chromium-native, Opera and standalone configurations can only synchronize local languages); [[Special:LinkSearch]] also provides a plugin for converting direct AUR-1.x package links to instances of [[Template:AUR]] (the Bot is shown only if there is at least one item in the list; available only for the Scriptish/Greasemonkey/Tampermonkey configurations).
 
 
 
===Special functions===
 
 
 
If you have installed the ''ArchWiki-Bot'' configuration you will also find Wiki Monkey's interface at the top of [[Special:SpecialPages]]: here you will find those plugins that have a generic purpose and are not based on a specific page. The available plugins are a function to update [[Table of Contents]] pages, and a function to fix [[Special:DoubleRedirects|double redirects]].
 
 
 
===Recent Changes===
 
 
 
If you have installed the ''ArchWiki-Patrol-Lite'', ''ArchWiki-Patrol'' or ''ArchWiki-Bot'' configuration, at the top of [[Special:RecentChanges]] you will find Wiki Monkey's Recent Changes filter. Currently the bundled filter only groups the changes by the language of the affected article.
 
 
 
{{Note|the default filter is designed to work on top of MediaWiki's Recent Changes filter, which can be enabled in [[Special:Preferences#mw-prefsection-rc]]. This also means that you must be logged on in order to use it.}}
 
 
 
==See also==
 
* [https://github.com/kynikos/wiki-monkey/wiki/Troubleshooting Troubleshooting]
 
* [https://github.com/kynikos/wiki-monkey/issues Bug reports, feature requests, questions]
 

Latest revision as of 16:09, 23 December 2017