Difference between revisions of "Template:Infobox awards list/doc"

From blackwiki
Jump to navigation Jump to search
imported>Primefac
(Undid revision 910559918 by Primefac (talk) self-revert for now)
imported>Primefac
(update /doc based on Template:Infobox musician awards/doc)
Line 3: Line 3:
 
'''{{Tl|Infobox awards list}}''' is used for awards lists to show a summary of notable awards won or nominated.
 
'''{{Tl|Infobox awards list}}''' is used for awards lists to show a summary of notable awards won or nominated.
 
{{Lua|Module:Infobox|Module:Infobox3cols|Module:InfoboxImage|Module:Check for unknown parameters}}
 
{{Lua|Module:Infobox|Module:Infobox3cols|Module:InfoboxImage|Module:Check for unknown parameters}}
{{Parameter names example|_template=| alt | awards = {{Infobox awards list/custom|Award name|{{param|2}}|{{param|3}}}}| caption | image | image_size |  nocollapse | nominations | title | wins}}
 
  
 
== Usage ==
 
== Usage ==
The infobox may be added by pasting the template as shown below into an article, typically at the top of an article above the lead section.
+
{{Parameter names example|_template=| awards = {{Infobox awards list/custom|Award name|{{param|2}}|{{param|3}}}} | caption | film | image | image_size | name | nocollapse | nominations | title | total_width | wins | AmericanN | AmericanW | APRAN | APRAW | ARIAN | ARIAW | ASFN | ASFW | award1 | award2 | award2N | award2W | award3 | award3N | award3W | award4 | award4N | award4W | award5 | award5N | award5W | award6 | award6N | award6W | award7 | award7N | award7W | award8 | award8N | award8W | award9 | award9N | award9W | award10 | award10N | award10W | award11 | award11N | award11W | award12 | award12N | award12W | award13 | award13N | award13W | award14 | award14N | award14W | award15 | award15N | award15W | award16 | award16N | award16W | award17 | award17N | award17W | award18 | award18N | award18W | award19 | award19N | award19W | award1N | award1W | award20 | award20N | award20W | BETHHN | BETHHW | BETN | BETW | BillboardN | BillboardW | BRITN | BRITW | CMTMAN | CMTMAW | CyworldN | CyworldW | ECHON | ECHOW | GDAN | GDAW | GGAN | GGAW | GrammyN | GrammyW | IvorN | IvorW | JackN | JackW | JN | JunoN | JunoW | JW | KerrangN | KerrangW | MamaN | MamaW | MCAN | MCAW | MelonN | MelonW | MercuryN | MercuryW | MeteorN | MeteorW | MOBON | MOBOW | MOJON | MOJOW | MTVAfricaN | MTVAfricaW | MTVAsiaN | MTVAsiaW | MTVAustraliaN | MTVAustraliaW | MTVBrasilN | MTVBrasilW | MTVEuropeN | MTVEuropeW | MTVJapanN | MTVJapanW | MTVVideoN | MTVVideoW | MuchMusicN | MuchMusicW | MusoN | MusoW | MVPAN | MVPAW | NAACPN | NAACPW | NickAustraliaN | NickAustraliaW | NickN | NickW | NMEN | NMEW | NRJN | NRJW | NZMAN | NZMAW | PeoplesN | PeoplesW | PLUGN | PLUGW | PolarisN | PolarisW | QN | QW | RadioN | RadioW | ShortlistN | ShortlistW | SMAN | SMAW | SoulN | SoulW | TeenN | TeenW | TMFN | TMFW | VMALAN | VMALAW | WorldN | WorldW}}
 +
 
 +
The infobox may be added by pasting the template as detailed below into an article, typically at the top of an article above the lead section.
 +
 
 +
===Basic parameters===
 +
The following are the "basic" parameters that will be used in almost every infobox.
 
<pre style="width:auto; overflow:auto">
 
<pre style="width:auto; overflow:auto">
 
