Template:Infobox bot/doc: Difference between revisions
No edit summary |
No edit summary |
||
(5 intermediate revisions by one other user not shown) | |||
Line 5: | Line 5: | ||
<pre><nowiki> | <pre><nowiki> | ||
{{Infobox bot | {{Infobox bot | ||
| | | name = <!-- If this field is not provided, the page name will be used. --> | ||
| image = <!-- Just enter the file name. Do not include "File:" or any brackets. For example: Trollface.svg --> | | image = <!-- Just enter the file name. Do not include "File:" or any brackets. For example: Trollface.svg --> | ||
| caption | | image_size = | ||
| | | caption = | ||
| | | discordtag = | ||
| | | discordid = | ||
| | | prefix = | ||
| | | owner = | ||
| | | language = | ||
| | | sourcecode = | ||
| invitelink = | |||
}}</nowiki></pre> | }}</nowiki></pre> | ||
===Example=== | |||
Here is an example using a made-up bot. The configured parameters are also listed. | |||
{{Infobox bot | |||
| name = Example bot | |||
| image = Discord default pfp blurple.svg | |||
| image_size = 180px | |||
| caption = | |||
| discordtag = Example#0000 | |||
| discordid = 753757823535677561 | |||
| prefix = & | |||
| owner = [[Example User]] | |||
| language = Javascript | |||
| sourcecode = [https://github.com/User/Repository Github] | |||
| invitelink = [https://discord.com/oauth2/authorize Invite] | |||
}} | |||
<pre><nowiki> | |||
{{Infobox bot | |||
| name = Example bot | |||
| image = Discord default pfp blurple.svg | |||
| image_size = 180px | |||
| caption = | |||
| discordtag = Example#0000 | |||
| discordid = 753757823535677561 | |||
| prefix = & | |||
| owner = [[Example User]] | |||
| language = Javascript | |||
| sourcecode = [https://github.com/User/Repository Github] | |||
| invitelink = [https://discord.com/oauth2/authorize Invite] | |||
}}</nowiki></pre> | |||
=== Parameters === | |||
<templatedata> | |||
{ | |||
"params": { | |||
"name": { | |||
"description": "The username of the bot. You don't need to enter anything unless their username is different from the name of the page.", | |||
"type": "string", | |||
"suggested": true, | |||
"default": "{{PAGENAME}}" | |||
}, | |||
"image": { | |||
"description": "An image to represent this bot, such as their profile picture", | |||
"example": "Trollface.svg", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"image_size": { | |||
"description": "Override the size of the image, in pixels", | |||
"type": "number", | |||
"label": "Image size" | |||
}, | |||
"caption": { | |||
"description": "A caption for the image", | |||
"type": "string" | |||
}, | |||
"discordtag": { | |||
"description": "The bot's Discord tag (User#0000)", | |||
"example": "Doctor Penez#2914", | |||
"type": "string", | |||
"label": "Discord tag", | |||
"suggested": true | |||
}, | |||
"discordid": { | |||
"description": "The bot's ID; a long string of numbers", | |||
"example": "753757823535677561", | |||
"type": "number", | |||
"label": "Discord ID", | |||
"suggested": true | |||
}, | |||
"prefix": { | |||
"description": "The bot's command prefix", | |||
"example": "&", | |||
"type": "string", | |||
"label": "Prefix", | |||
"suggested": true | |||
}, | |||
"owner": { | |||
"description": "The user maintaining the bot", | |||
"type": "string", | |||
"label": "Owner", | |||
"suggested": true | |||
}, | |||
"language": { | |||
"description": "The programming language the bot is programmed in", | |||
"type": "string", | |||
"label": "Programming Language" | |||
}, | |||
"sourcecode": { | |||
"description": "A link for the source code of the bot", | |||
"example": "[https://github.com/User/Repository Github]", | |||
"type": "number", | |||
"label": "Source code", | |||
"suggested": true | |||
}, | |||
"invitelink": { | |||
"description": "The invite link for the bot", | |||
"example": "[https://discord.com/oauth2/authorize Invite]", | |||
"type": "string", | |||
"label": "Invite link", | |||
"suggested": true | |||
} | |||
}, | |||
"description": "Infobox for use on articles about users. None of the parameters are required.", | |||
"paramOrder": [ | |||
"name", | |||
"image", | |||
"image_size", | |||
"caption", | |||
"discordtag", | |||
"discordid", | |||
"prefix", | |||
"owner", | |||
"language", | |||
"sourcecode", | |||
"invitelink" | |||
], | |||
"format": "block" | |||
} | |||
</templatedata> | |||
<includeonly> | |||
[[Category:Infobox templates|bot]] | |||
</includeonly> |
Latest revision as of 07:52, 18 August 2023
This infobox is for use on articles about bots.
Configuration[edit source]
Here is a configuration of this template with all parameters:
{{Infobox bot | name = <!-- If this field is not provided, the page name will be used. --> | image = <!-- Just enter the file name. Do not include "File:" or any brackets. For example: Trollface.svg --> | image_size = | caption = | discordtag = | discordid = | prefix = | owner = | language = | sourcecode = | invitelink = }}
Example[edit source]
Here is an example using a made-up bot. The configured parameters are also listed.
Bot info | |
---|---|
Discord tag | Example#0000 |
Discord ID | 753757823535677561 |
Command prefix | & |
Owner | Example User |
Programming language | Javascript |
Source code | Github |
Bot invite link | Invite |
{{Infobox bot | name = Example bot | image = Discord default pfp blurple.svg | image_size = 180px | caption = | discordtag = Example#0000 | discordid = 753757823535677561 | prefix = & | owner = [[Example User]] | language = Javascript | sourcecode = [https://github.com/User/Repository Github] | invitelink = [https://discord.com/oauth2/authorize Invite] }}
Parameters[edit source]
Infobox for use on articles about users. None of the parameters are required.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | The username of the bot. You don't need to enter anything unless their username is different from the name of the page.
| String | suggested |
image | image | An image to represent this bot, such as their profile picture
| File | suggested |
Image size | image_size | Override the size of the image, in pixels | Number | optional |
caption | caption | A caption for the image | String | optional |
Discord tag | discordtag | The bot's Discord tag (User#0000)
| String | suggested |
Discord ID | discordid | The bot's ID; a long string of numbers
| Number | suggested |
Prefix | prefix | The bot's command prefix
| String | suggested |
Owner | owner | The user maintaining the bot | String | suggested |
Programming Language | language | The programming language the bot is programmed in | String | optional |
Source code | sourcecode | A link for the source code of the bot
| Number | suggested |
Invite link | invitelink | The invite link for the bot
| String | suggested |