Template:Infobox Discord server/doc: Difference between revisions
No edit summary |
|||
(5 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
== Configuration == | == Configuration == | ||
Here is a blank instance of this template with all parameters: | Here is a blank instance of this template with all of the most common parameters: | ||
<pre><nowiki> | <pre><nowiki> | ||
{{Infobox Discord server | {{Infobox Discord server | ||
Line 9: | Line 9: | ||
| image_size = <!-- Override the size of the image, in pixels --> | | image_size = <!-- Override the size of the image, in pixels --> | ||
| caption = | | caption = | ||
| color = <!-- The background color of the headings. Defaults to #0a5ba6. Must be a valid CSS color value. Will also be used on all subboxes for this server. --> | |||
| text_color = <!-- The text color for the headings. Defaults to white; change it if the background is a light color. Will also be used on all subboxes for this server. --> | |||
| status = <!-- Usually one of the following: active, inactive, deleted, nuked, archived, private --> | | status = <!-- Usually one of the following: active, inactive, deleted, nuked, archived, private --> | ||
| invite = | | invite = | ||
Line 34: | Line 36: | ||
| founder = [[Dkaih35]] | | founder = [[Dkaih35]] | ||
| nocat = yes | | nocat = yes | ||
| nocargo = yes | |||
}} | }} | ||
Line 46: | Line 49: | ||
| defunct = December 28, 2021 | | defunct = December 28, 2021 | ||
| founder = [[Dkaih35]] | | founder = [[Dkaih35]] | ||
}} | }} | ||
</nowiki></pre> | </nowiki></pre> | ||
Line 123: | Line 125: | ||
}, | }, | ||
"color": { | "color": { | ||
"description": "The background color of the headings. Must be a valid CSS color value.", | "description": "The background color of the headings. Must be a valid CSS color value. Will also be accessible from {{Server color}} and will be used on the subboxes for this server.", | ||
"type": "string", | "type": "string", | ||
"default": "#0a5ba6" | "default": "#0a5ba6" | ||
}, | }, | ||
"text_color": { | "text_color": { | ||
"description": "The color of the text of the headings. Defaults to white; change it to black if the headings are a very light color. Must be a valid CSS color value.", | "description": "The color of the text of the headings. Defaults to white; change it to black if the headings are a very light color. Must be a valid CSS color value. Will also be accessible from {{Server color}} and will be used on the subboxes for this server.", | ||
"type": "string", | "type": "string", | ||
"default": "#ffffff" | "default": "#ffffff" | ||
Line 134: | Line 136: | ||
"status": { | "status": { | ||
"description": "The status of the server. Usually one of the following: active, inactive, deleted, nuked, archived, private.", | "description": "The status of the server. Usually one of the following: active, inactive, deleted, nuked, archived, private.", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true, | ||
"suggestedvalues": [ | |||
"active", | |||
"inactive", | |||
"deleted", | |||
"nuked", | |||
"archived", | |||
"private" | |||
] | |||
}, | }, | ||
"nocat": { | "nocat": { | ||
"description": "Set this to \"yes\" to prevent this template from automatically adding page categories | "description": "Set this to \"yes\" to prevent this template from automatically adding page categories.", | ||
"type": "boolean" | "type": "boolean" | ||
}, | }, | ||
Line 179: | Line 188: | ||
}, | }, | ||
"id": { | "id": { | ||
"description": "Discord's internal | "description": "Discord's internal snowflake ID of the server.", | ||
"example": "501310750074077215", | "example": "501310750074077215", | ||
"type": "number", | "type": "number", | ||
"suggested": true | "suggested": true | ||
}, | |||
"nocargo": { | |||
"description": "Set this to \"yes\" to prevent this template from adding to the Cargo database.", | |||
"type": "boolean" | |||
} | } | ||
}, | }, | ||
Line 207: | Line 220: | ||
"defunct", | "defunct", | ||
"founder", | "founder", | ||
"nocat" | "nocat", | ||
"nocargo" | |||
], | ], | ||
"format": "block" | "format": "block" | ||
} | } | ||
</templatedata> | </templatedata> | ||
<includeonly> | <includeonly> | ||
[[Category:Infobox templates]] | [[Category:Infobox templates|Discord server]] | ||
[[Category:Templates that store Cargo data]] | |||
</includeonly> | </includeonly> |
Latest revision as of 07:51, 18 August 2023
This infobox is for use on articles about Discord servers.
Configuration[edit source]
Here is a blank instance of this template with all of the most common parameters:
{{Infobox Discord server | 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: Sillytime space.svg --> | image_size = <!-- Override the size of the image, in pixels --> | caption = | color = <!-- The background color of the headings. Defaults to #0a5ba6. Must be a valid CSS color value. Will also be used on all subboxes for this server. --> | text_color = <!-- The text color for the headings. Defaults to white; change it if the background is a light color. Will also be used on all subboxes for this server. --> | status = <!-- Usually one of the following: active, inactive, deleted, nuked, archived, private --> | invite = | id = | users = <!-- Approximately the total number of members of the server --> | owner = | links = <!-- Other links relating to the server, like if they have a website --> | founded = <!-- The date the server was founded --> | defunct = <!-- The date the server was shut down, if applicable --> | founder = | nocat = <!-- Set this to "yes" to prevent this template from automatically adding page categories. This shouldn't be used in most cirumstances. --> }}
Example[edit source]
Here is an example. The configured parameters are also listed.
Server info | |
---|---|
Status | Deleted |
ID | 710551456091996260 |
Owner | Thumper#6970 |
History | |
Founded | May 26, 2020 |
Defunct | December 28, 2021 |
Founder | Dkaih35 |
{{Infobox Discord server | image = Sillytime space.gif | image_size = 150 | id = 710551456091996260 | status = deleted | owner = [[Thumper]]#6970 | founded = May 26, 2020 | defunct = December 28, 2021 | founder = [[Dkaih35]] }}
"status" parameter[edit source]
The |status =
parameter has a special output when given certain inputs. It provides special formatting and automatically adds the page to a category.
Status | Explanation | Appearance | Category |
---|---|---|---|
active
|
The server is alive and well. | Active | Category:Active servers |
inactive
|
The server is still up, but sees very little activity. | Inactive | Category:Inactive servers |
deleted
|
The server no longer exists :( | Deleted | Category:Defunct servers |
nuked
|
The server was nuked and no longer exists. Essentially the same as "deleted" | Nuked | |
archived
|
The server still exists, but it is in a read-only state. | Archived | |
private
|
The server exists, but it is private. Only certain people can join. | Private | Category:Private servers |
(anything else) | text | Category:Discord servers |
TemplateData[edit source]
Infobox for use on articles about servers. None of the parameters are required.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | The name of the server. You don't need to enter anything unless their username is different from the name of the page.
| String | optional |
image | image | An image to represent this server, such as its server icon
| File | suggested |
landscape | landscape | no description | Unknown | optional |
image size | image size | Override the size of the image, in pixels | Number | optional |
imagesize | imagesize | no description | Unknown | optional |
image_upright | image_upright | no description | Unknown | optional |
alt | alt | no description | Unknown | optional |
image caption | image caption | no description | Unknown | optional |
caption | caption | A caption for the image | String | optional |
color | color | The background color of the headings. Must be a valid CSS color value. Will also be accessible from {{Server color}} and will be used on the subboxes for this server.
| String | optional |
text_color | text_color | The color of the text of the headings. Defaults to white; change it to black if the headings are a very light color. Must be a valid CSS color value. Will also be accessible from {{Server color}} and will be used on the subboxes for this server.
| String | optional |
status | status | The status of the server. Usually one of the following: active, inactive, deleted, nuked, archived, private.
| String | suggested |
invite | invite | A permanent invite link to the server. | URL | suggested |
id | id | Discord's internal snowflake ID of the server.
| Number | suggested |
users | users | Approximately the total number of members of the server.
| Unknown | suggested |
owner | owner | The current or last owner of the server.
| String | suggested |
links | links | Miscellaneous links relating to the server (e.g. a link to their website if they have one) | Unknown | optional |
founded | founded | The date the server was founded.
| Date | suggested |
defunct | defunct | The date the server was shut down, if applicable.
| Date | suggested |
founder | founder | The original founder of the server. | String | suggested |
nocat | nocat | Set this to "yes" to prevent this template from automatically adding page categories. | Boolean | optional |
nocargo | nocargo | Set this to "yes" to prevent this template from adding to the Cargo database. | Boolean | optional |