Template:Bot/doc

This is a documentation subpage for Template:Bot.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 2,100 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template is used by one or more bots.
If you intend to change this template in any significant way, move it, or nominate it for deletion, please inform the bot operators. Thank you. The relevant bots are: User:MajavahBot

Due to a server limit of 500 "expensive parser function" calls (e.g. #ifexist:, PAGESIZE:, and PAGESINCATEGORY:), this template will only work properly if the page using it has not already exceeded the limit. When the limit is exceeded, the page using this template or module is categorised in Category:Pages with too many expensive parser function calls. (further information)

{{Bot}} – An information box that indicates that the editor is not a human and actually an automatic process assigned to do menial tasks on Wikipedia.

Parameters

1: The first unnamed parameter specifies the operator of the bot.
2, 3: The second and third unnamed parameters can be used to specify co-operators of the bot, if required.
site: The two letter code for those operators that do not have an account on the English language Wikipedia (though having a local account is strongly recommended).
status: active (and approved), inactive (but approved), trial, unapproved, blocked, expired (previously approved but approval has lapsed), retired (previously approved but no longer editing, see also {{retired|bot=yes}})
awb: yes (if this bot uses AWB), or omit (if it doesn't).
codebase: The name of the code (programming or scripting language) used to create the bot (e.g., Pywikibot, perlWikipedia, ...)
brfa: Optional if specified, overrides the name of the request for approval. If not specified, defaults to {{BASEPAGENAME}}
by: Optional if specified, overrides the usual display of the operator's username in the first line generated from the three unnamed parameters.
approvalneeded: If status indicated active/approved, or globalbot, setting no will make the template indicate that the bot is running tasks for which no approval is needed.
overridebrfa: If the bot has multiple requests or approval, or multiple tasks, and the default BRFA link cannot link to a page that contains all the bot's approved requests or tasks, this field allows inputting a link to any Wikipedia page. Specifying this field overrides brfa.
more: Any additional information to specify in the mbox. Usually not needed, since |status=, |brfa=, and |approvalneeded= covers most cases.
alt: Optional alternate text for the image.
globalbot: If the bot is flagged globally.

Examples

Code Result

{{Bot|John Smith}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en|awb=yes}}

This user account is a bot that uses AutoWikiBrowser, operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy.
To stop this bot until restarted by the bot's owner, edit its talk page. Administrators: if this bot continues causing harm after receiving a message, please block it.

{{Bot|John Smith|site=en
|codebase=[[m:perlwikipedia|perlWikipedia]]}}

This user account is a bot that uses perlWikipedia, operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en|status=active}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot is approved and currently active.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en|status=trial}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot has been approved for a limited trial run by a member of the Bot Approvals Group.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en|status=inactive}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot is currently inactive but retains the approval of the community.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|site=en|status=unapproved}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot does not yet have the approval of the community, or approval has been withdrawn, and therefore shouldn't be making edits that appear to be unassisted except in the operator's or its own user and user talk space.
Administrators: if this bot is making edits that appear to be unassisted to pages not in the operator's or its own userspace, please block it.

{{Bot|John Smith|site=en
|status=active|globalbot=yes}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot is active and, by virtue of the fact that it is flagged globally, is permitted to maintain interwiki links per the global rights policy.
Administrators: if this bot is malfunctioning or causing harm, please block it.

{{Bot|John Smith|image=Crystal Clear question bot.svg
|more=The bot is undergoing testing.}}

This user account is a bot operated by John Smith (talk). It is used to make repetitive automated or semi-automated edits that would be extremely tedious to do manually, in accordance with the bot policy. The bot is undergoing testing.
Administrators: if this bot is malfunctioning or causing harm, please block it.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Bot in articles based on its TemplateData.

TemplateData for Bot

Generates a notice on a bot's userpage, giving information about its activity, codebase, and approval.

Template parameters
Parameter		Description	Type	Status
User 1	`1`	Username of the first editor who operates the bot. Automatically formatted with a talk link.	User	required
User site 1	`site`	Interwiki-prefix for the first user page. Default en	Line	optional
Unformatted user 1	`by`	An unformatted alternative to the first parameter, allowing you to use custom wikitext.	String	optional
Username 2	`2`	Username of the second editor who operates the bot. Automatically formatted with a talk link.	User	optional
User site 2	`site2`	Interwiki-prefix for the second user page. Default en	Line	optional
Unformatted user 2	`by2`	An unformatted alternative to the second parameter, allowing you to use custom wikitext.	String	optional
Operator 3	`3`	Username of the third editor who operates the bot	User	optional
User site 3	`site3`	Interwiki-prefix for the third user page. Default en	Line	optional
Unformatted user 3	`by3`	An unformatted alternative to the third parameter, allowing you to use custom wikitext.	String	optional
Talk page	`talklink`	Special user talk page for all of the operators. Example ExampleBOT	Page name	optional
Bot status	`status`	Status of the bot. Suggested values `active` `approved` `blocked` `expired` `inactive` `retired` `trial` `unapproved`	Line	required
Image	`image`	Image to display, rather than the gears icon. Example Example.svg	File	optional
Image caption	`caption`	Caption of the main image. Default This is a bot account.	Line	optional
Image alt text	`alt`	Alt text of the image.	String	optional
Codebase	`codebase`	The codebase on which the bot is powered. Example pywikibot	String	optional
BRfA subpage	`brfa`	The subpage name for the bot's BRfA. Default {{PAGENAME}}	Line	suggested
Username	`username`	The bot's username. Default {{PAGENAME}}	User	optional
AutoWikiBrowser?	`awb`	Whether or not the bot uses AutoWikiBrowser. Auto value `0`	Boolean	optional
GlobalBot?	`globalbot`	Whether or not the bot is a global bot. Auto value `0`	Boolean	optional
Approval needed?	`approvalneeded`	Whether the bot's actions require BAG approval. Auto value `1`	Boolean	optional
BRfA Override	`overridebrfa`	Page to link to instead of an BRfA, to list things like task-by-task approval or a local BRfA for a global bot.	Page name	optional
Extra text	`more`	Extra text to display after the status message.	String	optional
Suppress categories	`nocat`	Set to anything to prevent the template from applying categories.	String	optional
Show banner?	`banner`	Whether to show a banner around the status. Auto value `0`	Boolean	suggested
Banner image	`bannerimage` `statusimage`	Image to display on the left side of the banner, instead of the status icons.	File	optional
Banner styling	`bannerstyle` `statusstyle`	CSS styling for the status banner.	String	optional

This page was redesigned at the edge.

Template:Bot/doc

Parameters

Examples

TemplateData

See also