Template:Video game release/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 01:40, 23 September 2022

This is a documentation subpage for Template:Video game release.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 18,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 template uses Lua:

Module:Video game release (sandbox)

Shortcuts

Description

The purpose of this template is to build an HTML list with pairs of labels and items. The labels are typically regions, countries, or languages. The items are typically dates, but can be used for companies or people as well.

The template is most commonly used for infobox fields, such as {{Infobox video game}}'s release and publisher fields. It is also used for release date columns in many tables.

You can specify any region, country or other label.
Labels and items appear in the order in which you input them.
Labels can be repeated with different items.

Usage

Parameters are input as label/date pairs, and are displayed in the order they are given. Video game-specific aliases for regions such as NA, EU, AU or AUS, PAL, SEA, AS, SA, OC, and WW are supported, as well as all ISO 3166-1 alpha-3 codes and a smaller number of selected ISO 3166-1 alpha-2 codes. Multiple regions can be used together separated by a /, such as NA/JP

Note that WP:VG/DATE asserts several guidelines/rules concerning where and when (and which) abbreviations may be used in video game infoboxes.

List parameters

This template supports the following additional parameters for formatting the output list:

format: The list format to output, one of bulleted, unbulleted (default), horizontal, ordered, horizontal_ordered
class: a custom class for the <div>...</div> tags surrounding the list, e.g. plainlinks.
style: a custom CSS style for the <div>...</div> tags surrounding the list, e.g. font-size: 90%;.
list_style: a custom CSS style for the <ul>...</ul> tags around the list. The format is the same as for the |style= parameter.
item_style: a custom CSS style for all of the list items (the <li>...</li> tags). The format is the same as for the |style= parameter.
item1_style, item2_style, item3_style...: custom CSS styles for each of the list items. The format is the same as for the |style= parameter.
indent: this parameter indents the list. The value must be a number, e.g. 2. The indent is calculated in em, and is 1.6 times the value specified. If no indent is specified, the default is zero.

Examples

Code	Output
`{{Video game release\|EU\|September 11, 2015\|NA\|September 23, 2015}}`	EU: September 11, 2015 NA: September 23, 2015
`{{Video game release\|JP\|February 8, 2011\|WW\|TBA}}`	JP: February 8, 2011 WW: TBA
`{{Video game release\|NA\|October 5, 2009\|PAL\|October 6, 2009}}`	NA: October 5, 2009 PAL: October 6, 2009
`{{Video game release\|UK\|July 19, 1999\|WW\|December 12, 1999}}`	UK: July 19, 1999 WW: December 12, 1999
`{{Video game release\|JP\|July 19, 1999\|EU/NA\|December 12, 1999}}`	JP: July 19, 1999 EU/NA: December 12, 1999
`{{Video game release\|NA\|January 1, 2016\|EU\|January 2, 2016\|AU\|January 4, 2016\|SEA\|January 13, 2016\|AS\|January 14, 2016\|SA\|January 15, 2016\|OC\|January 16, 2016\|WW\|January 17, 2016}}`	NA: January 1, 2016 EU: January 2, 2016 AU: January 4, 2016 SEA: January 13, 2016 AS: January 14, 2016 SA: January 15, 2016 OC: January 16, 2016 WW: January 17, 2016
`{{Video game release\|class=nowrap\|WW\|[[Bandai Namco Entertainment]]\|JP\|FromSoftware}}`	WW: Bandai Namco Entertainment JP: FromSoftware

Tracking categories

Category:Pages using vgrelease with named parameters (0) - Pages using the template with old named parameter syntax; for example, NA=date. Convert to current syntax, i.e. NA|date.
Category:Pages using vgrelease with two parameter region (0) - Pages using the template with old "custom region" three parameter syntax, where the first two parameters represent an article and link label. These uses should be removed by combining the first and second parameter into a wikilink. For example, combine North America|NA|date into [[North America|NA]]|date. Where possible, simply replace with the region code; for example, NA|date.
Category:Pages using vgrelease without a region (8) - Pages using the template without a region. These should be cleaned up either by specifying a region or removing the template.

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 <!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
-<includeonly>{{High-use|14,200+}}</includeonly>
+{{High-use| 14812 }}
 {{Lua|Module:Video game release}}
+{{Template shortcut|Vgr|Vgrelease|Vg release}}
 === Description ===
+The purpose of this template is to build an HTML list with pairs of labels and items. The labels are typically regions, countries, or languages. The items are typically dates, but can be used for companies or people as well.
+The template is most commonly used for infobox fields, such as {{tl|Infobox video game}}'s release and publisher fields. It is also used for release date columns in many tables.
 # You can specify any region, country or other label.
-# Regions and dates appear in the order in which you input them.
+# Labels and items appear in the order in which you input them.
-# Regions can be repeated.
+# Labels can be repeated with different items.
 === Usage ===
