Difference between revisions of "Help:Bots"
m (1 revision: upload local mediawiki help files) |
m (1 revision: Uploading local help documentation from mediawiki.org) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{PD Help Page}} |
{{PD Help Page}} |
||
| − | ==Running your own bot== |
||
| − | *{{mediawiki|meta:pywikipediabot}} |
||
| − | :''For what use?'' E.g. add a footer to some categorized pages,<ref>{{mediawiki|meta:pywikipediabot/add_text.py|add_text.py}}</ref> add some wikilinks,<ref>{{mediawiki|meta:pywikipediabot/replace.py|replace.py}}</ref> archive in moving old talk to subpages,<ref>{{mediawiki|meta:pywikipediabot/archivebot.py|archivebot.py}}</ref> edit categories,<ref>{{mediawiki|meta:pywikipediabot/category.py|category.py}}</ref> manage templates.<ref>{{mediawiki|meta:pywikipediabot/template.py|template.py}}</ref> |
||
| − | :::{| style="font-color:#535068; border:solid 0px #A8A8A8; background-color:#FFFFFF;font-size:75%;" |
||
| + | 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. |
||
| − | |[[File:Crystal Clear action run.png|40px]] |
||
| − | |<tt><references/></tt> |
||
| − | |} |
||
| − | === Frameworks and interfaces for bot development === |
||
| + | 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]]. |
||
| − | :''See '''{{mediawiki|API:Client Code}}''''' |
||
| + | |||
| − | MediaWiki {{mediawiki|API}} is for convenient access to machine-readable data. |
||
| + | 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 ({{mediawiki|meta: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 == |
== See also == |
||
* {{mediawiki|meta:Bot}} |
* {{mediawiki|meta:Bot}} |
||
| − | |||
| − | {{Admin tip|tip=<br> |
||
| − | *{{mediawiki|Manual:User rights management}} for setting bot access. |
||
| − | *{{mediawiki|Manual:robots.txt|robots.txt}} tells external web robots how to index your site. |
||
| − | *{{mediawiki|Extension:MassEditRegex}} - to allow regular expression edits through a special page. |
||
| − | }} |
||
{{Languages}} |
{{Languages}} |
||
Latest revision as of 13:43, 3 July 2010
| PD | 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 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 Project:PD help/Copying for instructions. | PD |
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
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 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
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 (replace.py), moving old contents of talk pages to subpages (archivebot.py), editing categories (category.py), or managing templates (template.py).
The MassEditRegex extension
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
| Language: | English |
|---|
