Difference between revisions of "Template:Infobox awards list/doc"
imported>Zackmann08 (updating documentation\) |
imported>Empire AS (→Parameters: Corrected) |
||
| (16 intermediate revisions by 8 users not shown) | |||
| 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}} | ||
| − | |||
== Usage == | == Usage == | ||
| − | The infobox may be added by pasting the template as | + | {{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 | AcademyN | AcademyW | AmericanN | AmericanW | APRAN | APRAW | ARIAN | ARIAW | ASFN | ASFW | award1 | award1N | award1W | award2 | award2N | award2W | award3=... | award3N=... | award3W=... | award20 | award20N | award20W | BAFTAN | BAFTAW | BerlinN | BerlinW | BETHHN | BETHHW | BETN | BETW | BFJAN | BFJAW | BillboardN | BillboardW | BollywoodMovieN | BollywoodMovieW | BostonFilmN | BostonFilmW | BRITN | BRITW | BroadcastFilmN | BroadcastFilmW | caption | ChicagoFilmN | ChicagoFilmW | ChicagoInternationalN | ChicagoInternationalW | CMTMAN | CMTMAW | collapse | customs | CyworldN | CyworldW | ECHON | ECHOW | EmmyN | EmmyW | film | FilmfareN | FilmfareW | FloridaFilmN | FloridaFilmW | GDAN | GDAW | GenieN | GenieW | GGAN | GGAW | GlobalIndianN | GlobalIndianW | GoldenGlobeN | GoldenGlobeW | GrammyN | GrammyW | HUMN | HUMW | IFFMN | IFFMW | IIFAN | IIFAW | IndependentN | IndependentW | IrishFilmN | IrishFilmW | IvorN | IvorW | JackN | JackW | JN | JunoN | JunoW | JW | KerrangN | KerrangW | LAFilmN | LAFilmW | LondonFilmN | LondonFilmW | LSAN | LSAW | 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 | MTVMovieN | MTVMovieW | MTVVideoN | MTVVideoW | MuchMusicN | MuchMusicW | MusoN | MusoW | MVPAN | MVPAW | NAACPN | NAACPW | name | NationalBoardN | NationalBoardW | NationalFilmN | NationalFilmW | NationalSocietyN | NationalSocietyW | NickAustraliaN | NickAustraliaW | NickN | NickW | NigarN | NigarW | NMEN | NMEW | nocollapse | nominations | NRJN | NRJW | NYFilmN | NYFilmW | NZMAN | NZMAW | OnlineFilmN | OnlineFilmW | PeopleN | PeoplesN | PeoplesW | PeopleW | PLUGN | PLUGW | PMAN | PMAW | PolarisN | PolarisW | QN | QW | RadioN | RadioW | SatelliteN | SatelliteW | SaturnN | SaturnW | ScreenActorsN | ScreenActorsW | ScreenN | ScreenW | ShortlistN | ShortlistW | SMAN | SMAW | SoulN | SoulW | StardustN | StardustW | StarGuildN | StarGuildW | TeenN | TeenW | title | TMFN | TMFW | total_width | VMALAN | VMALAW | wins | WorldN | WorldW | ZeeCineN | ZeeCineW}} |
| + | |||
| + | 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. Organizations without a Wikipedia page are not included in list of accolades per [[WP:FILMCRITICLIST]]. | ||
| + | |||
| + | ===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 "List of awards and nominations received by {{{name}}}"--> |
| image = | | image = | ||
| image_size = | | image_size = | ||
| Line 16: | Line 20: | ||
| wins = | | wins = | ||
| nominations = | | 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 |titlestyle=font-size:120%; |title=Full list of named awards}} | ||
| + | * <code>Academy</code> - [[Academy Awards]] | ||
| + | * <code>American</code> - [[American Music Award]]s | ||
| + | * <code>APRA</code> - [[Australasian Performing Right Association#APRA Awards|APRA]] | ||
| + | * <code>Apsara</code> - [[Producers Guild Film Awards|Apsara Film & Television Producers Guild Award]] | ||
| + | * <code>ARIA</code> - [[ARIA Music Awards|ARIA]] | ||
| + | * <code>ARYFilm</code> - [[ARY Film Awards]] | ||
| + | * <code>ASF</code> - [[Asia Song Festival]] | ||
| + | * <code>BAFTA</code> - [[British Academy Film Awards|BAFTA Awards]] | ||
| + | * <code>Berlin</code> - [[Berlin International Film Festival]] | ||
| + | * <code>BET</code> - [[BET Awards|BET]] | ||
| + | * <code>BETHH</code> - [[BET Hip Hop Awards|BET Hip Hop]] | ||
| + | * <code>BFJA</code> - [[Bengal Film Journalists' Association Awards|BFJA Awards]] | ||
| + | * <code>Billboard</code> - [[Billboard Music Award|Billboard]] | ||
| + | * <code>BollywoodMovie</code> - [[Bollywood Movie Awards]] | ||
| + | * <code>BostonFilm</code> - [[Boston Society of Film Critics]] | ||
| + | * <code>BRIT</code> - [[Brit Awards|Brit]] | ||
| + | * <code>BroadcastFilm</code> - [[Critics' Choice Movie Awards|Broadcast Film Critics Association Awards]] | ||
| + | * <code>ChicagoFilm</code> - [[Chicago Film Critics Association]] | ||
| + | * <code>ChicagoInternational</code> - [[Chicago International Film Festival]] | ||
| + | * <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>Emmy</code> - [[Emmy Awards]] | ||
| + | * <code>Filmfare</code> - [[Filmfare Awards]] | ||
| + | * <code>FloridaFilm</code> - [[Florida Film Critics Circle]] | ||
| + | * <code>GDA</code> - [[Golden Disk Awards|Golden Disk]] | ||
| + | * <code>Genie</code> - [[Genie Awards]] | ||
| + | * <code>GGA</code> - [[Golden Globe Award|Golden Globe]] | ||
| + | * <code>GlobalIndian</code> - [[Global Indian Film Awards|GIFA Awards]] | ||
| + | * <code>GoldenGlobe</code> - [[Golden Globe Awards]] | ||
| + | * <code>Grammy</code> - [[Grammy Award|Grammy]] | ||
| + | * <code>HUM</code> - [[Hum Awards]] | ||
| + | * <code>IFFM</code> - [[Indian Film Festival of Melbourne]] | ||
| + | * <code>IIFA</code> - [[International Indian Film Academy Awards|IIFA Awards]] | ||
| + | * <code>Independent</code> - [[Independent Spirit Awards]] | ||
| + | * <code>IrishFilm</code> - [[Irish Film & Television Academy|Irish Film and Television Awards]] | ||
| + | * <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>LAFilm</code> - [[Los Angeles Film Critics Association]] | ||
| + | * <code>LondonFilm</code> - [[London Film Critics' Circle]] | ||
| + | * <code>LSA</code> - [[Lux Style Awards]] | ||
| + | * <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>MTVMovie</code> - [[MTV Movie & TV Awards]] | ||
| + | * <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>NationalBoard</code> - [[National Board of Review]] | ||
| + | * <code>NationalFilm</code> - [[National Film Awards]] | ||
| + | * <code>NationalSociety</code> - [[National Society of Film Critics]] | ||
| + | * <code>Nick</code> - [[Nickelodeon Kids' Choice Awards|Nickelodeon Kids' Choice]] | ||
| + | * <code>NickAustralia</code> - [[Nickelodeon Australian Kids' Choice Awards|Nickelodeon Australian Kids' Choice]] | ||
| + | * <code>Nigar</code> - [[Nigar Awards]] | ||
| + | * <code>NME</code> - [[NME Awards|NME]] | ||
| + | * <code>NRJ</code> - [[NRJ Music Awards|NRJ]] | ||
| + | * <code>NYFilm</code> - [[New York Film Critics Circle|New York Film Critics Circle Awards]] | ||
| + | * <code>NZMA</code> - [[New Zealand Music Awards|New Zealand]] | ||
| + | * <code>OnlineFilm</code> - [[Online Film Critics Society]] | ||
| + | * <code>People</code> - [[E! People's Choice Awards|People's Choice Awards]] | ||
| + | * <code>Peoples</code> - [[People's Choice Awards|People's Choice]] | ||
| + | * <code>PLUG</code> - [[PLUG Independent Music Awards|PLUG]] | ||
| + | * <code>PMA</code> - [[Pakistan Media Awards]] | ||
| + | * <code>Polaris</code> - [[Polaris Music Prize|Polaris]] | ||
| + | * <code>Q</code> - [[Q Awards|Q]] | ||
| + | * <code>Radio</code> - [[Radio Music Awards|Radio Music]] | ||
| + | * <code>Satellite</code> - [[Satellite Awards]] | ||
| + | * <code>Saturn</code> - [[Saturn Awards]] | ||
| + | * <code>Screen</code> - [[Screen Awards]] | ||
| + | * <code>ScreenActors</code> - [[Screen Actors Guild Awards]] | ||
| + | * <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>Stardust</code> - [[Stardust Awards]] | ||
| + | * <code>StarGuild</code> - [[Producers Guild Film Awards|Star Guild Awards]] | ||
| + | * <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]] | ||
| + | * <code>ZeeCine</code> - [[Zee Cine Awards]] | ||
| + | {{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 == | ||
| Line 28: | Line 159: | ||
! Status | ! Status | ||
|- | |- | ||
| − | | title | + | | title / name |
| − | | The title to be displayed. | + | | The title to be displayed. If using {{para|name}}, will display as "List of awards and nominations received by {{{name}}}" |
| '''required''' | | '''required''' | ||
|- | |- | ||
| Line 45: | Line 176: | ||
|- | |- | ||
| image_size | | image_size | ||
| − | | Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. | + | | '''Deprecated; see [[MOS:UPRIGHT]]'''. Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. |
| + | | optional | ||
| + | |- | ||
| + | | image_upright | ||
| + | | Image size via image scaling. Enter the width through adding a number greater than 1; decimals may be used. | ||
| optional | | optional | ||
|- | |- | ||
| Line 73: | Line 208: | ||
|- | |- | ||
| nominations | | nominations | ||
| − | | The total number of nominations, including those won. | + | | The total number of nominations, not including those won. |
| '''required''' | | '''required''' | ||
|- | |- | ||
| awards | | awards | ||
| − | | Use {{tl| | + | | Use {{tl|Custom award}} within this parameter to add awards to the list. |
| − | | | + | | optional |
|- | |- | ||
|} | |} | ||
==Tracking category== | ==Tracking category== | ||
| − | *{{ | + | *{{Category link with count|Pages using infobox awards list with unknown parameters}} |
| + | |||
| + | {{Film- and television-related infobox templates}} | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other|| |
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
| − | [[Category: | + | [[Category:Award infobox templates]] |
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 10:21, 26 December 2020
| This is a documentation subpage for Template:Infobox awards list. It contains usage information, categories and other content that is not part of the original template page. |
{{Infobox awards list}} is used for awards lists to show a summary of notable awards won or nominated.
| This template uses Lua: |
Contents
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. Organizations without a Wikipedia page are not included in list of accolades per WP:FILMCRITICLIST.
Basic parameters
The following are the "basic" parameters that will be used in almost every infobox.
{{Infobox awards list
| title = <!-- use "name = " to display "List of awards and nominations received by {{{name}}}"-->
| 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.
Academy- Academy AwardsAmerican- American Music AwardsAPRA- APRAApsara- Apsara Film & Television Producers Guild AwardARIA- ARIAARYFilm- ARY Film AwardsASF- Asia Song FestivalBAFTA- BAFTA AwardsBerlin- Berlin International Film FestivalBET- BETBETHH- BET Hip HopBFJA- BFJA AwardsBillboard- BillboardBollywoodMovie- Bollywood Movie AwardsBostonFilm- Boston Society of Film CriticsBRIT- BritBroadcastFilm- Broadcast Film Critics Association AwardsChicagoFilm- Chicago Film Critics AssociationChicagoInternational- Chicago International Film FestivalCMTMA- CMTCyworld- Cyworld Digital MusicECHO- EchoEmmy- Emmy AwardsFilmfare- Filmfare AwardsFloridaFilm- Florida Film Critics CircleGDA- Golden DiskGenie- Genie AwardsGGA- Golden GlobeGlobalIndian- GIFA AwardsGoldenGlobe- Golden Globe AwardsGrammy- GrammyHUM- Hum AwardsIFFM- Indian Film Festival of MelbourneIIFA- IIFA AwardsIndependent- Independent Spirit AwardsIrishFilm- Irish Film and Television AwardsIvor- Ivor NovelloJ- JJack- JackJuno- JunoKerrang- Kerrang!LAFilm- Los Angeles Film Critics AssociationLondonFilm- London Film Critics' CircleLSA- Lux Style AwardsMama- Mnet Asian MusicMCA- Mnet 20's ChoiceMelon- Melon MusicMercury- Mercury PrizesMeteor- Meteor MusicMOBO- MOBOMOJO- MOJOMTVAfrica- MTV AfricaMTVAsia- MTV AsiaMTVAustralia- MTV AustraliaMTVBrasil- MTV BrazilMTVEurope- MTV EuropeMTVJapan- MTV JapanMTVMovie- MTV Movie & TV AwardsMTVVideo- MTV VMAMuchMusic- MuchMuso- MusoMVPA- MVPA AwardsNAACP- NAACPNationalBoard- National Board of ReviewNationalFilm- National Film AwardsNationalSociety- National Society of Film CriticsNick- Nickelodeon Kids' ChoiceNickAustralia- Nickelodeon Australian Kids' ChoiceNigar- Nigar AwardsNME- NMENRJ- NRJNYFilm- New York Film Critics Circle AwardsNZMA- New ZealandOnlineFilm- Online Film Critics SocietyPeople- People's Choice AwardsPeoples- People's ChoicePLUG- PLUGPMA- Pakistan Media AwardsPolaris- PolarisQ- QRadio- Radio MusicSatellite- Satellite AwardsSaturn- Saturn AwardsScreen- Screen AwardsScreenActors- Screen Actors Guild AwardsShortlist- ShortlistSMA- Seoul MusicSoul- Soul TrainStardust- Stardust AwardsStarGuild- Star Guild AwardsTeen- Teen ChoiceTMF- TMFVMALA- Los Premios MTV LatinoaméricaWorld- World MusicZeeCine- Zee Cine 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 "List of awards and nominations received by {{{name}}}"
|
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 | Deprecated; see MOS:UPRIGHT. Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. | optional |
| image_upright | Image size via image scaling. Enter the width through adding a number greater than 1; decimals may be used. | 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, not including those won. | required |
| awards | Use {{Custom award}} within this parameter to add awards to the list. | optional |
Tracking category