-Parameters are input as region code/date pairs, and are displayed in the order they are given. Any of the standard '''NA''', '''EU''', '''AU''', '''PAL''', '''JP''', '''RU''', '''BR''', '''INT''', '''SEA''', '''AS''', '''SA''', '''OC''', '''WW''' and '''?''' video game-specific codes will work, as well as all [[ISO 3166-1 alpha-3]] codes and a smaller number of selected [[ISO 3166-1 alpha-2]] codes.
+Parameters are input as label/date pairs, and are displayed in the order they are given. Video game-specific aliases for regions such as '''NA''', '''EU''', '''AU''' or '''AUS''', '''PAL''', '''SEA''', '''AS''', '''SA''', '''OC''', and '''WW''' are supported, as well as all [[ISO 3166-1 alpha-3]] codes and a smaller number of selected [[ISO 3166-1 alpha-2]] codes. Multiple regions can be used together separated by a '''/''', such as '''NA/JP'''
-Note that [[WP:VG/DATE]] asserts several guidelines/rules concerning where and when (and which) abbreviations may be used in video game infoboxes, specifically:
+Note that [[WP:VG/DATE]] asserts several guidelines/rules concerning where and when (and which) abbreviations may be used in video game infoboxes.
-<blockquote>"''Add release dates 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 ("January 25, 2016").''"</blockquote>
+====List parameters====
+This template supports the following additional parameters for formatting the output list:
+* <code>format</code>: The list format to output, one of bulleted, unbulleted (default), horizontal, ordered, horizontal_ordered
+* <code>class</code>: a custom class for the {{tag|div}} tags surrounding the list, e.g. <code>plainlinks</code>.
+* <code>style</code>: a custom CSS style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>.
+* <code>list_style</code>: a custom CSS style for the {{tag|ul}} tags around the list. The format is the same as for the {{para|style}} parameter.
+* <code>item_style</code>: a custom CSS style for all of the list items (the {{tag|li}} tags). The format is the same as for the {{para|style}} parameter.
+* <code>item1_style</code>, <code>item2_style</code>, <code>item3_style</code>...: custom CSS styles for each of the list items. The format is the same as for the {{para|style}} parameter.
+* <code>indent</code>: this parameter indents the list. The value must be a number, e.g. <code>2</code>. The indent is calculated in [[Em (typography)|em]], and is 1.6 times the value specified. If no indent is specified, the default is zero.
 === Examples ===
@@ Line 24: / Line 37: @@
 | {{Video game release|EU|September 11, 2015|NA|September 23, 2015}}
 |-
-| <code><nowiki>{{Video game release|JP|February 8, 2011|INT|TBA}}</nowiki></code>
+| <code><nowiki>{{Video game release|JP|February 8, 2011|WW|TBA}}</nowiki></code>
-| {{Video game release|JP|February 8, 2011|INT|TBA}}
+| {{Video game release|JP|February 8, 2011|WW|TBA}}
 |-
 | <code><nowiki>{{Video game release|NA|October 5, 2009|PAL|October 6, 2009}}</nowiki></code>
@@ Line 32: / Line 45: @@
 | <code><nowiki>{{Video game release|UK|July 19, 1999|WW|December 12, 1999}}</nowiki></code>
 | {{Video game release|UK|July 19, 1999|WW|December 12, 1999}}
+|-
+| <code><nowiki>{{Video game release|JP|July 19, 1999|EU/NA|December 12, 1999}}</nowiki></code>
+| {{Video game release|JP|July 19, 1999|EU/NA|December 12, 1999}}
+|-
+| <code><nowiki>{{Video game release|NA|January 1, 2016|EU|January 2, 2016|AU|January 4, 2016|SEA|January 13, 2016|AS|January 14, 2016|SA|January 15, 2016|OC|January 16, 2016|WW|January 17, 2016}}</nowiki></code>
+| {{Video game release|NA|January 1, 2016|EU|January 2, 2016|AU|January 4, 2016|SEA|January 13, 2016|AS|January 14, 2016|SA|January 15, 2016|OC|January 16, 2016|WW|January 17, 2016}}
+|-
+| <code><nowiki>{{Video game release|class=nowrap|WW|[[Bandai Namco Entertainment]]|JP|FromSoftware}}</nowiki></code>
+| {{Video game release|class=nowrap|WW|[[Bandai Namco Entertainment]]|JP|FromSoftware}}
 |}
 == Tracking categories ==
-* {{clc|Pages using vgrelease with named parameters}} - Pages using the template with old named parameter syntax, i.e. <code>NA=date</code>. Convert to current syntax, i.e. <code>NA|date</code>.
+* {{clc|Pages using vgrelease with named parameters}} - Pages using the template with old named parameter syntax; for example, <code>NA=date</code>. Convert to current syntax, i.e. <code>NA|date</code>.
-* {{clc|Pages using vgrelease with two parameter region}} - Pages using the template with old "custom region" three parameter syntax, where the first two parameters represent an article and link label. These uses should be removed by combining the first and second parameter into a wikilink. I.e. combine <code><nowiki>North America|NA|date</nowiki></code> into <code><nowiki>[[North America|NA]]|date</nowiki></code>. Where possible, simply replace with the region code, i.e. <code><nowiki>NA|date</nowiki></code>
+* {{clc|Pages using vgrelease with two parameter region}} - Pages using the template with old "custom region" three parameter syntax, where the first two parameters represent an article and link label. These uses should be removed by combining the first and second parameter into a wikilink. For example, combine <code><nowiki>North America|NA|date</nowiki></code> into <code><nowiki>[[North America|NA]]|date</nowiki></code>. Where possible, simply replace with the region code; for example, <code><nowiki>NA|date</nowiki></code>.
 * {{clc|Pages using vgrelease without a region}} - Pages using the template without a region. These should be cleaned up either by specifying a region or removing the template.
-* {{clc|Pages using vgrelease with deprecated parameters}} - Pages using the template with a depreciated hard-coded region code (I.e. JA or JN instead of JP).
-== Redirects ==
-* {{tlx|Vgr}}
-* {{tlx|Vgrelease}}
-* {{tlx|Vg release}}
-<!--Should be deleted:
-* {{tlx|Vgreleasenew}}
-* {{tlx|Vgrelease new}}
-* {{tlx|Video game release new}}-->
 == See also ==
+* {{tl|Video game release hlist}} – Same functionality but with the format defaulted to a horizontal list
-* {{tl|Vgrtbl}} – just like this template, except formatted so that dates sort properly in sortable tables.
+* {{tl|Vgrtbl}} – Formats dates to sort properly in sortable tables.
 <includeonly>{{sandbox other||