Template:Infobox game server/doc: Difference between revisions

From Irony Wiki
Jump to navigation Jump to search
(list parameters)
 
(improve documentation)
Line 1: Line 1:
This infobox is for use on articles about video game servers.
== Configuration ==
Here is a blank instance of this template with all parameters:
<pre><nowiki>
<pre><nowiki>
{{Infobox game server
{{Infobox game server
Line 5: Line 9:
| image_size = <!-- Override the size of the image, in pixels -->
| image_size = <!-- Override the size of the image, in pixels -->
| caption    =
| caption    =
| status    = <!-- Usually one of the following: active, inactive, defunct, private -->
| game      =
| game      =
| ip        =
| ip        =
Line 13: Line 18:
| links      =
| links      =
}}</nowiki></pre>
}}</nowiki></pre>
== "status" parameter ==
The <code>|status =</code> parameter has a special output that provides special formatting when given certain inputs.
{| class="wikitable"
|+
!Status
!Explanation
!Appearance
|-
|<code>active</code>
|The server is operational and has an active playerbase.
|<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>
|-
|<code>inactive</code>
|The server is operational, but does not have an active playerbase.
|<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>
|-
|<code>defunct</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> Defunct</span>
|-
|<code>private</code>
|The server is operational, 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>
|-
|(anything else)
|
|text
|}
== TemplateData ==
<templatedata>
{
"params": {
"name": {
"description": "The name of the server. You don't need to enter anything unless the name is different from the name of the page.",
"type": "string",
"default": "{{PAGENAME}}",
"suggested": true
},
"image": {
"description": "An image to represent this server, such as an icon or a screenshot.",
"type": "wiki-file-name",
"suggested": true
},
"landscape": {},
"image size": {
"description": "Override the size of the image, in pixels",
"type": "number"
},
"imagesize": {},
"image_upright": {},
"alt": {
"description": "Alt text for the image"
},
"image caption": {},
"caption": {
"description": "A caption for the image"
},
"status": {
"description": "The status of the server.",
"example": "active",
"type": "string",
"suggestedvalues": [
"active",
"inactive",
"defunct",
"private"
],
"suggested": true
},
"game": {
"description": "The video game that this server is for.",
"example": "{{w|Minecraft}}",
"type": "string",
"suggested": true
},
"ip": {
"description": "The IP address used to connect to this server.",
"type": "string",
"suggested": true
},
"version": {
"description": "The version of the game this server is running.",
"example": "Java Edition 1.20.1",
"type": "string",
"suggested": true
},
"gamemods": {
"description": "Any mods that the server requires the player to have installed.",
"type": "unknown"
},
"owner": {
"description": "The owner(s) of the server.",
"type": "string",
"suggested": true
},
"moderators": {
"description": "The moderator(s) of the server.",
"type": "string",
"suggested": true
},
"links": {
"description": "Any links relating to this server."
}
},
"description": "Infobox for use on articles about video game servers. None of the parameters are required.",
"format": "block"
}
</templatedata>

Revision as of 04:55, 13 July 2023

This infobox is for use on articles about video game servers.

Configuration

Here is a blank instance of this template with all parameters:

{{Infobox game 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: Trollface.svg -->
| image_size = <!-- Override the size of the image, in pixels -->
| caption    =
| status     = <!-- Usually one of the following: active, inactive, defunct, private -->
| game       =
| ip         =
| version    =
| gamemods   =
| owner      =
| moderators =
| links      =
}}

"status" parameter

The |status = parameter has a special output that provides special formatting when given certain inputs.

Status Explanation Appearance
active The server is operational and has an active playerbase. Active
inactive The server is operational, but does not have an active playerbase. Inactive
defunct The server no longer exists :( Defunct
private The server is operational, but it is private. Only certain people can join. Private
(anything else) text

TemplateData

Infobox for use on articles about video game servers. None of the parameters are required.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

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

Default
{{PAGENAME}}
Stringsuggested
imageimage

An image to represent this server, such as an icon or a screenshot.

Filesuggested
landscapelandscape

no description

Unknownoptional
image sizeimage size

Override the size of the image, in pixels

Numberoptional
imagesizeimagesize

no description

Unknownoptional
image_uprightimage_upright

no description

Unknownoptional
altalt

Alt text for the image

Unknownoptional
image captionimage caption

no description

Unknownoptional
captioncaption

A caption for the image

Unknownoptional
statusstatus

The status of the server.

Suggested values
active inactive defunct private
Example
active
Stringsuggested
gamegame

The video game that this server is for.

Example
{{w|Minecraft}}
Stringsuggested
ipip

The IP address used to connect to this server.

Stringsuggested
versionversion

The version of the game this server is running.

Example
Java Edition 1.20.1
Stringsuggested
gamemodsgamemods

Any mods that the server requires the player to have installed.

Unknownoptional
ownerowner

The owner(s) of the server.

Stringsuggested
moderatorsmoderators

The moderator(s) of the server.

Stringsuggested
linkslinks

Any links relating to this server.

Unknownoptional