Template:Infobox bot/doc: Difference between revisions

From Irony Wiki
Jump to navigation Jump to search
No edit summary
(added template data)
Line 52: Line 52:
| invitelink = [https://discord.com/oauth2/authorize Invite]
| invitelink = [https://discord.com/oauth2/authorize Invite]
}}</nowiki></pre>
}}</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>

Revision as of 22:30, 22 August 2021

This infobox is for use on articles about bots.

Configuration

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

Here is an example using a made-up bot. The configured parameters are also listed.

Example bot
Bot info
Discord tagExample#0000
Discord ID753757823535677561
Command prefix&
OwnerExample User
Programming languageJavascript
Source codeGithub
Bot invite linkInvite
{{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

Infobox for use on articles about users. None of the parameters are required.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

The username of the bot. You don't need to enter anything unless their username is different from the name of the page.

Default
{{PAGENAME}}
Stringsuggested
imageimage

An image to represent this bot, such as their profile picture

Example
Trollface.svg
Filesuggested
Image sizeimage_size

Override the size of the image, in pixels

Numberoptional
captioncaption

A caption for the image

Stringoptional
Discord tagdiscordtag

The bot's Discord tag (User#0000)

Example
Doctor Penez#2914
Stringsuggested
Discord IDdiscordid

The bot's ID; a long string of numbers

Example
753757823535677561
Numbersuggested
Prefixprefix

The bot's command prefix

Example
&
Stringsuggested
Ownerowner

The user maintaining the bot

Stringsuggested
Programming Languagelanguage

The programming language the bot is programmed in

Stringoptional
Source codesourcecode

A link for the source code of the bot

Example
[https://github.com/User/Repository Github]
Numbersuggested
Invite linkinvitelink

The invite link for the bot

Example
[https://discord.com/oauth2/authorize Invite]
Stringsuggested