Template:Bot
This user account is a bot without a bot flag. The bot is operated by Example.
| |
| This bot runs on Wikimedia Toolforge. Administrators: If this bot needs to be blocked due to a malfunction, please remember to disable autoblocks so that other WMF Toolforge bots are not affected. |
This template can be used to mark a user as a bot, and should be placed on the userpage of bot accounts.
Usage
[edit]In the simplest case, you need only add your username to the template: {{Bot|Username}}.
To provide more information, you should also use the |task= parameter and add the task your bot is working on. You can also add some more information with |info=. If your bot has got a bot flag, you should also set the parameter |flag=yes.
Use |hoster=labs to indicate that your bot runs on Toolforge, if applicable.
Parameters
[edit]TemplateData
[edit]Template to be placed on the User page of a bot to document the bot
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Operator username | 1 | The username of the operator of the bot without the User: prefix.
| Line | required |
| Description | info | Description of the bot (not displayed) | String | optional |
| Tasks | task | Description of the current task of the bot (is displayed) | Content | optional |
| Bot flag | flag | Can be set to 'no' or 'without' to indicate that the bot does not have the bot-flag. Otherwise the bot is assumed to have the bot-flag.
| Line | optional |
| Hosted at | hoster | Can be set to 'labs' or 'toolforge' to indicate that the bot is hosted on toolforge.org. Other values aren't displayed.
| Line | optional |
| Source code link | source source code | URL to the source code of the bot
| URL | suggested |
| License | license licence | Name of the license the bot's source code is subject to, SPDX License identifiers preferred
| Line | suggested |
| site | site | Interwiki prefix where the author may be contacted. | Line | optional |
| Second operator username | 2 | The username of the second operator of the bot without the User: prefix. | Line | optional |
| Third operator username | 3 | The username of the third operator of the bot without the User: prefix. | Line | optional |
| Source code language | language | The coding language the bot was coded in
| Line | optional |
| Framework used | framework | The framework the bot is using (e.g. pywikibot)
| Line | optional |
| Execution schedule | typerun type of execution | How often the bot runs
| Line | suggested |
| Bot account username | Name | The username of the bot. Defaults to the base name of the current page.
| Line | optional |
| operator (deprecated) | operator | Name of the bot's operator. **NOT FUNCTIONAL, DO NOT USE** | String | deprecated |
See also
[edit]- {{Bot/text}} — translatable text for this template
- {{User with Bot}} — for users responsible for bot accounts
- {{User bot master}} — as above
| The above documentation is transcluded from Template:Bot/doc (edit | history). Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) page. Please add categories to the /doc subpage. Subpages of this template. |