Wikibooks:Bots/Unstable
From Wikibooks, the open-content textbooks collection
Bots are automated clients used to make repetitive edits to the wiki faster than a human would be able to perform. Bots must never be used to make controversial edits. This policy pertains to all bots, including those which do not have the bot flag.
Contents |
[edit] Bots
Bots should be given their own separate account, and should not share an account with a human operator. This is so that, in an emergency, the bot can be blocked from making harmful edits without having to block the bot operator as well. Bots should be easily identifiable as a bot, by doing one of the following things:
- Having the word "Bot", or something else similar, in the username.
- Adding something such as "Automated" or "Bot edit" to every edit summary.
- Adding information on the bot account's user page which clearly indicated that the account is a bot account, who the owner is, and how to stop the bot from editing (such as a "block" link to be used directly by admins).
The capabilities of a bot, or a partial list of them, should be easily available on the Bot's userpage, or on a page in the operators user space.
Bot operators are expected to be responsive to queries regarding their bots, especially where error reports are concerned. All edits made by the bot are the responsibility of the bot operator, and they will be expected to undo any damage caused by a malfunctioning bot.
Bots should always make proper use of the edit summary, to indicate what kinds of edits are being made.
[edit] Common problems
Bots must never contribute anonymously, and care should be taken to ensure that the bot does not accidentally log out during operation. If this occurs, the bot must cease editing. Bots contributing anonymously will be blocked on sight.
Wherever possible, a method of stopping the bot other than blocking it should be available - usually this is leaving a message on the bot's talk page. This is doubly important for automated bots, because their owner may not always be on hand to deal with problems. Malfunctioning bots will be blocked as required to limit disruption to the wiki if their operator is not immediately available to stop the bot. Once the problem is fixed, the bot will be unblocked to resume normal operation.
[edit] Semi-automated bots
Bots which have each edit verified by a human, or are operated by a human interactively, are called semi-automated. AWB is a common tool which is usually operated in a semi-automated fashion. These bots should be flagged if they have a demonstrated ability to flush non-bot edits out of the recent changes feed, even if they do so only intermittently. Semi-automated clients must not be used to perform controversial edits.
User scripts are not bots, and do not require approval or a bot flag. Semi-automated scripts which do not flood the RC feed do not need to be flagged.
[edit] Automated bots
Fully-automated bots do not have their edits verified by a human operator, and operate without supervision. Automated bots may operate continuously, and should be approved before they go into operation. Make a request at WB:RFP to ensure that the planned task is acceptable to the community. Bots will be flagged based on their ability to flush non-bot edits from the recent changes feed.
Automated bots which edit intermittently and do not flood the RC feed do not need to be flagged.
[edit] Getting a bot flag
The bot flag is simply a technical measure to keep bot edits from flushing non-bot edits out of the recent changes feed. Therefore, the bot flag is no big deal. Bots which are capable of flushing non-bot edits out of the recent changes feed should be flagged, even if they do so only intermittently.
Bot operators who anticipate that their bot will flush non-bot edits from the recent changes feed must request a bot flag, and throttle the bot to avoid doing so until the bot is flagged. Bots must not flood Special:RecentChanges while waiting for approval for a bot flag; edit at a low rate until the flag is applied.
Bots which perform a useful, non-controversial task without error will be flagged after proper operation is verified, and when
- Requested by the bot operator at WB:RFP, and if no objections to it are raised; or
- Requested by a patroller, rollbacker, admin or bureaucrat.
Only bureaucrats are able to grant or revoke the bot flag to a user account, and may do so at their discretion.
[edit] Current bots
These accounts are listed as bots. Some do not have the bot flag; flagged bots are listed here.
[edit] Bots available by request
These bots are active, and are available to perform edits upon request. Functionality is described on each bot's userpage.
