Difference between revisions of "Help:Bots"
(Undo revision 2435 by 5.135.165.126 (talk)) |
|||
| Line 1: | Line 1: | ||
| − | + | {{PD Help Page}} | |
| + | |||
| + | A '''bot''' is a computer program that automatically retrieves or updates wiki pages when it is executed. In general, bots are used for repetitive maintenance tasks, whose volume and characteristics are too large to be performed manually by users. | ||
| + | |||
| + | Developing and executing bots is normally outside the role of normal users, requires programming experience and must be done in coordination with the wiki's [[Help:Sysops and permissions|admins]]. | ||
| + | |||
| + | By default, bot edits are hidden in [[Special:RecentChanges|{{ns:special}}:{{MediaWiki:Recentchanges}}]]. | ||
| + | |||
| + | == Framework and interface for bot development == | ||
| + | Bots do not access the wiki through the normal graphical user interface. MediaWiki has an API (Application Programming Interface) available for this purpose. An API is a protocol for standardised communication between two computer programs. Check {{mediawiki|API:Client code}} for more information. | ||
| + | |||
| + | To access a wiki through the API a bot must have a user account, which has been granted 'bot' [[Help:Assigning permissions|permissions]]. | ||
| + | |||
| + | === pywikipediabot === | ||
| + | {{mediawiki|meta:pywikipediabot}} provides a framework for the development of bots, which are commonly used to perform maintenance tasks such as adding a footer to some categorized pages [[Pywikipediabot/add text.py|add_text.py]], adding some [[Help:Links|wikilinks]] ({{mediawiki|meta:pywikipediabot/replace.py|replace.py}}), moving old contents of [[Help:Talk pages|talk pages]] to [[Help:Subpages|subpages]] ({{mediawiki|meta:pywikipediabot/archivebot.py|archivebot.py}}), editing [[Help:Categories|categories]] ({{mediawiki|meta:pywikipediabot/category.py|category.py}}), or managing [[Help:Templates|templates]] ({{mediawiki|meta:pywikipediabot/template.py|template.py}}). | ||
| + | |||
| + | == The MassEditRegex extension == | ||
| + | [[:mw:Extension:MassEditRegex|Extension:MassEditRegex]] provides an alternative way to perform mass edits using regular expressions, through a special page in the wiki. Only admins can normally use this extension. | ||
| + | |||
| + | == See also == | ||
| + | * {{mediawiki|meta:Bot}} | ||
| + | |||
| + | {{Languages}} | ||
| + | |||
| + | [[Category:Help|{{PAGENAME}}]] | ||
Latest revision as of 11:52, 19 January 2017
|
{{{text}}}|Important note: When you edit this page, you agree to release your contribution into the public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the {{ #ifeq:
EEVblog Electronics Resource Wiki |
MediaWiki | Public Domain Help Pages | Public Domain Help Pages
}}, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. See {{ #ifeq: EEVblog Electronics Resource Wiki |
MediaWiki | Project:PD help/Copying | Project:PD help/Copying
}} for instructions.}} |
|
A bot is a computer program that automatically retrieves or updates wiki pages when it is executed. In general, bots are used for repetitive maintenance tasks, whose volume and characteristics are too large to be performed manually by users.
Developing and executing bots is normally outside the role of normal users, requires programming experience and must be done in coordination with the wiki's admins.
By default, bot edits are hidden in Special:Recent changes.
Contents
Framework and interface for bot development[edit]
Bots do not access the wiki through the normal graphical user interface. MediaWiki has an API (Application Programming Interface) available for this purpose. An API is a protocol for standardised communication between two computer programs. Check {{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | API:Client code | API:Client code }} for more information.
To access a wiki through the API a bot must have a user account, which has been granted 'bot' permissions.
pywikipediabot[edit]
{{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | meta:pywikipediabot | meta:pywikipediabot }} provides a framework for the development of bots, which are commonly used to perform maintenance tasks such as adding a footer to some categorized pages add_text.py, adding some wikilinks ({{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | replace.py | replace.py }}), moving old contents of talk pages to subpages ({{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | archivebot.py | archivebot.py }}), editing categories ({{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | category.py | category.py }}), or managing templates ({{ #ifeq:
EEVblog Electronics Resource Wiki
| MediaWiki | template.py | template.py }}).
The MassEditRegex extension[edit]
Extension:MassEditRegex provides an alternative way to perform mass edits using regular expressions, through a special page in the wiki. Only admins can normally use this extension.
See also[edit]
- {{ #ifeq:
EEVblog Electronics Resource Wiki
