Editing Template:Infobox Discord server/doc

This infobox is for use on articles about [[:Category:Discord servers|Discord servers]].

== Configuration ==
Here is a blank instance of this template with all of the most common 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    =
| 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. -->
}}
</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
| nocargo    = 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]]
}}
</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>
{
	"params": {
		"name": {
			"description": "The name of the server. You don't need to enter anything unless their username is different from the name of the page.",
			"type": "string",
			"default": "{{PAGENAME}}"
		},
		"image": {
			"description": "An image to represent this server, such as its server icon",
			"example": "Sillytime space.gif",
			"type": "wiki-file-name",
			"suggested": true
		},
		"landscape": {},
		"image size": {
			"description": "Override the size of the image, in pixels",
			"type": "number"
		},
		"imagesize": {},
		"image_upright": {},
		"alt": {},
		"image caption": {},
		"caption": {
			"description": "A caption for the image",
			"type": "string"
		},
		"color": {
			"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",
			"default": "#0a5ba6"
		},
		"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. Will also be accessible from {{Server color}} and will be used on the subboxes for this server.",
			"type": "string",
			"default": "#ffffff"
		},
		"status": {
			"description": "The status of the server. Usually one of the following: active, inactive, deleted, nuked, archived, private.",
			"type": "string",
			"suggested": true,
			"suggestedvalues": [
				"active",
				"inactive",
				"deleted",
				"nuked",
				"archived",
				"private"
			]
		},
		"nocat": {
			"description": "Set this to \"yes\" to prevent this template from automatically adding page categories.",
			"type": "boolean"
		},
		"invite": {
			"description": "A permanent invite link to the server.",
			"type": "url",
			"suggested": true
		},
		"users": {
			"description": "Approximately the total number of members of the server.",
			"example": "15,000+",
			"suggested": true
		},
		"owner": {
			"description": "The current or last owner of the server.",
			"example": "Thumper#6970",
			"type": "string",
			"suggested": true
		},
		"links": {
			"description": "Miscellaneous links relating to the server (e.g. a link to their website if they have one)"
		},
		"founded": {
			"description": "The date the server was founded.",
			"example": "May 26, 2020",
			"type": "date",
			"suggested": true
		},
		"defunct": {
			"description": "The date the server was shut down, if applicable.",
			"example": "December 28, 2021",
			"type": "date",
			"suggested": true
		},
		"founder": {
			"description": "The original founder of the server.",
			"type": "string",
			"suggested": true
		},
		"id": {
			"description": "Discord's internal snowflake ID of the server.",
			"example": "501310750074077215",
			"type": "number",
			"suggested": true
		},
		"nocargo": {
			"description": "Set this to \"yes\" to prevent this template from adding to the Cargo database.",
			"type": "boolean"
		}
	},
	"description": "Infobox for use on articles about servers. None of the parameters are required.",
	"paramOrder": [
		"name",
		"image",
		"landscape",
		"image size",
		"imagesize",
		"image_upright",
		"alt",
		"image caption",
		"caption",
		"color",
		"text_color",
		"status",
		"invite",
		"id",
		"users",
		"owner",
		"links",
		"founded",
		"defunct",
		"founder",
		"nocat",
		"nocargo"
	],
	"format": "block"
}
</templatedata>
<includeonly>
[[Category:Infobox templates|Discord server]]
[[Category:Templates that store Cargo data]]
</includeonly>