Difference between revisions of "Template:Bot/doc"

From blackwiki
Jump to navigation Jump to search
imported>Dispenser
(Conformance with WP:DOC using AWB)
imported>Majavah
({{Bot use warning|bots=User:MajavahBot}} per task 3)
 
(70 intermediate revisions by 43 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
 
<!--
 
<!--
 
     PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
 
     PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
 
-->
 
-->
{{tl|{{lcfirst:{{PAGENAME}}}}}} &mdash; An information box indication a user as a bot
+
{{Bot use warning|bots=[[User:MajavahBot]]}}
 +
{{distinguish|Template:Bots}}
 +
{{Tlb|{{lcfirst:{{BASEPAGENAME}}}}}}&nbsp;An information box that indicates that the editor is ''not'' a human and actually [[Wikipedia:Bots|an automatic process assigned to do menial tasks on Wikipedia]].
  
 
<!-- explain what this template does; use it in a sentence -->
 
<!-- explain what this template does; use it in a sentence -->
Line 9: Line 12:
 
== Parameters ==
 
== Parameters ==
 
; 1 : The first unnamed parameter specifies the operator of the bot.
 
; 1 : The first unnamed parameter specifies the operator of the bot.
; site : The two letter code for those operators that do not have an account on the English language Wikipedia.
+
; 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'', ''globalbot'', ''expired'' (previously approved but approval has lapsed), ''retired'' (previously approved but no longer editing, see also {<nowiki />{[[Template:retired|retired]]|bot=yes}})
 +
; awb : ''yes'' (if this bot uses [[Wikipedia:AWB|AWB]]), or omit (if it doesn't).
 +
; codebase: The name of the code (programming or scripting language) used to create the bot (e.g., [[mw:Pywikibot|Pywikibot]], [[m:perlwikipedia|perlWikipedia]], ...)
 +
; brfa : ''Optional'' if specified, overrides the name of the request for approval. If not specified, defaults to <nowiki>{{BASEPAGENAME}}</nowiki>
 +
; 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 <kbd>yes</kbd> 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 {{para|status}}, {{para|brfa}}, and {{para|approvalneeded}} covers most cases.
 +
; alt : Optional alternate text for the image.
  
== Example ==
+
== Examples ==
 
<!-- for the documentation don't subst the result -->
 
<!-- for the documentation don't subst the result -->
{| {{easytable}}
+
{| class="wikitable mbox-inside"
! Code
+
|-
! Result
+
! Code
 +
! Result
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|John Smith}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en|awb=yes</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en|awb=yes|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en</nowiki><br /><nowiki>|codebase=[[m:perlwikipedia|perlWikipedia]]</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en |codebase=[[m:perlwikipedia|perlWikipedia]]|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en|status=active</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en|status=active|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en|status=trial</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en|status=trial|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en|status=inactive</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|site=en|status=inactive|nocat=}}
 
|-
 
|-
| valign="top" | <code>{{tlp|{{PAGENAME}}|John Smith}}</code>
+
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en|status=unapproved</nowiki>}}</code>
 
|
 
|
{{msg:{{BASEPAGENAME}}|John Smith}}
+
{{ {{BASEPAGENAME}}|John Smith|site=en|status=unapproved|nocat=}}
 
|-
 
|-
| valign="top" | <code>{{tlp|{{PAGENAME}}|<nowiki>John Smith|site=en</nowiki>}}</code>
+
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|site=en</nowiki><br /><nowiki>|status=active|globalbot=yes</nowiki>}}</code>
 
|
 
|
{{msg:{{BASEPAGENAME}}|John Smith|site=en}}
+
{{ {{BASEPAGENAME}}|John Smith|site=en|status=active|globalbot=yes|nocat=}}
 +
|-
 +
| <code>{{tlp|{{BASEPAGENAME}}|<nowiki>John Smith|image=Crystal Clear question bot.svg</nowiki><br /><nowiki>|more=The bot is undergoing testing.</nowiki>}}</code>
 +
|
 +
{{ {{BASEPAGENAME}}|John Smith|image=Crystal Clear question bot.svg|more=The bot is undergoing testing.|nocat=}}
 
|}
 
|}
  
== See also ==
+
==See also==
*{{lt|AWB bot}}
+
*{{tl|Bot2}}: An alternative visual style for {{tl|Bot}} that makes the status more obvious and uses SVG icons
 
+
*<nowiki>{{</nowiki>[[:Template:User bot owner|User bot owner]]|''Botname''<nowiki>}}</nowiki>: Userbox for bot owner's user pages
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
*{{tl|User wikipedia/Botop}}: Userbox for bot owner's user pages
 
 
[[Category:Wikipedia bots| ]]
 
  
[[af:Sjabloon:Bot]]
+
<includeonly>{{Sandbox other||<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[ak:Template:Bot]]
+
[[Category:Wikipedia bot-related templates| ]]
[[ab:Шаблон:Bot]]
+
<!--[[it:Template:Bot]]-->
[[ar:قالب:بوت]]
+
}}</includeonly>
[[roa-rup:Template:Bot]]
 
[[as:Template:Bot]]
 
[[ast:Plantía:Bot]]
 
[[gn:Plantilla:Bot]]
 
[[av:Шаблон:Bot]]
 
[[ay:Plantilla:Bot]]
 
[[az:Şablon:Bot]]
 
[[ba:Ҡалып:Bot]]
 
[[be:Шаблон:Bot]]
 
[[bi:Template:Bot]]
 
[[bo:Template:Bot]]
 
[[br:Patrom:Bot]]
 
[[bxr:Template:Bot]]
 
