Template:Bot/doc: Difference between revisions
Dat Hack3r (talk | contribs) Created template documentation. |
Dat Hack3r (talk | contribs) m Forgot to add the arrows I add by convention. |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Tlx|Bot}} generates an information box that indicates that the editor is ''not'' a human and actually {{wp|Internet bot|an automatic process assigned to do automated tasks on this Wiki | {{Tlx|Bot}} generates an information box that indicates that the editor is ''not'' a human and actually {{wp|Internet bot|an automatic process assigned to do automated tasks}} on this Wiki. All parameters are optional. | ||
The first unnamed parameter specifies the operator of the bot; it does not have to be specified if the operator of the bot does not have an account on this Wiki. {{Para|by}}, if specified, overrides the usual display of the operator's username in the first line generated from the first unnamed parameter. | The first unnamed parameter specifies the operator of the bot; it does not have to be specified if the operator of the bot does not have an account on this Wiki. {{Para|by}}, if specified, overrides the usual display of the operator's username in the first line generated from the first unnamed parameter. | ||
* {{Tlx|Bot|John Smith}} | * {{Tlx|Bot|John Smith}} → | ||
{{Bot|John Smith}} | {{Bot|John Smith}} | ||
* {{Tlx|1=Bot|2=John Smith|3=by=owned by <nowiki>[[User:John Smith|]] ([[User talk:John Smith|talk]])</nowiki> but run by the community}} | * {{Tlx|1=Bot|2=John Smith|3=by=owned by <nowiki>[[User:John Smith|]] ([[User talk:John Smith|talk]])</nowiki> but run by the community}} → | ||
{{Bot|John Smith|by=owned by [[User:John Smith|John Smith]] ([[User talk:John Smith|talk]]) but run by the community}} | {{Bot|John Smith|by=owned by [[User:John Smith|John Smith]] ([[User talk:John Smith|talk]]) but run by the community}} | ||
{{Para|status}} specifies the status of the bot, which can be either <code>active</code>, <code>inactive | {{Para|status}} specifies the status of the bot, which can be either <code>active</code>, <code>inactive</code>, <code>unapproved</code> (i.e., awaiting approval), <code>denied</code>, or <code>retired</code>. | ||
* {{Tlx|1=Bot|2=John Smith|3=status=active}} | * {{Tlx|1=Bot|2=John Smith|3=status=active}} → | ||
{{Bot|John Smith|status=active}} | {{Bot|John Smith|status=active}} | ||
* {{Tlx|1=Bot|2=John Smith|3=status=unapproved}} | * {{Tlx|1=Bot|2=John Smith|3=status=inactive}} → | ||
{{Bot|John Smith|status=inactive}} | |||
* {{Tlx|1=Bot|2=John Smith|3=status=unapproved}} → | |||
{{Bot|John Smith|status=unapproved}} | {{Bot|John Smith|status=unapproved}} | ||
* {{Tlx|1=Bot|2=John Smith|3=status=denied}} → | |||
* {{Tlx|1=Bot|2=John Smith|3=status=denied}} | |||
{{Bot|John Smith|status=denied}} | {{Bot|John Smith|status=denied}} | ||
* {{Tlx|1=Bot|2=John Smith|3=status=retired}} | * {{Tlx|1=Bot|2=John Smith|3=status=retired}} → | ||
{{Bot|John Smith|status=retired}} | {{Bot|John Smith|status=retired}} | ||
If the bot is inactive or retired, {{para|last_edited}} can be specified to indicate when the bot's last automated edit was. Use the timestamp present in the bot's [[MW:Help:User contributions#Accessing a user contributions page|user contributions page]]. | If the bot is inactive or retired, {{para|last_edited}} can be specified to indicate when the bot's last automated edit was. Use the timestamp present in the bot's [[MW:Help:User contributions#Accessing a user contributions page|user contributions page]]. | ||
* {{Tlx|1=Bot|2=John Smith|3=status=inactive|4=last_edited=00:00, January 01, 2000}} | * {{Tlx|1=Bot|2=John Smith|3=status=inactive|4=last_edited=00:00, January 01, 2000}} → | ||
{{Bot|John Smith|status=inactive|last_edited=00:00, January 01, 2000}} | {{Bot|John Smith|status=inactive|last_edited=00:00, January 01, 2000}} | ||
* {{Tlx|1=Bot|2=John Smith|3=status=retired|4=last_edited=00:00, January 01, 2000}} | * {{Tlx|1=Bot|2=John Smith|3=status=retired|4=last_edited=00:00, January 01, 2000}} → | ||
{{Bot|John Smith|status=retired|last_edited=00:00, January 01, 2000}} | {{Bot|John Smith|status=retired|last_edited=00:00, January 01, 2000}} | ||
Any additional information can be specified using {{para|more}}. | Any additional information can be specified using {{para|more}}. | ||
* {{Tlx|1=Bot|2=John Smith|3=status=unapproved|4=more=The bot is undergoing testing.}} | * {{Tlx|1=Bot|2=John Smith|3=status=unapproved|4=more=The bot is undergoing testing.}} → | ||
{{Bot|John Smith|status=unapproved|more=The bot is undergoing testing.}} | {{Bot|John Smith|status=unapproved|more=The bot is undergoing testing.}} | ||
| Line 58: | Line 58: | ||
"status": { | "status": { | ||
"label": "Bot status", | "label": "Bot status", | ||
"description": "The status of the bot, which can be either active, inactive | "description": "The status of the bot, which can be either active, inactive, unapproved (i.e., awaiting approval), denied, or retired.", | ||
"example": "active", | "example": "active", | ||
"type": "string", | "type": "string", | ||
| Line 64: | Line 64: | ||
"active", | "active", | ||
"inactive", | "inactive", | ||
"unapproved", | "unapproved", | ||
"denied" | "denied", | ||
"retired" | |||
], | ], | ||
"suggested": true | "suggested": true | ||