Template:Infobox Discord server/doc: Difference between revisions

no edit summary
(start documentation)
 
No edit summary
 
(7 intermediate revisions by the same user not shown)
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 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 ==
Line 30: 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 41: 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.",
"example": "active",
"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. This shouldn't be used in most cirumstances.",
"description": "Set this to \"yes\" to prevent this template from automatically adding page categories.",
"type": "boolean"
"type": "boolean"
},
},
Line 86: Line 188:
},
},
"id": {
"id": {
"description": "Discord's internal 18-digit ID of the server.",
"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 103: Line 209:
"image caption",
"image caption",
"caption",
"caption",
"id",
"color",
"color",
"text_color",
"text_color",
"status",
"status",
"invite",
"invite",
"id",
"users",
"users",
"owner",
"owner",
Line 114: 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>