Template:Infobox Discord server/doc: Difference between revisions
start documentation |
expand |
||
| Line 1: | Line 1: | ||
This infobox is for use on articles about [[:Category:Discord servers|Discord servers]]. | This infobox is for use on articles about [[:Category:Discord servers|Discord servers]]. | ||
== Configuration == | |||
Here is a blank instance of this template with all parameters: | |||
<pre><nowiki> | |||
{{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 = | |||
| 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. --> | |||
}} | |||
</nowiki></pre> | |||
== Example == | |||
Here is an example. The configured parameters are also listed. | |||
{{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]] | |||
| nocat = yes | |||
}} | |||
<pre><nowiki> | |||
{{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]] | |||
| nocat = yes | |||
}} | |||
</nowiki></pre> | |||
== "status" parameter == | |||
The <code>|status =</code> parameter has a special output when given certain inputs. It provides special formatting and automatically adds the page to a category. | |||
{| class="wikitable" | |||
|+ | |||
!Status | |||
!Explanation | |||
!Appearance | |||
!Category | |||
|- | |||
|<code>active</code> | |||
|The server is alive and well. | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #00dd00;"></span> Active</span> | |||
|[[:Category:Active servers]] | |||
|- | |||
|<code>inactive</code> | |||
|The server is still up, but sees very little activity. | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #ffc000;"></span> Inactive</span> | |||
|[[:Category:Inactive servers]] | |||
|- | |||
|<code>deleted</code> | |||
|The server no longer exists :( | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #dc0000;"></span> Deleted</span> | |||
| rowspan="3" |[[:Category:Defunct servers]] | |||
|- | |||
|<code>nuked</code> | |||
|The server was nuked and no longer exists. Essentially the same as "deleted" | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #dc0000;"></span> Nuked</span> | |||
|- | |||
|<code>archived</code> | |||
|The server still exists, but it is in a read-only state. | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #b9bbbe;"></span> Archived</span> | |||
|- | |||
|<code>private</code> | |||
|The server exists, but it is private. Only certain people can join. | |||
|<span style="box-sizing: border-box; display: inline-flex; vertical-align: middle; align-items: center;"><span style="width: 0.75em; height: 0.75em; margin-right: 4px; border-radius: 50%; background-color: #b9bbbe;"></span> Private</span> | |||
|[[:Category:Private servers]] | |||
|- | |||
|(anything else) | |||
| | |||
|text | |||
|[[:Category:Discord servers]] | |||
|} | |||
== TemplateData == | == TemplateData == | ||
| Line 103: | Line 196: | ||
"image caption", | "image caption", | ||
"caption", | "caption", | ||
"color", | "color", | ||
"text_color", | "text_color", | ||
"status", | "status", | ||
"invite", | "invite", | ||
"id", | |||
"users", | "users", | ||
"owner", | "owner", | ||
Revision as of 06:23, 11 July 2022
This infobox is for use on articles about Discord servers.
Configuration
Here is a blank instance of this template with all 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 =
| 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
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]]
| nocat = yes
}}
"status" parameter
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
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.
| 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.
| 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 18-digit 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. This shouldn't be used in most cirumstances. | Boolean | optional |