{{Infobox awards list
 
{{Infobox awards list
| title        =  
+
| title        = <!-- use "name = " to display "{{{name}}} awards and nominations"-->
 
| image        =  
 
| image        =  
 
| image_size  =  
 
| image_size  =  
Line 16: Line 20:
 
| wins        =  
 
| wins        =  
 
| nominations  =  
 
| nominations  =  
| awards      =
 
{{Infobox awards list/custom|Award #1 name|wins|nominations}}
 
{{Infobox awards list/custom|Award #2 name|wins|nominations}}
 
 
}}</pre>
 
}}</pre>
 
{{notelist}}
 
{{notelist}}
  
 +
===Named awards===
 +
This template has a number of "named" awards. Each specifically named parameter corresponds to one specific award ceremony. The parameter includes a W or N to define the total number of awards won or nominated.
 +
 +
;Example:
 +
<pre style="width:auto; overflow:auto">
 +
|AmericanW = 0
 +
|AmericanN = 1
 +
|GrammyW = 3
 +
|GrammyN = 2</pre>
 +
The above example indicates that the group or artist American Music Award was nominated for 1 American Music Award, won 3 Grammy Awards, and was nominated for 2 Grammy Awards.
 +
{{hidden begin|toggle=left |title=Full list of named awards}}
 +
* <code>American</code> - [[American Music Award]]s
 +
* <code>APRA</code> - [[Australasian Performing Right Association#APRA Awards|APRA]]
 +
* <code>ARIA</code> - [[ARIA Music Awards|ARIA]]
 +
* <code>ASF</code> - [[Asia Song Festival]]
 +
* <code>BET</code> - [[BET Awards|BET]]
 +
* <code>BETHH</code> - [[BET Hip Hop Awards|BET Hip Hop]]
 +
* <code>Billboard</code> - [[Billboard Music Award|Billboard]]
 +
* <code>BRIT</code> - [[Brit Awards|Brit]]
 +
* <code>CMTMA</code> - [[CMT Music Awards|CMT]]
 +
* <code>Cyworld</code> - [[Cyworld Digital Music Awards|Cyworld Digital Music]]
 +
* <code>ECHO</code> - [[Echo (music award)|Echo]]
 +
* <code>GDA</code> - [[Golden Disk Awards|Golden Disk]]
 +
* <code>GGA</code> - [[Golden Globe Award|Golden Globe]]
 +
* <code>Grammy</code> - [[Grammy Award|Grammy]]
 +
* <code>Ivor</code> - [[Ivor Novello Awards|Ivor Novello]]
 +
* <code>J</code> - [[J Award|J]]
 +
* <code>Jack</code> - [[Jack Awards|Jack]]
 +
* <code>Juno</code> - [[Juno Award|Juno]]
 +
* <code>Kerrang</code> - [[Kerrang! Awards|Kerrang!]]
 +
* <code>Mama</code> - [[Mnet Asian Music Awards|Mnet Asian Music]]
 +
* <code>MCA</code> - [[Mnet 20's Choice Awards|Mnet 20's Choice]]
 +
* <code>Melon</code> - [[Melon Music Awards|Melon Music]]
 +
* <code>Mercury</code> - [[Mercury Prizes]]
 +
* <code>Meteor</code> - [[Meteor Music Awards|Meteor Music]]
 +
* <code>MOBO</code> - [[Music of Black Origin Awards|MOBO]]
 +
* <code>MOJO</code> - [[MOJO Awards|MOJO]]
 +
* <code>MTVAfrica</code> - [[MTV Africa Music Awards|MTV Africa]]
 +
* <code>MTVAsia</code> - [[MTV Asia Awards|MTV Asia]]
 +
* <code>MTVAustralia</code> - [[MTV Australia Awards|MTV Australia]]
 +
* <code>MTVBrasil</code> - [[MTV Video Music Brasil|MTV Brazil]]
 +
* <code>MTVEurope</code> - [[MTV Europe Music Awards|MTV Europe]]
 +
* <code>MTVJapan</code> - [[MTV Video Music Awards Japan|MTV Japan]]
 +
* <code>MTVVideo</code> - [[MTV Video Music Awards|MTV VMA]]
 +
* <code>MuchMusic</code> - [[Much Music Video Awards|Much]]
 +
* <code>Muso</code> - [[Muso Awards|Muso]]
 +
* <code>MVPA</code> - MVPA Awards
 +
* <code>NAACP</code> - [[NAACP Image Awards|NAACP]]
 +
* <code>Nick</code> - [[Nickelodeon Kids' Choice Awards|Nickelodeon Kids' Choice]]
 +
* <code>NickAustralia</code> - [[Nickelodeon Australian Kids' Choice Awards|Nickelodeon Australian Kids' Choice]]
 +
* <code>NME</code> - [[NME Awards|NME]]
 +
* <code>NRJ</code> - [[NRJ Music Awards|NRJ]]
 +
* <code>NZMA</code> - [[New Zealand Music Awards|New Zealand]]
 +
* <code>Peoples</code> - [[People's Choice Awards|People's Choice]]
 +
* <code>PLUG</code> - [[PLUG Independent Music Awards|PLUG]]
 +
* <code>Polaris</code> - [[Polaris Music Prize|Polaris]]
 +
* <code>Q</code> - [[Q Awards|Q]]
 +
* <code>Radio</code> - [[Radio Music Awards|Radio Music]]
 +
* <code>Shortlist</code> - [[Shortlist Music Prize|Shortlist]]
 +
* <code>SMA</code> - [[Seoul Music Awards|Seoul Music]]
 +
* <code>Soul</code> - [[Soul Train Music Award|Soul Train]]
 +
* <code>Teen</code> - [[Teen Choice Awards|Teen Choice]]
 +
* <code>TMF</code> - [[TMF Awards (Belgium)|TMF]]
 +
* <code>VMALA</code> - [[Los Premios MTV Latinoamérica]]
 +
* <code>World</code> - [[World Music Awards|World Music]]
 +
{{hidden end}}
 +
 +
=== Award#, award#W, and award#N ===
 +
Adds an additional award not listed above to the bottom of the list, where # is any number from 1-20.  Use with Award#N and Award#W.
 +
<pre>| award1 = [[TRL Awards]]
 +
| award1W = 1
 +
| award1N = 0
 +
| award2 = [[Canadian Radio Music Awards|CRM Awards]]
 +
| award2W = 1
 +
| award2N = 0
 +
| award3 = [[UK Nickelodeon Kids' Choice Awards]]
 +
| award3W = 1
 +
| award3N = 0
 +
</pre>
 +
 +
=== Custom awards ===
 +
An additional way to add custom awards is to use {{tl|Custom award}} within the {{para|awards}} parameter. This method gives the user the ability to manipulate the order in which the awards appear; however, all awards within the custom parameter will appear at the very bottom of the awards list if other awards parameters are defined.
 +
<pre style="width:auto; overflow:auto">
 +
| awards      =
 +
{{Custom award|Award #1 name|wins|nominations}}
 +
{{Custom award|Award #2 name|wins|nominations}}
 +
</pre>
 +
The example infobox (right) uses <code><nowiki>| awards = {{Custom award|Award name|{{{2}}}|{{{3}}} }}</nowiki></code>
 
== Parameters ==
 
== Parameters ==
 
{| class="wikitable"
 
{| class="wikitable"
Line 28: Line 117:
 
! Status
 
! Status
 
|-
 
|-
| title
+
| title / name
| The title to be displayed.
+
| The title to be displayed. If using {{para|name}}, will display as "{{{name}}} awards and nominations"
 
| '''required'''
 
| '''required'''
 
|-
 
|-
Line 77: Line 166:
 
|-
 
|-
 
| awards
 
| awards
| Use {{tl|Infobox awards list/custom}} or {{tl|Custom award}} within this parameter to add awards to the list.
+
| Use {{tl|Custom award}} within this parameter to add awards to the list.
| '''required'''
+
| optional
 
|-
 
|-
 
|}
 
|}

Revision as of 14:00, 2 September 2019

{{Infobox awards list}} is used for awards lists to show a summary of notable awards won or nominated.

Usage

Template:Parameter names example

The infobox may be added by pasting the template as detailed below into an article, typically at the top of an article above the lead section.

Basic parameters

The following are the "basic" parameters that will be used in almost every infobox.

{{Infobox awards list
| title        = <!-- use "name = " to display "{{{name}}} awards and nominations"-->
| image        = 
| image_size   = 
| alt          = 
| caption      = 
| wins         = 
| nominations  = 
}}

Named awards

This template has a number of "named" awards. Each specifically named parameter corresponds to one specific award ceremony. The parameter includes a W or N to define the total number of awards won or nominated.

Example
|AmericanW = 0
|AmericanN = 1
|GrammyW = 3
|GrammyN = 2

The above example indicates that the group or artist American Music Award was nominated for 1 American Music Award, won 3 Grammy Awards, and was nominated for 2 Grammy Awards.

Full list of named awards

Award#, award#W, and award#N

Adds an additional award not listed above to the bottom of the list, where # is any number from 1-20. Use with Award#N and Award#W.

| award1 = [[TRL Awards]]
| award1W = 1
| award1N = 0
| award2 = [[Canadian Radio Music Awards|CRM Awards]]
| award2W = 1
| award2N = 0
| award3 = [[UK Nickelodeon Kids' Choice Awards]]
| award3W = 1
| award3N = 0

Custom awards

An additional way to add custom awards is to use {{Custom award}} within the |awards= parameter. This method gives the user the ability to manipulate the order in which the awards appear; however, all awards within the custom parameter will appear at the very bottom of the awards list if other awards parameters are defined.

| awards       = 
{{Custom award|Award #1 name|wins|nominations}}
{{Custom award|Award #2 name|wins|nominations}}

The example infobox (right) uses | awards = {{Custom award|Award name|{{{2}}}|{{{3}}} }}

Parameters

Parameter Description Status
title / name The title to be displayed. If using |name=, will display as "{{{name}}} awards and nominations" required
film Change wording from "Awards and nominations" to "Accolades" for films. Set to y. optional
nocollapse Display the list of awards without collapsing them. Set to y. optional
image An image, if needed. Wikilinking, "File:", and pixel size not required. optional
image_size Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. optional
alt Alt text for image per MOS:ALT. optional
total_width Use to scale the images to the same height and this total width. optional
image[n] (where [n] = 1 to 3)  Filename of [n]th image. optional
alt[n] (as above)  Alt description for [n]th image. optional
caption A caption explaining the image(s). optional
wins The total number of awards won. required
nominations The total number of nominations, including those won. required
awards Use {{Custom award}} within this parameter to add awards to the list. optional

Tracking category