View source for Template:Infobox award/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{auto short description|conditions=when the infobox is in the lead}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Wikidata|Module:Check for unknown parameters}}
{{Uses Wikidata|P17|P18|P856|P1027}}

'''Infobox award''' may be used to summarize information about an award.

{{Parameter names example
| name
| subheader = {{{subheader}}} or {{{current_awards}}}
| image
| image_size
| image_upright
| alt
| caption
| awarded_for
| sponsor
| date
| location = {{{location}}} or {{{venue}}} or {{{site}}}
| site
| country
| presenter
| eligibility
| post-nominals
| ribbon
| obverse
| reverse
| host = {{{host}}} or {{{hosts}}}
| former name
| preshow_host
| acts
| campaign
| motto
| clasps
| reward 
| year
| year2
| holder_label
| holder = {{{holder}}} or {{{winner}}} or {{{winners}}}
| most_awards = {{{most_awards}}} or {{{most_wins}}}
| most_nominations
| award1_type
| award1_winner
| award2_type
| award2_winner
| award3_type
| award3_winner
| award4_type
| award4_winner
| award5_type
| award5_winner
| website
| coverage
| network = {{{network}}} or {{{network_list}}}
| runtime
| viewership = {{{viewership}}} or {{{ratings}}}
| producer
| director
| image2
| image2_size
| image_upright2
| alt2
| caption2
| precedence_label
| individual
| higher
| same
| lower
| related
| previous
| main
| next
}}

==Usage==
The infobox may be added by pasting the template as shown below into an article. All fields are optional and unused parameter names can be left blank or omitted.

<syntaxhighlight lang="wikitext" style="overflow:auto; white-space:pre;">
{{Infobox award
| name             = 
| subheader        = <!-- or | current_awards = -->
| image            = 
| image_size       = <!-- or | image_upright = -->
| alt              = 
| caption          = 
| awarded_for      = 
| sponsor          = 
| date             = <!-- {{start date|YYYY|MM|DD}} -->
| location         = <!-- or | venue = or | site = -->
| country          = 
| presenter        = 
| eligibility      =
| post-nominals    = 
| ribbon           =
| obverse          =
| reverse          =
| host             = <!-- or | hosts = -->
| former name      = 
| preshow_host     = 
| acts             = 
| campaign         = 
| motto            = 
| clasps           = 
| reward           = 
| year             = 
| year2            = 
| holder_label     = 
| holder           = <!-- or | winner = or | winners = -->
| most_awards      = <!-- or | most_wins = -->
| most_nominations = 
| award1_type      = 
| award1_winner    = 
| award2_type      = 
| award2_winner    = 
| award3_type      = 
| award3_winner    = 
| award4_type      = 
| award4_winner    = 
| award5_type      = 
| award5_winner    = 
| website          = <!-- {{URL|example.com}} -->
| coverage         = 
| network          = <!-- or | network_list = -->
| runtime          = 
| viewership       = <!-- or | ratings = -->
| producer         = 
| director         = 
| image2           = 
| image2_size      = <!-- or | image_upright2 -->
| alt2             = 
| caption2         = 
| precedence_label = 
| individual       = 
| higher           = 
| same             = 
| lower            = 
| related          = 
| previous         = 
| main             = 
| next             = 
}}
</syntaxhighlight>

