User:Smjg/sandbox/template/doc
This is a documentation subpage for User:Smjg/sandbox/template. It may contain usage information, categories and other content that is not part of the original user template page. |
This template is used on 21,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This user page employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
This infobox should italicize the article title automatically. If this is not required, add |italic title=no to the list of parameters. If this is required but the title is not being italicized, try |italic title=force . |
This section does not appear to make sense. |
This is an infobox for video games.
Usage
[edit]{{Infobox video game | collapsible = | state = | title = | image = | alt = | caption = | developer = | publisher = | series = | engine = | platform = | release_date = {{Video game release|NA|{{Start date|year|month|day}}}} | genre = | mode = }}
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
[edit]{{Infobox video game | collapsible = | state = | italic title = | title = | image = | alt = | caption = | developer = | publisher = | series = | engine = | platform = | release_date = {{Video game release|NA|{{Start date|year|month|day}}}} | genre = | mode = | director = | producer = | designer = | programmer = | artist = | writer = | composer = | cabinet = | arcade system = | cpu = | sound = | display = }}
The parameters developer, publisher, distributor, director, producer, designer, programmer, artist, writer, composer, platform, release_date, genre and mode have variants developers, publishers, distributors, directors, producers, designers, programmers, artists, writers, composers, platforms, release_dates, genres and modes, which simply cause their respective labels to be in the plural form.
Syntax guide
[edit]Nintendogs | |
---|---|
Developer(s) | Nintendo EAD |
Publisher(s) | Nintendo |
Director(s) | Kiyoshi Mizuki |
Producer(s) | Hideki Konno |
Composer(s) | Hajime Wakai |
Platform(s) | Nintendo DS |
Release | |
Genre(s) | Pet-raising simulation |
Mode(s) | Single-player, multiplayer |
Nintendogs | |
---|---|
Developer(s) | Nintendo EAD |
Publisher(s) | Nintendo |
Director(s) | Kiyoshi Mizuki |
Producer(s) | Hideki Konno |
Composer(s) | Hajime Wakai |
Platform(s) | Nintendo DS |
Release | |
Genre(s) | Pet-raising simulation |
Mode(s) | Single-player, multiplayer |
This is a documentation subpage for User:Smjg/sandbox/template. It may contain usage information, categories and other content that is not part of the original user template page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This infobox should italicize the article title automatically. If this is not required, add |italic title=no to the list of parameters. If this is required but the title is not being italicized, try |italic title=force . |
This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
This template uses Lua: |
This template uses TemplateStyles: |
- author (P50) (see uses)
- director (P57) (see uses)
- composer (P86) (see uses)
- publisher (P123) (see uses)
- genre (P136) (see uses)
- producer (P162) (see uses)
- developer (P178) (see uses)
- part of the series (P179) (see uses)
- designed by (P287) (see uses)
- platform (P400) (see uses)
- game mode (P404) (see uses)
- software engine (P408) (see uses)
- CPU (P880) (see uses)
- programmer (P943) (see uses)
- has part(s) of the class (P2670) (see uses)
- game artist (P3080) (see uses)
This is an infobox for video games. It is capable of pulling reliably sourced values from Wikidata when fields are omitted. (See WP:VG/WD for a guide to editing Wikidata.) To prevent Wikidata from pulling data for a field, use the parameter in the template but leave its contents blank.
Usage
[edit]This section does not appear to make sense. |
{{Infobox video game
| collapsible =
| state =
| italic title =
| title =
| image =
| alt =
| caption =
| developer =
| publisher =
| series =
| engine =
| platforms =
| released =
| genre =
| modes =
| arcade system =
}}
Add the following credit fields for lead developers who worked on the game (please read inclusion notes below):
{{Infobox video games
| director =
| producer =
| designer =
| programmer =
| artist =
| writer =
| composer =
}}
All fields are optional. See talk page for examples and standards.
Full syntax
[edit]{{Infobox video game
| collapsible =
| state =
| italic title =
| title =
| image =
| alt =
| caption =
| developer =
| publisher =
| series =
| engine =
| platforms =
| released =
| genre =
| modes =
| arcade system =
| director =
| producer =
| designer =
| programmer =
| artist =
| writer =
| composer =
}}
Parameters
[edit]Note: In the following, plurals such as "developers", "publishers", "artists", etc., do not exclude the singular (i.e. "artists", for example, implies "artist or artists"). Similarly, with the credit fields, 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.[1][2] For example, the distinction between story and script writers of The Legend of Zelda: Twilight Princess is mentioned in the article's development section.
Parameter | Default | Description |
---|---|---|
collapsible |
no | Set =yes to make the box collapsible.
|
fetchwikidata |
ALL | If you don't want all values to be fetched from wikidata, specify their property names here (see Module:WikidataIB for more details) |
suppressfields |
If you want to exclude some Wikidata values, specify their property names here (see Module:WikidataIB for more details) | |
onlysourced |
yes | Set to no if you only want to fetch values from Wikidata that do not have references (see Module:WikidataIB for more details, and see this RFC, which requires reliable sources for imported Wikidata fields in infoboxes, before doing so) |
qid |
Set to the Wikidata QID of the entry that you want to retrieve info from, if it is not the page that the template is being used on | |
refs |
no | set to yes if you want to fetch references from Wikidata (displayed inline and in the refs section) |
noicon |
no | when set to no, a small pen icon will be shown next to items populated from Wikidata, which can be used to edit the value. If set to yes, the pen icons will be hidden, and instead a single link stating "Edit on Wikidata" will display at the bottom of the Infobox. |
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. | |
image |
image (P18) | 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.
|
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 |
media legend (P2096) | 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 |
developer (P178) | 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). 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 |
publisher (P123) | The popular name or names of the video game publishers. Add publishers for English-language regions and, if different, the region of first release (typically that of 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 wrap this entry with {{nobold}}.
|
series |
part of the series (P179) | 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 |
software engine (P408) | The game's engine. Only use this field for those engines listed in Category:Video game engines, either engines with an established, independent article (such as Unreal Engine), or those that have a redirect to their own section on an appropriate developer or series page (such as Dunia Engine). Wikilink its name (such as [[id Tech 3]] ).[3] Do not list common middleware engines such as Havok, SpeedTree or Euphoria.
|
platforms |
platform (P400) | The unabbreviated console or operating system family for which the game was specifically developed. With multi-platform games, order by chronology; if the game was released on multiple platforms on the same day, list that subset in alphabetical order. This field includes dedicated ports, but not games in emulation or services. E.g., we would include the platforms listed in green, but not include those red below:
Always use Windows instead of Microsoft Windows. Games that were developed for macOS should cover the operating system's name as it was at the time of the game's release:
For short platform lists, consider using {{unbulleted list}} ({{ubl}}) to arrange each platform on its own line. For long platform lists (more than 10 or so platforms), and in which there was a key primary platform, consider using {{collapsible list}}, with its |
released |
Add release dates according to the platforms field, for English-language regions and the developer's region. Use only general public release dates of full games, not mod, festival, preview, or early access dates. If sourced, use the game's exact release date ("November 23, 2024"). Use the {{Video game release}} template: {{Video game release|NA|November 23, 2024}} . If there are many release dates, enclose them all with the {{Collapsible list}} template[4] followed by |title= with a {{nobold}} template using 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., PC, 3DS, PS4). Only use WW to provide clarity where a game has various differing release dates including multiple regional release dates on some platforms and worldwide on other platforms.
| |
genre |
genre (P136) | 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. Do not include broad gameplay mechanics that are frequently confused with genres, such as open world. 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 |
game mode (P404) | Playing modes offered by the game. Currently, the only accepted values are single-player, multiplayer, or both.[5] |
arcade system |
has part(s) of the class (P2670) arcade system board (Q631229), qualifier instance of (P31) | 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. |
director |
director (P57) | The popular names of the game directors or creative directors who oversaw the creative development of the game. The names can be wikilinked.
|
producer |
producer (P162) | The popular names of the video game producers in overall charge of the production of the game. The names can be wikilinked.
|
designer |
designed by (P287) | The popular names of the video 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 |
programmer (P943) | The popular names of the video 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 |
game artist (P3080) | The popular names of the video game artists. The names can be wikilinked.
|
writer |
author (P50) | The popular names of the video game writers. The names can wikilinked. The writers should be listed in the order of their contribution, with those who wrote the game's scenarios listed before the game's story/script writers.
|
composer |
composer (P86) | The popular names of the video game composers.
|
commons |
Commons category (P373) | The commons category link |
Microformat
[edit]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 of this microformat include:
- brand
- category
- description
- fn
- hproduct
- identifier
- listing
- photo
- price
- review
- type
- url
- value
nor collapse nested elements which use them.
Template revisions
[edit]Style changes
[edit]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
[edit]- Input method: The input method section was removed on August 14, 2010. (discussion)
- Ratings: The ratings section was removed on October 2, 2012. (discussion)
- Requirements: The requirements section was removed on December 18, 2012. (discussion)
- Version: The version section was removed on February 24, 2013. (discussion)
- Media: The media field was removed on May 8, 2015. (discussion)
- Arcade specific fields, such as cabinet, display, CPU, and sound, were removed on November 26, 2020. (discussion)
TemplateData
[edit]This template data section is not complete. |
TemplateData for Smjg/sandbox/template
A template to generate an infobox for a video game.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | 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. | Line | optional |
Collapsible | collapsible | Whether this screenshot is hidden by default, set to 'yes' to place the screenshot in a collapsible section | Line | optional |
State | 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.)
| String | optional |
Image | image | File name for a screenshot of the image, e.g. 'GIMP screenshot.png' | File | optional |
Border | border | Add a border around the image
| String | optional |
Caption | caption | A short description of the image. | String | optional |
Developer | developer | The popular name(s) of the game developer(s), if confirmed by primary sources. | String | optional |
Publisher | publisher | The popular name(s) of the video game publisher(s), if confirmed by primary sources. | String | optional |
Series | 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 name(s) (such as Halo). | String | optional |
Engine | engine | The game's engine | String | optional |
Platforms | platforms | The unabbreviated console or operating system family 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. | String | optional |
Released | released | Release date. If possible, use the game's exact release date. Example: November 3, 2013. | String | optional |
Genre | genre | The genre of the game, such as first-person shooter, adventure, etc. | String | optional |
Modes | modes | Playing modes offered by the game. Currently, the only accepted values are single-player, multiplayer, or both. | String | optional |
Arcade system | arcade system | no description | String | optional |
Note | Note | no description | String | optional |
Director | director | The popular names of the game directors or creative directors who oversaw the creative development of the game. The names can be wikilinked. | String | optional |
Producer | producer | The popular names of the game producers in overall charge of the production of the game. The names can be wikilinked. | String | optional |
Designer | 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. | String | optional |
Programmer | 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. | String | optional |
Artist | artist | The popular names of the game's artists. The names can be wikilinked. | String | optional |
Writer | 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. | String | optional |
Composer | composer | The popular names of the composers who worked on the game's music. | String | optional |
fetchwikidata | fetchwikidata | no description | Unknown | optional |
suppressfields | suppressfields | no description | Unknown | optional |
onlysourced | onlysourced | no description | Unknown | optional |
qid | qid | Wikidata's unique, persistent identifier for the data. Short for Q-identifier. Consists of the letter Q and a number.
| String | optional |
refs | refs | no description | Unknown | optional |
noicon | noicon | no description | Unknown | optional |
alt | alt | no description | Unknown | optional |
Example
[edit]Nintendogs | |
---|---|
Developer(s) | Nintendo EAD |
Publisher(s) | Nintendo |
Director(s) | Kiyoshi Mizuki |
Producer(s) | Hideki Konno |
Composer(s) | Hajime Wakai |
Platform(s) | Nintendo DS |
Release | |
Genre(s) | Pet-raising simulation |
Mode(s) | Single-player, multiplayer |
{{Infobox video game
| title = Nintendogs
| image = Example-serious.jpg
| caption = An example image
| developer = [[Nintendo EAD]]
| publisher = [[Nintendo]]
| platforms = [[Nintendo DS]]
| released = {{Collapsible list |title={{nobold|April 21, 2005}}
|'''Original version'''{{Video game release|JP|April 21, 2005|NA|August 22, 2005|AUS|September 29, 2005|EU|October 7, 2005}}'''''Best Friends'''''{{Video game release|NA|October 24, 2005}}'''''Dalmatian & Friends'''''{{Video game release|EU|June 16, 2006|NA|October 16, 2006}}
}}
| genre = [[List of artificial pet games|Pet-raising simulation]]
| modes = [[Single-player]], [[multiplayer]]
| director = Kiyoshi Mizuki
| producer = [[Hideki Konno]]
| composer = Hajime Wakai
}}
Tracking categories
[edit]- Category:Articles using Infobox video game using locally defined parameters (26,788)
- Category:Pages using infobox video game with unknown parameters (5)
See also
[edit]- {{Infobox video game series}} for video game franchises and series.
- {{Infobox software}} for general software.
- WP:IB - list of infoboxes
Notes
[edit]
Microformat
[edit]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 of this microformat include:
- brand
- category
- description
- fn
- hproduct
- identifier
- listing
- photo
- price
- review
- type
- url
- value
nor collapse nested elements which use them.
Template revisions
[edit]Style changes
[edit]Here's a record of previous styles that were very different from one another:
- Gray with alternating colors, but with a gap between cells: [4] (Discussion)
- Gray but no alternating colored rows: [5]
- Purple with dark borders: [6]
Field changes
[edit]- Input method: The input method section was removed on August 14, 2010 (See Template talk:Infobox video game/Archive 9#.22Input method.22 field).
- Ratings: The ratings section was removed on October 2, 2012 (See Template talk:Infobox video game/Archive 11#Propose removal of ratings section.).
- Requirements: The requirements section was removed on December 18, 2012 (See Template talk:Infobox video game/Archive 11#Proposed removal of requirements section).
- Version: The version section was removed on February 24, 2013 (See Template talk:Infobox video game/Archive 11#Proposal for removal of Version field).
- Media The media field was removed on 8 May 2015 (See Template talk:Infobox video game#Media).
TemplateData
[edit]This template data section is not complete. |
TemplateData for Smjg/sandbox/template
A template to generate an infobox for a video game.
Parameter | Description | Type | Status | |
---|---|---|---|---|
title | title | 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. | Line | optional |
collapsible | collapsible | Whether this screenshot is hidden by default, set to 'yes' to place the screenshot in a collapsible section | Line | optional |
state | 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.)
| String | optional |
show image | show image | Type 'yes' to show the image even when the table is collapsed..
| String | optional |
image | image | File name for a screenshot of the image, e.g. 'GIMP screenshot.png' | Page name | optional |
caption | caption | A short description of the image. | String | optional |
developer | developer | The popular name(s) of the game developer(s), if confirmed by primary sources. | String | optional |
publisher | publisher | The popular name(s) of the video game publisher(s), if confirmed by primary sources. | String | optional |
distributor | distributor | 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. | String | optional |
series | 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 name(s) (such as Halo). | String | optional |
engine | engine | The game's engine | String | optional |
platforms | platforms | 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. | String | optional |
released | released | Release date. If possible, use the game's exact release date. Example: November 3, 2013. | String | optional |
genre | genre | The genre of the game, such as first-person shooter, adventure, etc. | String | optional |
modes | modes | Playing modes offered by the game. Currently, the only accepted values are single-player, multiplayer, or both. | String | optional |
cabinet | cabinet | no description | String | optional |
display | display | The characteristics of the arcade hardware's video output, such as graphical technique, display resolution and monitor orientation. Example: [[Raster graphics|Raster]], 256 x 224, horizontal orientation | String | optional |
arcade system | arcade system | no description | String | optional |
Note | Note | no description | String | optional |
cpu | cpu | no description | String | optional |
sound | sound | no description | String | optional |
director | director | The popular names of the game directors or creative directors who oversaw the creative development of the game. The names can be wikilinked. | String | optional |
producer | producer | The popular names of the game producers in overall charge of the production of the game. The names can be wikilinked. | String | optional |
designer | 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. | String | optional |
programmer | 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. | String | optional |
artist | artist | The popular names of the game's artists. The names can be wikilinked. | String | optional |
writer | 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. | String | optional |
composer | composer | The popular names of the composers who worked on the game's music. | String | optional |
See also
[edit]- {{Infobox video game series}} for video game franchises and series.
- {{Infobox software}} for general software.
- Category:Infobox video game with deprecated parameters (hidden tracking/maintenance category)
Notes
[edit]