Template:Bot/doc: Difference between revisions
Jump to navigation
Jump to search
Dat Hack3r (talk | contribs) (Created template documentation.) |
Dat Hack3r (talk | contribs) m (Adjusted link and reordered bot statuses.) |
||
| 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. | ||
| Line 8: | Line 8: | ||
{{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=inactive}} | |||
{{Bot|John Smith|status=inactive}} | |||
* {{Tlx|1=Bot|2=John Smith|3=status=unapproved}} | * {{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}} | ||
| 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 | ||
Revision as of 10:18, 3 December 2024
{{Bot}} generates an information box that indicates that the editor is not a human and actually 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. |by=, if specified, overrides the usual display of the operator's username in the first line generated from the first unnamed parameter.
{{Bot|John Smith}}
 | This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits. |
{{Bot|John Smith|by=owned by [[User:John Smith|]] ([[User talk:John Smith|talk]]) but run by the community}}
| This user account is a bot owned by John Smith (talk) but run by the community. It is not a sock puppet account, but rather an account for making automated or semi-automated edits. |
|status= specifies the status of the bot, which can be either active, inactive, unapproved (i.e., awaiting approval), denied, or retired.
{{Bot|John Smith|status=active}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
{{Bot|John Smith|status=inactive}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
{{Bot|John Smith|status=unapproved}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
{{Approval|approved}} to its talk page and replace this notice with {{Bot|John Smith|status=inactive}}. To deny approval to this bot, add {{Approval|denied}} to its talk page and replace this notice with {{Bot|John Smith|status=denied}}. |
{{Bot|John Smith|status=denied}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
{{Bot|John Smith|status=retired}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
If the bot is inactive or retired, |last_edited= can be specified to indicate when the bot's last automated edit was. Use the timestamp present in the bot's user contributions page.
{{Bot|John Smith|status=inactive|last_edited=00:00, January 01, 2000}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
{{Bot|John Smith|status=retired|last_edited=00:00, January 01, 2000}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits.
|
Any additional information can be specified using |more=.
{{Bot|John Smith|status=unapproved|more=The bot is undergoing testing.}}
| This user account is a bot operated by John Smith (talk). It is not a sock puppet account, but rather an account for making automated or semi-automated edits. The bot is undergoing testing.
{{Approval|approved}} to its talk page and replace this notice with {{Bot|John Smith|status=inactive|more=The bot is undergoing testing.}}. To deny approval to this bot, add {{Approval|denied}} to its talk page and replace this notice with {{Bot|John Smith|status=denied|more=The bot is undergoing testing.}}. |
TemplateData
This template generates an information box that indicates that the editor is not a human and actually an automatic process assigned to do automated tasks on this Wiki. All parameters are optional.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Bot operator | 1 | The operator of the bot; does not have to be specified if the operator of the bot does not have an account on this Wiki.
| User | suggested |
| Custom operator display | by | Overrides the usual display of the operator's username in the first line generated from parameter, "bot operator".
| String | optional |
| Bot status | status | The status of the bot, which can be either active, inactive, unapproved (i.e., awaiting approval), denied, or retired.
| String | suggested |
| Date and time of last automated edit | last_edited | Indicates when the bot's last automated edit was if the bot is inactive or retired. Use the timestamp present in the bot's contributions page.
| Date | optional |
| Additional information | more | Use to specify any additional information.
| String | optional |