kynikos/wiki-monkey

MediaWiki-compatible bot and editor assistant running directly in the browser and expandable with plugins.

Wiki Monkey is a MediaWiki user script that provides editor-assisting and bot functionality.

License: GPLv3 (see LICENSE).

Read the Wiki in order to get started.

The optional database server is hosted in the separate wiki-monkey-server repository.

wiki-monkey's Issues

Quick report and Save discussion: links to target pages

Quick report and Save discussion: links to target pages

Fix section heading levels

Section headings should start from 2nd level and subsections shouldn't skip levels.

Simulate common fixes in diff pages

Simulate common editor fixes in diff pages, showing their messages in the log

Otherwise just merge this request with #47

ExpandContractions doesn't preserve capitalization

ExpandContractions should preserve the original capitalization

use GM_addStyle

Style elements in Wiki Monkey with GM_addStyle

Bot: preset filters, e.g. namespaces

Bot: preset filters, e.g. namespaces

Function-specific interfaces

Write a UI_function for each UF_function in order to let each function define its own interface (provide buttons, input fields etc.).
The UI_functions should be called at page load, and the UF_functions should be called as specified by the interfaces.

Simple bot substitutions

Make it possible to do simple regexp substitutions from Category pages, WhatLinksHere pages and similar lists.

Info area

Use an area on the screen (position static, absolute or even fixed) to display messages from user functions instead of alerts (currently only UF_archWikiNewTemplates() outputs a warning).
This requires also API functions to write to the area.

Quick report button

The "Append to patrol list" button should better be renamed "Add quick report" or just "Quick report". Also consider changing the namespace and the filename

Update license

Update license description and year in every file header

Working default configuration

Install Wiki Monkey with a default working configuration instead of requiring the user to install functions.

Pass arguments to user functions

(not exactly related to the API, but still involves changing the core script)

The top level of main's multidimensional input array should accept an additional array to let the user pass some arguments to user functions.
For example instead of the current:

[UF_myFunction, "myFunction", false]

it should be:

[UF_myFunction8, [arg1, arg2, arg3, ...], "myFunction8", true]

If a user function doesn't accept arguments, an empty array must be used (or null?)

Note that using the second index would break backward compatibility, so all users must be warned.

ArchWikiQuickReport more flexible

Make ArchWikiQuickReport support a variable number of fields in the table.
It would be good if the interface could support also select elements.

Log should scroll automatically

The log should scroll automatically to the bottom when it was at the bottom and a new entry has been appended.

Bot: option to open diff in new browser tab for every edit

Bot: option to open diff in new browser tab for every edit

Different configurations

Maintain different .user.js configurations

Fix article header

Recognize elements in article headers (categories, i18n...), reorder them and add what's missing

Semi-automatic bot operations

Scriptish can keep an array of simple values across page-loads by using GM_setValue(), GM_listValues(), GM_getValue() and GM_deleteValue(). The idea is combining this feature with javascript redirections over a stored list of wiki articles to perform a series of semi-automatic edits (with preview and manual saving).
The buttons to access bot functions may be put in position:fixed in the bottom-left corner of each page.

Get user name dynamically

Get logged user name with api.php?action=query&meta=userinfo instead of writing it explicitly even if in the user.js file

Add "also in" translations for UpdateCategoryTree

Add translations of "also in" in UpdateCategoryTree

ArchWiki: change AUR direct links to template

Change direct links to AUR packages using Template:AUR.

Warn about common mistakes

Warn about common mistakes in the log:
"pacman -S", "yaourt", aur links, HTML comments and so on

This could be merged with #46

Modular structure

Split Core and the API in various modules

Warning banner when bot running

Display a banner in position:fixed at the top of the pages when a bot is running?

Common messages for talk pages

Editor: add common messages to talk pages like "please add a signature...", "please use the edit summary..." and so on.

Rename category

Rename a category, thus updating all its members to use the new name, not the redirect

Move documentation here from ArchWiki

Move documentation here from https://wiki.archlinux.org/index.php/User:Kynikos/Wiki_Monkey

Update the "help" link in the interface

Dynamically disable shortcut buttons

Dynamically disable the Execute row button when there is only one button in the row.
Dynamically disable the Execute all button when there is only one button in the page.

Category recursor engine

Isolate the category recursor engine from UpdateCategoryTree into a proper module

Expand contractions

Expand contractions like don't, you're...
Note that 's contractions must be previewed!

Bot: display number of selected articles

Bot: display number of selected articles

Script for relase operations

Python script for modifying configuration files in preparation of a release

Bot and categories

Bot operations in category pages

@version format (formerly "@updateURL doesn't work")

Make @updateURL work, better if with the .meta.js file

Ask in https://scriptish.lighthouseapp.com/ what are the required keys in the .meta.js file and (ask to) update the upstream wiki with that info

Set buttons in pages separately

Instead of passing an argument directly to WM.main(), create WM.setEditorUI(rows) and WM.setDiffUI(rows) and call WM.main() at the end of the main script.
This way it will be easier in the future to add buttons to other pages.

Visit Scriptish's wiki

See Scriptish's wiki for the advanced features that were not available in Greasemonkey
https://github.com/scriptish/scriptish/wiki

https://github.com/scriptish/scriptish/wiki/Manual%3A-API
https://github.com/scriptish/scriptish/wiki/GM_xmlhttpRequest

Use fieldset

Keep buttons and log in a fieldset

Fix more common html tags

For example <br>, <hr>, <i>, <b>

Complete wiki documentation

Complete wiki documentation:

• ------Bot interface------ done
• ------Custom configuration: update and expand------ done
• ------(Plugin pages): create Configuration sections to explain the parameters------ done
• Plugin development: update and expand

Maintain interlanguage links

Implement a user function that can keep all the interlanguage links for an article up-to-date among the various internal translations of the same article

Automatic maintenance of Table of Contents

Implement automatic periodic maintenance of the Table of Contents

Include modules from core

Include the modules from the core script, without the @require keys in the header of the .user.js script.

This will require JQuery unless I want to start messing with HTTP requests...

This will prevent Scriptish from caching the modules, which is probably bad...

MultipleLineBreaks removes useful line breaks

MultipleLineBreaks should be smart and avoid removing multiple line breaks in code templates.

This one is hard to fix because the function should parse the source text and understand when it's inside a template (or space-initial lines) or not.

Configurations are ArchWiki-specific

The current configurations contain ArchWiki-specific functions, and this should be reflected in their id and version number.

Note that this would break the updates for the current ids! A method for assisting the migration would be to display a warning to users still using the old name and point them to the installation link of the correct script.

Bot operations

Automatically execute functions over a series of articles taken from a list page (what links here, category...).
If the user doesn't have bot authorizations increase the interval time (edit rate)

Filter guide: each article in the list will be evaluated with each row in the text area, as regular expressions. If a line starts with "!" and the article matches, it will be excluded. For a literal "!" at the beginning of the line, escape it with "". The evaluations are made in a cascading way, so between two conflicting rules the last one prevails.

Disable other bots
Force start

Simple replace in editor

Finish writing the main() method for SimpleReplace

Use JSON

Don't be lazy and migrate all complex arrays to JSON.

Use JSON also for MediaWiki queries?

Recent changes helper

Bot-assisted functions for patrolling the recent changes with more ease and speed

Advanced filtering (replace the enhanced recent changes?)

Test bot on Sandbox

Option in bot for testing on Sandbox

It's necessary to define the sandbox page dynamically according to the visited wiki

An alternative would be to use the bot on the category that contains the sandbox (requires enabling the bot in category pages)