==Parameters==
{{div col}}
; name
: name of the award. Use the common name (typically the name of the article) if multiple names are used. If omitted or blank it defaults to the name of the article.
; subheader {{nobold|or}} current_awards
: if subheader is used, this field is bypassed, if it is not used, insert the article name of the list or page describing the upcoming, current, or just completed annual awards/ceremony, etc. for this year. Omit the wikilinks "<nowiki>[[]]</nowiki>"; formatting is automatic, and an image icon is included
; image
: image name (abc.jpg, xyz.png, 123.gif, etc.)
; image_size {{nobold|or}} image_upright
: image size or upright scaling factor; see [[WP:IMAGESIZE]].
; alt
: alt text for image, for visually impaired readers who cannot see it. See [[WP:ALT]].
; caption
: text for caption; rendered below image.
; awarded_for
: a very brief, one sentence description of what the prize is awarded for (e.g. "Excellence in [[film]]")
; sponsor
: the person, group or organisation that monetarily sponsors the award
; date
: the date of the award ceremony. Use the {{tl|Start date}} template.
; location {{nobold|or}} venue {{nobold|or}} site
: the venue where the award ceremony was held.
; country
: the country of the presenter or where the award is presented
; presenter
: the person, group or organisation that presents the award
; eligibility
: those eligible for the award, if a restricted group
; post-nominals
: [[post-nominal letters]] associated with the award
; ribbon
: description of decorative ribbon associated with the award
; obverse
: description of the [[wikt:obverse|obverse]] of the associated medal, if any
; reverse
: description of the reverse of the associated medal, if any
; host {{nobold|or}} hosts
: the person(s) who hosted the award ceremony.
; former name
: previous name of the award, if any
; preshow_host
: name of the pre-show host.
; acts
: wikified names of acts scheduled to perform.
; reward
: prize money or medal accompanying the award
; year
: the year that it was first awarded
; year2
: the year that it was last awarded
; holder_label
: optional, changes label for next field
; holder {{nobold|or}} winner {{nobold|or}} winners
: current holder of the award (if applicable)
; most_awards {{nobold|or}} most_wins
: nominee or series who/which has won the most awards
; most_nominations
: nominee or series who/which has had the most nominations
; award1_type {{nobold|through}} award5_type
: label for a numbered sub-award; see also the following field
; award1_winner {{nobold|through}} award5_winner
: winner of numbered sub-award
; website
: the award's official website. Use {{tl|URL}}.
; coverage
: to specify the type of coverage; defaults to "Radio/television"
; network {{nobold|or}} network_list
: the name of the television network which originally aired the award ceremony
; viewership {{nobold|or}} ratings
: ratings figures for the television airing
; runtime
: the approximate runtime of the television airing (should not include commercials) in minutes, eg. "44 minutes"
; producer
: show's producer
; director
: show's director
; image2
: image name for bottom image if used, i.e. (abc.jpg, xyz.png, 123.gif, etc.)
; image2_size {{nobold|or}} image_upright2
: image size or upright scaling factor.
; alt2
: alt text for image2, for visually impaired readers who cannot see it. See [[WP:ALT]].
; caption2
: text for caption2; rendered below image2.
; previous
: for creating a chronology. Insert a link to the article of the previous edition of the award. Pipe the link to only show the year or edition number, eg. <code><nowiki>[[50th Grammy Awards|50th]]</nowiki></code>
; main
: for creating a chronology. Insert the link to the award's main article, eg. if this infobox was placed on [[51st Grammy Awards]], the main article would be [[Grammy Award]].
; next
: for creating a chronology. Insert a link to the article of the next edition of the award. Pipe the link to only show the year or edition number, eg. <code><nowiki>[[52nd Grammy Awards|52nd]]</nowiki></code>
{{div col end}}

== Microformat ==
{{UF-hcal}}

== Tracking categories ==
* {{clc|Pages using infobox award with unknown parameters}}

== See also ==
* {{tl|Infobox order}}
* {{tl|Awards}}

