Difference between revisions of "Template:Infobox game/Documentation"
m (file -> operating) |
m (updated docs and added reception) |
||
Line 1: | Line 1: | ||
;Description | ;Description | ||
This template needs to be present on every game page on the wiki. It contains the basic information on who developed, ported and published the game, as well as what engine was used and when was it released on different operating systems. In addition, it can hold a cover or box image for the game, as well as information on the location of the game's page on several other websites. | This template needs to be present on every game page on the wiki. It contains the basic information on who developed, ported and published the game, as well as what engine was used and when was it released on different operating systems. In addition, it can hold a cover or box image for the game, as well as information on the location of the game's page on several other websites. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
;Syntax | ;Syntax | ||
Line 66: | Line 17: | ||
{{Infobox game/row/date|OS X|}} | {{Infobox game/row/date|OS X|}} | ||
{{Infobox game/row/date|Linux|}} | {{Infobox game/row/date|Linux|}} | ||
+ | |reception = | ||
+ | {{Infobox game/row/reception|Metacritic| | }} | ||
+ | {{Infobox game/row/reception|Opencritic| | }} | ||
+ | {{Infobox game/row/reception|IGDB| | }} | ||
|steam appid = | |steam appid = | ||
|steam appid side = | |steam appid side = | ||
Line 76: | Line 31: | ||
}} | }} | ||
</nowiki></pre> | </nowiki></pre> | ||
+ | |||
+ | ;Arguments | ||
+ | {{Standard table| Parameter | Description |content= | ||
+ | {{Standard table/row| title | ''Optional''. Add if game title is stylized in some way and therefore varies from page name. }} | ||
+ | |||
+ | {{Standard table/row| cover | Only include this if a cover for this game is present on the wiki or on Wikimedia Commons. The contents of this line should be just the filename, excluding the namespace. Defines [[Property:Cover]]. }} | ||
+ | |||
+ | {{Standard table/row| developers | All information included under this argument must be related to developers and porters of the particular game. | ||
+ | Possible rows include: | ||
+ | |||
+ | * {{Code|<nowiki>{{Infobox game/row/developer|1|2}}</nowiki>}} - The first argument should contain the name of the developer, and the second, if necessary, a subtitle as to what the developer was responsible for. This row defines [[Property:Developed by]]. | ||
+ | |||
+ | * {{Code|<nowiki>{{Infobox game/row/porter|1}}</nowiki>}} - The first argument is the name of the porter, the second argument is the operating system. This row defines a matching "Ported to (OS) by" property. }} | ||
+ | |||
+ | {{Standard table/row| publishers | All information included under this argument must be related to publishers of the game. | ||
+ | Possible rows include: | ||
+ | * {{Code|<nowiki>{{Infobox game/row/publisher|1|2}}</nowiki>}} - The first argument should contain the name of the publisher, and the second, if necessary, a subtitle specifying the region or the OS the publisher was responsible for. This row defines [[Property:Published by]]. }} | ||
+ | |||
+ | {{Standard table/row| engines | All information included under this argument must be related to engines used in the game. | ||
+ | Possible rows include: | ||
+ | * {{Code|<nowiki>{{Infobox game/row/engine|1|2}}</nowiki>}} - The first argument should contain the name of the engine used, and the second, if necessary, what component was it responsible for. This row defines [[Property:Uses engine]]. | ||
+ | :* '''Never''' list the engine as ''Custom'', ''Inhouse'' or similar. This provides no additional information to the user. }} | ||
+ | |||
+ | {{Standard table/row| release dates | All information included under this argument must be related to release dates of the game. | ||
+ | Possible rows include: | ||
+ | * {{Code|<nowiki>{{Infobox game/row/date|1|2}}</nowiki>}} | ||
+ | :* The first property defines the OS the date is related to. Possible options include: | ||
+ | :** {{Code|DOS}} - defines [[Property:Release date DOS]]; | ||
+ | :** {{Code|Windows}} - defines [[Property:Release date Windows]]; | ||
+ | :** {{Code|OS X}} - defines [[Property:Release date OS X]]. Remember that {{W|OS X}} isn't the same thing as {{W|Classic Mac OS|Mac OS}}! | ||
+ | :** {{Code|Linux}} - defines [[Property:Release date Linux]] | ||
+ | :** {{Code|Mac OS}} - defines [[Property:Release date Mac OS]]. Remember that Mac OS isn't the same thing as OS X! | ||
+ | :* The second property should specify the date the game was released on the system in question. The date must be in a valid format to be recognized ("21 February 2001", "February 21, 2001", "2001", "February 2001" and additionally "TBA" will work but will not define a property). | ||
+ | :* Correctly using the property (that is, with the appropriate OS name) will result in the appropriate categories being automatically placed on the page. | ||
+ | :* Regional release dates should '''never''' be listed. Only ever list the relevant OS release date, always choosing the earliest it was made available in any region on that specific platform. Similarly, release dates for [[:Category:Stores|digital distribution]] services should also be ignored. }} | ||
+ | |||
+ | {{Standard table/row| reception | ''Average'' critical reception of the game, from a supported aggregator. | ||
+ | Possible rows include: | ||
+ | * {{Code|<nowiki>{{Infobox game/row/reception|1|2|3}}</nowiki>}} | ||
+ | :* The first argument should contain the reviews aggregator service the row is for: {{Code|Metacritic}}, {{Code|OpenCritic}}, {{Code|IGDB}}. | ||
+ | :* The second row should contain the unique identifier from the URL for the review aggregator page for the game. | ||
+ | :* The third argument should contain the averaged critical reception score from the aggregator. | ||
+ | }} | ||
+ | |||
+ | {{Standard table/row| steam appid | The AppID of the game on [[Steam]]. This is used for the ''SteamDB'' and ''SteamCharts'' favicons. Defines [[Property:Steam AppID]]. }} | ||
+ | |||
+ | {{Standard table/row| steam appid side | Additional AppIDs the game is available under on [[Steam]]. This takes a comma separated list for input. Defines [[Property:Steam AppID]]. }} | ||
+ | |||
+ | {{Standard table/row| gogcom id | The ID of the game on [[GOG.com]]. Defines [[Property:GOGcom page]]. }} | ||
+ | |||
+ | {{Standard table/row| gogcom id side | Additional IDs the game is available under on [[GOG.com]]. This takes a comma separated list for input. Defines [[Property:GOGcom page]]. }} | ||
+ | |||
+ | {{Standard table/row| strategywiki | The name of the StrategyWiki page. }} | ||
+ | |||
+ | {{Standard table/row| wikipedia | The name (not the full URL) of the Wikipedia page for the game. The ''Wikipedia'' favicon will appear when it's defined. Defines [[Property:Wikipedia]]. }} | ||
+ | |||
+ | {{Standard table/row| winehq | The ID of the game on WineHQ. }} | ||
+ | |||
+ | {{Standard table/row| license | License of the game from one of the following values: | ||
+ | :* {{code|commercial}} | ||
+ | :* {{code|former commercial}} | ||
+ | :* {{code|freeware}} | ||
+ | :* {{code|free-to-play}} | ||
+ | :* {{code|shareware}} | ||
+ | * Defines [[Property:License]]. }} | ||
+ | |||
+ | |collapsed=no}} | ||
<includeonly>[[Category:Infobox templates]]</includeonly> | <includeonly>[[Category:Infobox templates]]</includeonly> | ||
<noinclude>[[Category:Documentation templates]]</noinclude> | <noinclude>[[Category:Documentation templates]]</noinclude> |
Revision as of 23:39, 1 April 2020
- Description
This template needs to be present on every game page on the wiki. It contains the basic information on who developed, ported and published the game, as well as what engine was used and when was it released on different operating systems. In addition, it can hold a cover or box image for the game, as well as information on the location of the game's page on several other websites.
- Syntax
{{Infobox game |cover = |developers = {{Infobox game/row/developer|}} {{Infobox game/row/porter|}} |publishers = {{Infobox game/row/publisher|}} |engines = {{Infobox game/row/engine|}} |release dates= {{Infobox game/row/date|Windows|}} {{Infobox game/row/date|OS X|}} {{Infobox game/row/date|Linux|}} |reception = {{Infobox game/row/reception|Metacritic| | }} {{Infobox game/row/reception|Opencritic| | }} {{Infobox game/row/reception|IGDB| | }} |steam appid = |steam appid side = |gogcom id = |gogcom id side = |strategywiki = |wikipedia = |winehq = |license = }}
- Arguments
Parameter | Description |
---|---|
title | Optional. Add if game title is stylized in some way and therefore varies from page name. |
cover | Only include this if a cover for this game is present on the wiki or on Wikimedia Commons. The contents of this line should be just the filename, excluding the namespace. Defines Property:Cover. |
developers | All information included under this argument must be related to developers and porters of the particular game.
Possible rows include:
|
publishers | All information included under this argument must be related to publishers of the game.
Possible rows include:
|
engines | All information included under this argument must be related to engines used in the game.
Possible rows include:
|
release dates | All information included under this argument must be related to release dates of the game.
Possible rows include:
|
reception | Average critical reception of the game, from a supported aggregator.
Possible rows include:
|
steam appid | The AppID of the game on Steam. This is used for the SteamDB and SteamCharts favicons. Defines Property:Steam AppID. |
steam appid side | Additional AppIDs the game is available under on Steam. This takes a comma separated list for input. Defines Property:Steam AppID. |
gogcom id | The ID of the game on GOG.com. Defines Property:GOGcom page. |
gogcom id side | Additional IDs the game is available under on GOG.com. This takes a comma separated list for input. Defines Property:GOGcom page. |
strategywiki | The name of the StrategyWiki page. |
wikipedia | The name (not the full URL) of the Wikipedia page for the game. The Wikipedia favicon will appear when it's defined. Defines Property:Wikipedia. |
winehq | The ID of the game on WineHQ. |
license | License of the game from one of the following values:
|