Usage - kynikos/wiki-monkey GitHub Wiki
Wiki Monkey's functions are provided by the core scripts and several plugins, and can be operated within some particular pages in the wiki. In addition, some modifications to MediaWiki's interface are applied.
The available functionality can be presented in different kinds of interfaces, described below.
Page/section commands
Each page and section now has specific commands next to the headings:
- A link to scroll to the top of the page (useful when lazily browsing with one hand on the mouse, but also to copy the full url without having to focus the address bar).
- A link to each section, especially useful to copy the full url with the fragment identifier.
- Commands to copy ready-to-paste internal links to the clipboard.
- The top-page commands also include a "WM" link to open Wiki Monkey's Main WM menu.
- Other plugins such as the server-aided ones install their own commands.
Main WM menu
- about: allows inspecting the current configuration and executing some maintenance operations.
- Other plugins such as the server-aided ones install their own management interfaces here.
Menu interface
Each plugin is represented by a button with a descriptive label: clicking on the button will simply execute it and output any messages in the log below. If a button has an additional ">" button on its right, it represents a submenu: clicking on the ">" button opens the submenu, while clicking on the labeled button executes all the plugins in the submenu sequentially. Submenus have a "<" button that returns to the parent menu. The root menu also has a "*" button on the left: this will execute all the installed plugins sequentially.
Bot interface
Note: the bot interface is hidden by default, you will only see Wiki Monkey's fieldset; by clicking on the "show" link the bot interface will be shown.
At the top of Wiki Monkey's fieldset you can see the Plugin box: there you can select the plugin you want to use with the bot. If the plugin has an interface for entering some parameters, it will be shown right below the plugin selector.
Below the Plugin box you will find the Filter box: if the page shows
different lists (e.g. Category pages show subcategories and pages) you will be
able to choose the list to be used with a select menu; if there is only one
list, such menu will be hidden. In any case, however, you will be shown a text
area where you can choose what titles you want to include in the article list
that will be processed by the bot. Each line in the filter area must be a
JavaScript regular expression,
including the opening and closing /, and the optional flags after the closing
/. If you put a ! before the opening /, all the titles that do not
match will be included. The various regular expressions are evaluated for every
title in the list, and it is sufficient that the title matches one of the
regular expressions to be included in the processing list. Once you have
written the regular expressions you can click on the Preview button to see
the current selection in the list, where the selected articles will be
highlighted in light red. If you select the Duplicates checkbox, if an
article appears more than once in a list, all its appearances will be selected;
otherwise only the first instance will be selected. If you select the Inverse
checkbox, the selection will be inverted.
Finally, when you are fine with the defined selection, you can click on the Start bot button right above the logging area: you will see that while an article is processed it is highlighted in yellow, and when it is done processing, it is highlighted in blue if it has not been changed, or in green if it has been changed. You can stop the bot whenever you want by clicking on the Stop bot button. The running plugin and bot will output their messages in the logging area. If a non-critical error happens, like attempting to edit a page without the rights for doing it, the bot will issue a warning , highlight the article title in bright orange, and continue processing the remaining articles. If a critical error happens, the bot will stop and the article that was being processed will be highlighted in red.
In order to prevent malicious usage of the bot, and to allow you the time to check the edits, a delay of 30 seconds is added every time the bot makes a change to a page. This delay is reduced to 3 seconds for authorized bots.
Edits performed through the Bot interface will be tagged as wiki-monkey.
Warning: A bot is not a "fire-and-forget" tool, you should always make sure to keep an eye on what it is doing, since the plugin it is using may not take into consideration particular cases that should be exempted or treated in a different manner. Also remember to examine the messages in the log at the bottom of Wiki Monkey's interface.
Note: Wiki Monkey is designed to refuse to run multiple instances of the bot at the same time, for example in different browser tabs or windows, in order to avoid overloading the server. If you try to do so, you will be shown a warning and the possibility to force-start the second bot, thus stopping the other bot.
Filter interface
A select menu will let you choose one of the installed filters; the "Apply filter" button applies it; the "Show log" checkbox can be used to show or hide the log, which is hidden by default.
By default Wiki Monkey applies the default filter as soon as the page is ready; in this case the filter interface starts hidden if the plugin does not have an options panel.