{{Film- and television-related infobox templates}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Award infobox templates| ]]
[[Category:Infobox templates using Wikidata]]
[[Category:Templates that add a tracking category]]
}}</includeonly>
<templatedata>
{
	"params": {
		"subheader": {
			"label": "Subheader",
			"description": "overrides 'current_awards'; use to make a subheader, for example with native name"
		},
		"current_awards": {
			"label": "Current awards",
			"description": "if subheader is used, this field is bypassed, if it is not used, put the article name here of the list or page describing the upcoming, current, or just completed annual awards/ceremony, etc. for this year. Omit the wikilinks \"[[]]\"; formatting is automatic, and an image icon is included",
			"example": "66th Annual Grammy Awards",
			"type": "wiki-page-name",
			"suggested": true
		},
		"location": {
			"aliases": [
				"venue",
				"site"
			],
			"label": "Location",
			"description": "the venue where the award ceremony was held."
		},
		"venue": {},
		"site": {},
		"host": {
			"aliases": [
				"hosts"
			],
			"label": "Host(s)",
			"description": "the person(s) who hosted the award ceremony."
		},
		"hosts": {},
		"holder": {
			"aliases": [
				"winner",
				"winners"
			],
			"label": "Holder",
			"description": "current holder of the award (if applicable)"
		},
		"winner": {},
		"winners": {},
		"most_awards": {
			"aliases": [
				"most_wins"
			],
			"label": "Most awards/wins",
			"description": "nominee or series who/which has won the most awards"
		},
		"most_wins": {},
		"network": {
			"aliases": [
				"network_list"
			],
			"label": "Network",
			"description": "the name of the television network which originally aired the award ceremony"
		},
		"viewership": {
			"aliases": [
				"ratings"
			],
			"label": "Viewership",
			"description": "ratings figures for the television airing"
		},
		"ratings": {},
		"name": {
			"label": "Name",
			"description": "name of the award. Use the common name (typically the name of the article) if multiple names are used. If omitted or blank it defaults to the name of the article.",
			"suggested": true
		},
		"image": {
			"label": "Image",
			"description": "file name (abc.jpg, xyz.png, 123.gif, etc.)",
			"type": "wiki-file-name",
			"suggested": true
		},
		"image_size": {
			"label": "Image size",
			"description": "image size or upright scaling factor; see WP:IMAGESIZE. Except with very good reason, do not use px (e.g. |thumb|300px), which forces a fixed image width measured in pixels, disregarding the user's image size preference setting"
		},
		"alt": {
			"label": "Alternative image text",
			"description": "alt text for image, for visually impaired readers who cannot see it. See WP:ALT."
		},
		"caption": {
			"label": "Caption",
			"description": "text for caption; rendered below image."
		},
		"awarded_for": {
			"label": "Awarded for",
			"description": "a very brief, one sentence description of what the prize is awarded for (e.g. \"Excellence in film\")",
			"suggested": true
		},
		"sponsor": {
			"label": "Sponsor",
			"description": "the person, group or organisation that monetarily sponsors the award",
			"suggested": true
		},
		"date": {
			"label": "Date",
			"description": "the date of the award ceremony. Use the {{Start date}} template."
		},
		"country": {
			"label": "Country",
			"description": "the country of the presenter or where the award is presented"
		},
		"presenter": {
			"label": "Presenter",
			"description": "the person, group or organisation that presents the award"
		},
		"eligibility": {
			"label": "Eligibility",
			"description": "those eligible for the award, if a restricted group"
		},
		"post-nominals": {
			"label": "Post-nominals",
			"description": "post-nominal letters associated with the award"
		},
		"former name": {
			"label": "Former name",
			"description": "previous name of the award, if any"
		},
		"reward": {
			"label": "Reward",
			"description": "prize money or medal accompanying the award"
		},
		"year": {
			"label": "Year first awarded",
			"description": "the year that it was first awarded",
			"type": "date"
		},
		"year2": {
			"label": "Year last awarded",
			"description": "the year that it was last awarded",
			"type": "date"
		},
		"holder_label": {
			"label": "Holder label",
			"description": "optional, changes label for next field"
		},
		"website": {
			"label": "Website",
			"description": "the award's official website. Use {{URL}}.",
			"type": "url"
		},
		"next": {
			"label": "Next",
			"description": "for creating a chronology. Insert a link to the article of the next edition of the award. Pipe the link to only show the year or edition number, eg. [[52nd Grammy Awards|52nd]]"
		},
		"main": {
			"label": "Main",
			"description": "for creating a chronology. Insert the link to the award's main article, eg. if this infobox was placed on 51st Grammy Awards, the main article would be Grammy Award."
		},
		"previous": {
			"label": "Previous",
			"description": "for creating a chronology. Insert a link to the article of the previous edition of the award. Pipe the link to only show the year or edition number, eg. [[50th Grammy Awards|50th]]"
		},
		"most_nominations": {
			"label": "Most nominations",
			"description": "nominee or series who/which has had the most nominations"
		},
		"ribbon": {},
		"obverse": {},
		"reverse": {},
		"preshow_host": {},
		"acts": {},
		"award1_type": {
			"description": "label for a numbered sub-award; see also the following field"
		},
		"award1_winner": {
			"description": "winner of numbered sub-award"
		},
		"award2_type": {},
		"award2_winner": {},
		"award3_type": {},
		"award3_winner": {},
		"award4_type": {},
		"award4_winner": {},
		"award5_type": {},
		"award5_winner": {},
		"coverage": {
			"label": "Coverage",
			"description": "to specify the type of coverage; defaults to \"Radio/television\""
		},
		"runtime": {},
		"producer": {},
		"director": {},
		"image2": {},
		"image2_size": {},
		"alt2": {},
		"caption2": {},
		"image_upright2": {},
		"image_upright": {
			"label": "Image upright",
			"description": "upright scaling factor if set to anything but blank",
			"suggestedvalues": [
				"yes"
			]
		}
	},
	"description": "Used to summarize information about an award.",
	"paramOrder": [
		"name",
		"subheader",
		"current_awards",
		"image",
		"image_size",
		"image_upright",
		"alt",
		"caption",
		"awarded_for",
		"sponsor",
		"date",
		"location",
		"country",
		"presenter",
		"eligibility",
		"post-nominals",
		"venue",
		"site",
		"host",
		"former name",
		"hosts",
		"holder",
		"holder_label",
		"winner",
		"winners",
		"most_awards",
		"most_nominations",
		"most_wins",
		"network",
		"viewership",
		"ratings",
		"reward",
		"year",
		"year2",
		"coverage",
		"website",
		"next",
		"main",
		"previous",
		"ribbon",
		"obverse",
		"reverse",
		"preshow_host",
		"acts",
		"award1_type",
		"award1_winner",
		"award2_type",
		"award2_winner",
		"award3_type",
		"award3_winner",
		"award4_type",
		"award4_winner",
		"award5_type",
		"award5_winner",
		"runtime",
		"producer",
		"director",
		"image2",
		"image2_size",
		"image_upright2",
		"alt2",
		"caption2"
	],
	"format": "block"
}
</templatedata>