Template:Infobox video game/doc

From LD Smith Games Workshop
Jump to navigation Jump to search

{{#invoke:Message box|mbox}} {{#invoke:Message box|ombox}} {{#invoke:Message box|ombox}} {{#invoke:Message box|ombox}} {{#invoke:Parameter names example|main}}

This is an infobox for video games.

Usage

{{Infobox video game
| collapsible = 
| state = 
| italic title = 
| title = 
| show image = 
| image = 
| alt = 
| caption = 
| developer = 
| publisher = 
| distributor = 
| series = 
| engine = 
| platforms = 
| released = {{Video game release|NA={{Start date|year|month|day}}}}
| genre = 
| modes = 
}}

Add the following credit fields for people who worked on the game (please read inclusion notes below):

| director = 
| producer = 
| designer = 
| programmer = 
| artist = 
| writer = 
| composer = 

Add these fields for arcade games:

| cabinet = 
| arcade system = 
| cpu = 
| sound = 
| display = 

All fields are optional. See talk page for examples and standards.

Full syntax

{{Infobox video game
| collapsible = 
| state = 
| italic title = 
| title = 
| show image = 
| image = 
| alt = 
| caption = 
| developer = 
| publisher = 
| distributor = 
| series = 
| engine = 
| platforms = 
| released = {{Video game release|NA={{Start date|year|month|day}}}}
| genre = 
| modes = 
| director = 
| producer = 
| designer = 
| programmer = 
| artist = 
| writer = 
| composer = 
| cabinet = 
| arcade system = 
| cpu = 
| sound = 
| display = 
}}

Syntax guide

{{#invoke:Infobox|infobox}} {{#invoke:Infobox|infobox}}

Note: In the following, plurals such as "developers", "publishers", "distributors", "artists", etc do not exclude the singular (i.e. "artists", for example, implies "artist or artists").

General fields

collapsible
Set =yes to make the box collapsible.
state
Determines the initial collapsed state of the infobox. Set =collapsed to put the box in collapsed state initially. Set =expanded to put the box in expanded state initially. Set =autocollapse to have the box's initial collapsed state be determined automatically based on the number of other templates in the article that also have the "collapsible" attribute. (Has no effect if collapsible is not used.)
title
The full name of the game including punctuation and style (e.g., "Super Mario RPG: Legend of the Seven Stars" instead of "Super Mario RPG" or "Legend of the Seven Stars"). Do not wikilink the name of the game.
show image
Set =yes to make the image show even when collapsed. (Has no effect if collapsible is not used.)
image
The ideal image is an English-language cover or, in the case of an arcade game, a promotional flier. Secondarily, use a logo or foreign-language cover. When cover designs differ between regions, use the cover from the region associated with the game's first English language release, though do not change another English-language version that has been uploaded first. Use art without platform decals, such as PC cover art, where possible. Avoid screenshots (per consensus), and multiple images (per WP:FUC #3). Also see the WPVG image guideline.
  • Format the filename without the File: prefix (e.g., Name.jpg). The infobox uses "frameless" and "upright" flags to auto-size the image and accommodate user preferences. Do not manually set the image size with added syntax (e.g., "frameless", "upright", or "px").
alt
Alternative text - A short descriptive text associated with an image that serves the same purpose and conveys the same essential information as the image. Useful in situations where the image is not available to the reader, e.g If they are using a screen reader due to a visual impairment. See WP:ALT for information about how to write good Alternative text.
caption
A short description of the image. Is it a flyer, a game cover, or something else? (See above for what an image should consist of.) This is used as the alternate text that will be displayed below the image. (Does not show if image is not used.)
developer
The popular name or names of the video game developers. This field is for the game development company (e.g., Nintendo) or, if confirmed by primary sources, the name of the team that developed the game (e.g., Nintendo EAD). In the case of a game made entirely by one person, use the designer field instead. The names can be wikilinked. Individual development tasks handled by different companies (e.g., scenario, programming) and ports should not be mentioned in the infobox but in the article text instead.
publisher
The popular name or names of the video game publishers. Add publishers for English-language regions and the developer's region. The names can be wikilinked. Use the {{Video game release}} template for regional publishers. If there are many publishers or if the list grows too long, use the {{Collapsible list}} template, fill the field title= with the primary publisher, and also include the field titlestyle=font-weight:normal;background:transparent;text-align:left;.
distributor
The popular name or names of the physical video game distributors. Only include if the distributor is different from the publisher. Games that have digital-only releases should not have this field filled.
When this field is appropriate, add distributors for English-language regions and the developer's region. The names can be wikilinked. Use the {{Video game release}} template for regional distributors. If there are many distributors or if the list grows too long, use the {{Collapsible list}} template, fill the field title= with the primary distributor, and also include the field titlestyle=font-weight:normal;background:transparent;text-align:left;.
series
The video game series the game is associated with. Only use this field if there is an article for the series. Wikilink and italicize the names (such as ''[[Halo (series)|Halo]]'').
engine
The game's engine. Only use this field for game engines with an established, independent article and wikilink its name (such as [[id Tech 3]]).[1] Do not list middleware such as Havok, SpeedTree or Euphoria.
platforms
The unabbreviated console or operating system for which the game was specifically developed. This includes dedicated ports, but not games in emulation or services. E.g.:
Deus Ex was ported specifically for the PlayStation 2, but was emulated on the PlayStation 3
EarthBound was not ported but emulated on the Wii U Virtual Console
Microsoft Windows, not Steam
Xbox 360, not Xbox Live Arcade
The original platform, not PlayStation Now or OnLive
released
Add release dates according to the platforms field, for English-language regions and the developer's region. Use only general public release dates, not festival, preview, or early access dates. If possible, use the game's exact release date ("March 19, 2024"). Use the {{Video game release}} template: {{Video game release|NA=March 19, 2024}}. If there are many release dates, enclose them all with the {{Collapsible list}} template[2] and add the field titlestyle=font-weight:normal;background:transparent;text-align:left; followed by title= set as the earliest release date. Platforms can be abbreviated to fit in one line and should be listed as bolded section titles without colons, separated with commas (e.g., PS2, GCN, Xbox).
genre
The gameplay genre or genres (such as first-person shooter, adventure, etc) the game is categorized in by its developers and publishers, or by reliable sources. This should not include thematic genres (like science fiction, horror, etc.) as video games are more difficult to categorize in such a way. Verifiable thematic genres can be mentioned in the article's body.
modes
Playing modes offered by the game. Currently, the only accepted values are single-player, multiplayer, or both.[3]

Arcade-game specific

cabinet
The type of cabinet the arcade game uses (e.g., upright, sit-down, cocktail, custom).
display
The characteristics of the arcade hardware's video output, such as graphical technique, display resolution and monitor orientation. Wiki: [[Raster graphics|Raster]], 256 x 224, horizontal orientation
arcade system
The name of or names associated with the arcade game's system board hardware. In case of unique arcade hardware, omit this field and use those below.
cpu
The names and number of central processing units used by the arcade game's hardware, wikilinked if possible.
sound
The names and number of hardware [sound-processing units?] used by the arcade game's hardware, wikilinked if possible.

Credit fields

As with the developer field, individual development tasks for one field (e.g. which artists designed characters and which designed concept art; or which writers created story lines and which wrote scripts) should not be mentioned in the infobox but in the article text instead. Individual tasks should be generally kept to prose and the field should only list key people.[4][5] For example, the distinction between story and script writers of The Legend of Zelda: Twilight Princess is mentioned in the article's development section.

director
The popular names of the game directors or creative directors who oversaw the creative development of the game. The names can be wikilinked.
  1. List only the person credited specifically with the title "director" or "co-director";
  2. Do not list other types of directors in this field;
  3. For games directed by a succession of people (e.g. MMOs and games with exceptionally long development cycles), indicate their years of involvement.
producer
The popular names of the game producers in overall charge of the production of the game. The names can be wikilinked.
  1. List only the person credited specifically with the title "Producer";
  2. Do not list the "Executive producer" or other "sub"-producer credits, as they are not generally as intimately involved in a game's development;
  3. If three or more people are credited as "co-producer"s, discuss whether any one played the most significant part and, if decided, list that person;
  4. List the "Creative producer" only if said person's involvement in the game is discussed in the article's development-related section.
designer
The popular names of the game designers, i.e. people who worked on the game's system. The names can be wikilinked. This field is often unfilled in modern high-budget development due to large team sizes and collaboration. Older games and indie games are more likely to use this position.
  1. If a single person is credited as "Lead designer", list that person; synonyms for this position include "Game-design director" and "Lead planner";
  2. If there is no equivalent to #1, omit this field;
  3. If three or more people are credited as "lead designer"s, discuss whether any one played the most significant part and, if decided, list that person.
programmer
The popular names of the game programmers. The names can be wikilinked. This field is often unfilled in modern high-budget development due to large team sizes and collaboration. Older games and indie games are more likely to use this position.
  1. If a single person is credited as "Lead programmer", list that person; synonyms for this position include "Main programmer";
  2. If there is no equivalent to #1, omit this field;
  3. If three or more people are credited as "lead programmer"s, discuss whether any one played the most significant part and, if decided, list that person.
artist
The popular names of the game's artists. The names can be wikilinked.
  1. List the person credited as "Art director" or "Lead artist";
  2. Do not list people with titles such as "Character designer" or "Environment artist" (these should be described in the article's development-related section);
  3. List no more than three people in this field.
writer
The popular names of the game's writers. The names can wikilinked. The writers should be listed in the order of their contribution, with those who wrote the game's scenarios/scripts listed before the game's story writers.
  1. If a single person is credited as "Scenario director" or "Scenario writer", list that person; synonyms for this position include "Lead writer";
  2. If there is a person credited as "Scenario concept writer" or "Original concept", also list that person here;
  3. List no more than three people in this field.
composer
The popular names of the composers who worked on the game's music.
  1. List people who contributed significantly to the soundtrack. Discuss inclusion criteria on a per-game basis on the talk page.

Microformat

The HTML mark-up produced by this template includes an hProduct microformat that makes a product's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

If the product has a URL, use {{URL}} to include it.

Classes used

The HTML classes this microformat uses include:

{{safesubst:#invoke:list|horizontal}}
Please do not rename or remove these classes
nor collapse nested elements which use them.

Template revisions

Style changes

Here's a record of previous styles that were very different from one another:

  • Gray with alternating colors, but with a gap between cells: [1] (Discussion)
  • Gray but no alternating colored rows: [2]
  • Purple with dark borders: [3]

Field changes

TemplateData

{{#invoke:Message box|mbox}}

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Infobox video game

<templatedata> { "description": "A template to generate an infobox for a video game.", "params": { "title": { "label": "title", "description": "Title of the game. If not specified the 'name' parameter or the PAGENAME are used. It should be plain text, do not include a wikilink, hyperlink or image in this parameter.", "type": "string/line", "required": false }, "collapsible": { "label": "collapsible", "description": "Whether this screenshot is hidden by default, set to 'yes' to place the screenshot in a collapsible section", "type": "string/line", "required": false }, "state": { "label": "state", "description": "Determines the initial collapsed state of the infobox. Set collapsed to put the box in collapsed state initially. Set expanded to put the box in expanded state initially. Set autocollapse to have the box's initial collapsed state be determined automatically based on the number of other templates in the article that also have the \"collapsible\" attribute. (Has no effect if collapsible is not used.)", "type": "string", "default": "autocollapse", "required": false }, "show image": { "label": "show image", "description": "Type 'yes' to show the image even when the table is collapsed..", "type": "string", "default": "yes", "required": false }, "image": { "label": "image", "description": "File name for a screenshot of the image, e.g. 'GIMP screenshot.png'", "type": "string/wiki-page-name", "required": false }, "caption": { "label": "caption", "description": "A short description of the image.", "type": "string", "required": false }, "developer": { "label": "developer", "description": "The popular name(s) of the game developer(s), if confirmed by primary sources.", "type": "string", "required": false }, "publisher": { "label": "publisher", "description": "The popular name(s) of the video game publisher(s), if confirmed by primary sources.", "type": "string", "required": false }, "distributor": { "label": "distributor", "description": "The popular name(s) of the game's distributor(s). Only use this field if it is a different company from the publisher. The name(s) can be wikilinked.", "type": "string", "required": false }, "series": { "label": "series", "description": "The video game series the game is associated with. Only use this field if there is an article for the series. Wikilink and italicize the name(s) (such as Halo).", "type": "string", "required": false }, "engine": { "label": "engine", "description": "The game's engine", "type": "string", "required": false }, "platforms": { "label": "platforms", "description": "The unabbreviated console or operating system the game was specifically developed or officially announced (if not canceled) for. This includes dedicated ports, but not games in emulation or services. See documentation for examples.", "type": "string", "required": false }, "released": { "label": "released", "description": "Release date. If possible, use the game's exact release date. Example: November 3, 2013.", "type": "string", "required": false }, "genre": { "label": "genre", "description": "The genre of the game, such as first-person shooter, adventure, etc.", "type": "string", "required": false }, "modes": { "label": "modes", "type": "string", "required": false, "description": "Playing modes offered by the game. Currently, the only accepted values are single-player, multiplayer, or both." }, "cabinet": { "label": "cabinet", "type": "string", "required": false }, "display": { "label": "display", "type": "string", "required": false, "description": "The characteristics of the arcade hardware's video output, such as graphical technique, display resolution and monitor orientation. Example: Raster, 256 x 224, horizontal orientation" }, "arcade system": { "label": "arcade system", "type": "string", "required": false }, "Note": { "label": "Note", "type": "string", "required": false }, "cpu": { "label": "cpu", "type": "string", "required": false }, "sound": { "label": "sound", "type": "string", "required": false }, "director": { "label": "director", "type": "string", "required": false, "description": "The popular names of the game directors or creative directors who oversaw the creative development of the game. The names can be wikilinked." }, "producer": { "label": "producer", "type": "string", "required": false, "description": "The popular names of the game producers in overall charge of the production of the game. The names can be wikilinked." }, "designer": { "label": "designer", "type": "string", "required": false, "description": "The popular names of the game designers, i.e. people who worked on the game's system. The names can be wikilinked. This field is often unfilled in modern high-budget development due to large team sizes and collaboration. Older games and indie games are more likely to use this position." }, "programmer": { "label": "programmer", "type": "string", "required": false, "description": "The popular names of the game programmers. The names can be wikilinked. This field is often unfilled in modern high-budget development due to large team sizes and collaboration. Older games and indie games are more likely to use this position." }, "artist": { "label": "artist", "type": "string", "required": false, "description": "The popular names of the game's artists. The names can be wikilinked." }, "writer": { "label": "writer", "type": "string", "required": false, "description": "The popular names of the game's writers. The names can wikilinked. The writers should be listed in the order of their contribution, with those who wrote the game's scenarios/scripts listed before the game's story writers." }, "composer": { "label": "composer", "type": "string", "required": false, "description": "The popular names of the composers who worked on the game's music." } }, "format": "block" } </templatedata>

See also

Notes