Template:Infobox bot/doc: Difference between revisions
No edit summary |
No edit summary |
||
(4 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
This infobox is for use on articles about bots. | This infobox is for use on articles about bots. | ||
Line 7: | Line 5: | ||
<pre><nowiki> | <pre><nowiki> | ||
{{Infobox bot | {{Infobox bot | ||
| | | name = <!-- If this field is not provided, the page name will be used. --> | ||
| image | | image = <!-- Just enter the file name. Do not include "File:" or any brackets. For example: Trollface.svg --> | ||
| caption | | image_size = | ||
| | | caption = | ||
| | | discordtag = | ||
| | | discordid = | ||
| owner | | prefix = | ||
| language | | owner = | ||
| | | language = | ||
| invitelink | | sourcecode = | ||
| invitelink = | |||
}}</nowiki></pre> | }}</nowiki></pre> | ||
===Example=== | ===Example=== | ||
Here is an example using a made-up | Here is an example using a made-up bot. The configured parameters are also listed. | ||
{{Infobox bot | {{Infobox bot | ||
| | | name = Example bot | ||
| image | | image = Discord default pfp blurple.svg | ||
| caption | | image_size = 180px | ||
| | | caption = | ||
| | | discordtag = Example#0000 | ||
| | | discordid = 753757823535677561 | ||
| owner | | prefix = & | ||
| language = | | owner = [[Example User]] | ||
| | | language = Javascript | ||
| invitelink | | 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> |