Template:Bot/doc

Template page

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


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 OODA WIKI (though having a local account is strongly recommended).
status
active (and approved), inactive (but approved), trial, unapproved, globalbot, 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, perlOODA WIKI, ...)
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 OODA WIKI 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.

Examples

Code Result
{{Bot|John Smith}}
{{Bot|John Smith|site=en}}
{{Bot|John Smith|site=en|awb=yes}}
{{Bot|John Smith|site=en
|codebase=[[m:perlOODA WIKI|perlOODA WIKI]]}}
{{Bot|John Smith|site=en|status=active}}
{{Bot|John Smith|site=en|status=trial}}
{{Bot|John Smith|site=en|status=inactive}}
{{Bot|John Smith|site=en|status=unapproved}}
{{Bot|John Smith|site=en
|status=active|globalbot=yes}}
{{Bot|John Smith|image=Crystal Clear question bot.svg
|more=The bot is undergoing testing.}}

See also

  • {{Bot2}}: An alternative visual style for {{Bot}} that makes the status more obvious and uses SVG icons
  • {{User bot owner|Botname}}: Userbox for bot owner's user pages
  • {{User OODA WIKI/Botop}}: Userbox for bot owner's user pages