[[ca:Plantilla:Bot]]
 
[[cv:Шаблон:Bot]]
 
[[cs:Šablona:Bot]]
 
[[ch:Template:Bot]]
 
[[ny:Template:Bot]]
 
[[sn:Template:Bot]]
 
[[tum:Template:Bot]]
 
[[za:Template:Bot]]
 
[[da:Skabelon:Bot]]
 
[[nv:Template:Bot]]
 
[[dsb:Pśedłoga:Bot]]
 
[[dz:Template:Bot]]
 
[[et:Mall:Bot]]
 
[[eml:Template:Bot]]
 
[[en:Template:Bot]]
 
[[es:Plantilla:Bot]]
 
[[eu:Txantiloi:Bot]]
 
[[ee:Template:Bot]]
 
[[fa:الگو:ربات]]
 
[[fr:Modèle:Bot]]
 
[[ff:Modèle:Bot]]
 
[[ga:Teimpléad:Bot]]
 
[[gl:Modelo:Bot]]
 
[[gl:Template:Bot]]
 
[[ki:Template:Bot]]
 
[[glk:الگو:Bot]]
 
[[xal:Зура:Bot]]
 
[[ko:틀:봇]]
 
[[ha:Template:Bot]]
 
[[haw:Template:Bot]]
 
[[hy:Կաղապար:Bot]]
 
[[hsb:Předłoha:Bot]]
 
[[io:Template:Roboto]]
 
[[io:Shablono:Roboto]]
 
[[ig:Template:Bot]]
 
[[id:Templat:Bot]]
 
[[ia:Patrono:Bot]]
 
[[iu:Template:Bot]]
 
[[ik:Template:Bot]]
 
[[xh:Template:Bot]]
 
[[zu:Template:Bot]]
 
[[is:Snið:Vélmenni]]
 
[[it:Template:Bot]]
 
[[he:תבנית:בוט]]
 
[[kl:Template:Bot]]
 
[[kk:Үлгі:Bot]]
 
[[rw:Template:Bot]]
 
[[ky:Template:Bot]]
 
[[kv:Шаблон:Bot]]
 
[[ku:Şablon:Bot]]
 
[[lo:Template:Bot]]
 
[[lv:Veidne:Bot]]
 
[[lt:Šablonas:Botas]]
 
[[lg:Template:Bot]]
 
[[lmo:Template:Bot]]
 
[[hu:Sablon:Bot]]
 
[[mg:Modèle:Bot]]
 
[[ml:ഫലകം:യന്ത്രം]]
 
[[mi:Template:Bot]]
 
[[mzn:الگو:Bot]]
 
[[ms:Templat:Bot]]
 
[[cdo:Template:Bot]]
 
[[my:Template:Bot]]
 
[[fj:Template:Bot]]
 
[[nl:Sjabloon:Bot]]
 
[[cr:Template:Bot]]
 
[[ne:Template:Bot]]
 
[[ja:Template:Bot]]
 
[[ce:Дакъа:Bot]]
 
[[pih:Template:Bot]]
 
[[no:Mal:Bot]]
 
[[nn:Mal:Bot]]
 
[[om:Template:Bot]]
 
[[ng:Template:Bot]]
 
[[ug:Template:Bot]]
 
[[uz:Shablon:Bot]]
 
[[pa:ਨਮੂਨਾ:Bot]]
 
[[pap:Template:Bot]]
 
[[pms:Stamp:Trigomiro]]
 
[[pl:Szablon:Bot]]
 
[[pt:Predefinição:Bot]]
 
[[crh:Şablon:Bot]]
 
[[ru:Шаблон:Bot]]
 
[[sm:Template:Bot]]
 
[[sg:Template:Bot]]
 
[[sco:Template:Bot]]
 
[[st:Template:Bot]]
 
[[tn:Template:Bot]]
 
[[sq:Stampa:Bot]]
 
[[scn:Template:Bot]]
 
[[si:Template:Bot]]
 
[[simple:Template:Bot]]
 
[[sd:Template:Bot]]
 
[[ss:Template:Bot]]
 
[[sk:Šablóna:Bot]]
 
[[cu:Образьць:Bot]]
 
[[sl:Predloga:Bot page]]
 
[[so:Template:Bot]]
 
[[sh:Template:Bot]]
 
[[fi:Malline:Bot]]
 
[[sv:Mall:Bot]]
 
[[tl:Template:Bot]]
 
[[ta:வார்ப்புரு:தானியங்கி]]
 
[[tt:Ürnäk:Bot]]
 
[[te:మూస:Bot]]
 
[[tet:Template:Bot]]
 
[[th:แม่แบบ:Bot]]
 
[[ti:Template:Bot]]
 
[[chr:Template:Bot]]
 
[[chy:Template:Bot]]
 
[[ve:Template:Bot]]
 
[[tr:Şablon:Bot]]
 
[[tk:Template:Bot]]
 
[[tw:Template:Bot]]
 
[[bug:Templat:Bot]]
 
[[vec:Template:Bot]]
 
[[vo:Samafomot:Bot]]
 
[[wuu:Template:Bot]]
 
[[ts:Template:Bot]]
 
[[zh-yue:Template:Bot]]
 
[[cbk-zam:Plantilla:Bot]]
 
[[zea:Sjabloon:Bot]]
 
[[bat-smg:Šabluons:Bot]]
 
[[zh:Template:Bot]]
 
</includeonly>
 

Latest revision as of 15:19, 13 October 2020

{{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

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, globalbot, 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 yes 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.

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:perlwikipedia|perlWikipedia]]}}
{{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 wikipedia/Botop}}: Userbox for bot owner's user pages