Template:Bot

From Wikidata
Jump to navigation Jump to search
Wikidata 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.
Documentation icon Template documentation[view · edit · history · purge ] [translate this template]

This template can be used to mark a user as a Bot. You should place it on the userpage of your bot.

Usage[edit]

In the easiest case, you only have to add your username to the template: {{Bot|<IntegrationBot>}}.

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 set the parameter |flag=yes.

Use |hoster=labs to indicate your bot runs on Toolforge.

Parameters[edit]

Template to be placed on the User page of a bot to document the bot.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
operator username1

The username of the operator of the bot without the User: prefix.

Linerequired
infoinfo

Description of the bot (not displayed).

Unknownoptional
tasktask

Description of the current task of the bot (is displayed).

Contentoptional
flagflag

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.

Lineoptional
hosterhoster

Can be set to 'labs' or 'toolforge' to indicate that the bot is hosted on toolforge.org. Other values aren't displayed.

Suggested values
toolforge
Lineoptional
sourcesource source code

URL to the source code of the bot.

URLsuggested
licenselicense licence

Name of the license of the bot source code.

Suggested values
MIT 3-Clause BSD bsd3 2-Clause BSD BSD2 FreeBSD ISC GPL LGPL AGPL Apache CC-BY CC-SA cc-by-sa public domain CC-0 Unlicense
Linesuggested
sitesite

Interwiki prefix where the author may be contacted.

Lineoptional
operator (deprecated)operator

Name of the bot's operator. **NOT FUNCTIONAL, DO NOT USE**

Stringdeprecated
second operator username2

The username of the second operator of the bot without the User: prefix.

Lineoptional
third operator username3

The username of the third operator of the bot without the User: prefix.

Lineoptional
languagelanguage

The coding language the bot was coded in

Suggested values
python php
Example
python
Stringoptional
frameworkframework

The framework the bot is using

Suggested values
pwb pwb-rewrite
Example
pwb
Stringoptional
type of executiontyperun type of execution

How often the bot runs.

Suggested values
continuous ondemand periodically
Example
continuous
Stringsuggested
bot usernameName

The username of the bot. Defaults to the base name of the current page.

Auto value
Current page's base name
Lineoptional

See also[edit]