View source for Template:Infobox film awards/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Lua|Module:InfoboxImage|Module:Check for unknown parameters}}

This template may be used within an article about a particular film-, television- or film-and-television awards event.

== Usage ==
{{Parameter names example|name|year|number|award|image|image_size|alt|caption|awarded_for|award_org|presenting_org|announced_date|presented_date|date|site|host|preshow|producer|director|organizer|organiser|magazine_issue|website|lifetime_achievement|best_picture|best_film|film|best_film_drama|best_film_musical_or_comedy|best_drama_series|best_musical_or_comedy_series|best_miniseries_tv_movie|most_awards|most_wins|most_nominations|best_direction|direction|best_actor|actor|best_actress|actress|free_award|best_british|best_film_comedy|best_film_musical|best_film_jury_choice|best_film_jury|best_film_viewers_choice|best_film_viewers|best_feature|best_feature_film|best_non_feature|best_non_feature_film|best_comedy_series|best_drama_serial|best_drama_serial_popular|best_tv_movie|best_miniseries_or_tv_movie|best_tv_show|free_award_type|best_direction_film|direction_film|best_director|best_director_film|best_actor_film|actor_film|best_actor_show|best_actress_film|actress_film|best_actress_show|best_supporting_actor|supporting_actor|best_supporting_actor_film|supporting_actor_film|best_supporting_actress|supporting_actress|best_supporting_actress_film|supporting_actress_film|best_comedy_perform1|best_comedy_perform1_show|best_comedy_perform2|best_comedy_perform2_show|best_book|book|best_critic|critic|gold_award|gold|hall_of_fame|channel|network|duration|viewership|ratings|last|next|last_link|award_link|next_link}}

<pre style="overflow:auto">
{{Infobox film awards
| number                       = 
| award                        = 
| image                        = 
| caption                      = 
| awarded_for                  = 
| award_org                    = 
| presenting_org               = 
| announced_date               = <!-- {{Start date|YYYY|MM|DD}} -->
| presented_date               = <!-- {{Start date|YYYY|MM|DD}} -->
| date                         = <!-- {{Start date|YYYY|MM|DD}} -->
| site                         = 
| host                         = 
| preshow                      = 
| producer                     = 
| director                     = 
| organizer                    = 
| magazine_issue               = 
| website                      = 
| lifetime_achievement         = 
| best_picture                 = <!-- or best_film -->
| best_film                    = <!-- or best_picture -->
| best_film_jury_choice        = 
| best_film_viewers_choice     = 
| best_feature                 = 
| best_non_feature             = 
| best_british                 = 
| best_drama_serial_popular    = 
| best_drama_serial            = 
| best_direction               = 
| best_direction_film          = 
| best_actor                   = 
| best_actor_film              = 
| best_actress                 = 
| best_actress_film            = 
| best_book                    = 
| best_critic                  = 
| gold_award                   = 
| hall_of_fame                 = 
| free_award_type              = 
| free_award                   = 
| most_awards                  = 
| most_nominations             = 
| channel                      = 
| network                      = 
| duration                     = 
| viewership                   = <!-- or ratings -->
| ratings                      = <!-- or viewership -->
| last                         = 
| next                         = 
}}
</pre>

== Parameters ==
All fields are optional except for <code>name</code>/<code>number</code> and <code>award</code>.
Link people only if they have articles. For most of the fields below, if there are multiple entries, separate them using {{Tl|Plainlist}} or {{Tl|Unbulleted list}}.

{| class="wikitable"
! style="text-align:left;" | Parameter
! style="text-align:left;" | Explanation
|-
| <code>name</code>
| The name of the awards ceremony (only required if <code>number</code> is not used).
|-
| <code>number</code>
| The number of the awards ceremony in the form of ''X'' for the Xth award ceremony (only required if <code>name</code> is not used).
|-
| <code>award</code>
| The name of the award e.g., Academy Awards (required). The article will be wikilinked automatically.
|-
| <code>award_link</code>
| Article describing the award
|-
| <code>image</code>
| Insert a relevant image for the ceremony. Ideally this should be an event poster. Adding a ''film poster'' of the Best Picture winner <u>violates</u> rule #8 of [[WP:FUC|Wikipedia's fair use criteria]]. Only use the actual file name, i.e. {{para|image|[[:File:Forrest Gump poster.jpg|Forrest Gump poster.jpg]]}}. See [[#Image]] for further guidelines.
|-
| <code>caption</code>
| Insert image caption, which should describe the type of image used.
|-
| <code>awarded_for</code>
| 
|-
| <code>award_org</code>
| Insert the award organization.
|-
| <code>presenting_org</code>
| Insert the award organization.
|-
| <code>announced_date</code>
| Insert the date the awards were announced on. Use {{Tl|Start date}} (e.g. <nowiki>{{Start date|1981|02|26}}</nowiki>) so that the date is included the template's [[hCalendar]] microformat, and is properly formatted according to a reader's Wikipedia date and time [[Special:Preferences|preferences]].
|-
| <code>presented_date</code>
| Insert the date of the ceremony. Use {{Tl|Start date}} (e.g. <nowiki>{{Start date|1981|02|26}}</nowiki>) so that the date is included the template's [[hCalendar]] microformat, and is properly formatted according to a reader's Wikipedia date and time [[Special:Preferences|preferences]].
|-
| <code>date</code>
| Insert the date of the ceremony. Use {{Tl|Start date}} (e.g. <nowiki>{{Start date|1981|02|26}}</nowiki>) so that the date is included the template's [[hCalendar]] microformat, and is properly formatted according to a reader's Wikipedia date and time [[Special:Preferences|preferences]].
|-
| <code>site</code>
| Insert the site of the ceremony, in the form ''building, city, country''. For multiple sites: <code>building_1</code>, <code>city_1</code> and <code>building_2</code>, <code>city_2</code>.
|-
| <code>host</code>
| Insert the ceremony's host(s). If multiple entries are required, separate using {{Tl|Plainlist}}.
|-
| <code>preshow</code>
| Insert the ceremony's Pre-Show host(s). If multiple entries are required, separate using {{Tl|Plainlist}}.
|-
| <code>producer</code>
| Insert the ceremony's producer(s). If multiple entries are required, separate using {{Tl|Plainlist}}.
|-
| <code>director</code>
| Insert the ceremony's director(s). If multiple entries are required, separate using {{Tl|Plainlist}}.
|-
| <code>organizer</code>
| 
|-
| <code>magazine_issue</code>
| Insert the magazine issue number the ceremony was published in.
|-
| <code>website</code>
| Insert the ceremony's official website.
|-
<!----------Highlights-specific---------->
! scope="col" colspan="2" style="background; text-align:center;"| Highlights-specific
|-
| <code>lifetime_achievement</code>
| Insert the ceremony's Lifetime achievement winner.
|-
| <code>best_picture</code>
| Insert the ceremony's Best Picture winner (do not use both <code>best_picture</code> and <code>best_film</code>).
|-
| <code>best_picture_link</code>
|
|-
| <code>best_film</code>
| Insert the ceremony's Best Film winner (do not use both <code>best_film</code> and <code>best_picture</code>).
|-
| <code>best_film_link</code>
|
|-
| {{Unbulleted list|<code>best_film_jury_choice</code>|(<code>best_film_jury</code>)}}
| Insert the ceremony's Best Film: Jury's choice winner.
|-
| {{Unbulleted list|<code>best_film_viewers_choice</code>|(<code>best_film_viewers</code>)}}
| Insert the ceremony's Best Film: Viewers' choice winner.
|-
| {{Unbulleted list|<code>best_feature</code>|(<code>best_feature_film</code>)}}
| Insert the ceremony's Best Feature Film winner.
|-
| {{Unbulleted list|<code>best_non_feature</code>|(<code>best_non_feature_film</code>)}}
| Insert the ceremony's Best Non-feature Film winner.
|-
| <code>best_british</code>
| Insert the ceremony's Best British Film winner.
|-
| <code>best_drama_serial_popular</code>
| Insert the ceremony's Best Drama Serial Popular winner.
|-
| <code>best_drama_serial</code>
| Insert the ceremony's Best Drama Serial winner.
|-
| <code>best_direction</code>
| Insert the ceremony's Best Director winner.
|-
| <code>best_direction_film</code>
| Insert the ceremony's Best Director winner's film.
|-
| <code>best_actor</code>
| Insert the ceremony's Best Actor winner.
|-
| <code>best_actor_film</code>
| Insert the ceremony's Best Actor winner's film.
|-
| <code>best_actor_link</code>
|
|-
| <code>best_actress</code>
| Insert the ceremony's Best Actress winner.
|-
| <code>best_actress_film</code>
| Insert the ceremony's Best Actress winner's film.
|-
| <code>best_actress_link</code>
|
|-
| {{Unbulleted list|<code>best_book</code>|(<code>book</code>)}}
| 
|-
| {{Unbulleted list|<code>best_critic</code>|(<code>critic</code>)}}
| 
|-
| <code>gold_award</code>
| Insert the ceremony's Gold award winner.
|-
| <code>hall_of_fame</code>
| Insert the ceremony's Hall of Fame winner.
|-
| <code>free_award_type</code>
|
|-
| <code>free_award</code>
|
|-
| {{Unbulleted list|<code>most_awards</code>|(<code>most_wins</code>)}}
| Insert the ceremony's film(s) that won the most awards.
|-
| <code>most_nominations</code>
| Insert the ceremony's film(s) that had the most nominations.
|-
<!----------Television coverage-specific---------->
! scope="col" colspan="2" style="background; text-align:center;"| Television coverage-specific
|-
|  <code>channel</code>
| Insert the channel the ceremony was broadcast on.
|-
|  <code>network</code>
| Insert the network the ceremony was broadcast on.
|-
| <code>duration</code>
| Insert the broadcast's duration.
|-
| <code>viewership</code>
| Insert the broadcast's viewership numbers.
|-
| <code>ratings</code>
| Insert the broadcast's ratings.
|-
<!----------Chronological---------->
! scope="col" colspan="2" style="background; text-align:center;"| Chronological
|-
| <code>last</code>
| The number of the previous awards ceremony (in the form ''Xth'') or the year.
|-
| <code>next</code>
| The number of the next awards ceremony (in the form ''Xth'') or the year.
|}

== TemplateData ==
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"name": {},
		"year": {},
		"number": {},
		"award": {},
		"image": {},
		"image_size": {},
		"alt": {},
		"caption": {},
		"awarded_for": {},
		"award_org": {},
		"presenting_org": {},
		"announced_date": {},
		"presented_date": {},
		"date": {},
		"site": {},
		"host": {},
		"preshow": {},
		"producer": {},
		"director": {},
		"organizer": {},
		"organiser": {},
		"magazine_issue": {},
		"website": {},
		"lifetime_achievement": {},
		"best_picture": {},
		"best_film": {},
		"film": {},
		"best_film_drama": {},
		"best_film_musical_or_comedy": {},
		"best_drama_series": {},
		"best_musical_or_comedy_series": {},
		"best_miniseries_tv_movie": {},
		"most_awards": {},
		"most_wins": {},
		"most_nominations": {},
		"best_direction": {},
		"direction": {},
		"best_actor": {},
		"actor": {},
		"best_actress": {},
		"actress": {},
		"free_award": {},
		"best_british": {},
		"best_film_comedy": {},
		"best_film_musical": {},
		"best_film_jury_choice": {},
		"best_film_jury": {},
		"best_film_viewers_choice": {},
		"best_film_viewers": {},
		"best_feature": {},
		"best_feature_film": {},
		"best_non_feature": {},
		"best_non_feature_film": {},
		"best_comedy_series": {},
		"best_drama_serial": {},
		"best_drama_serial_popular": {},
		"best_tv_movie": {},
		"best_miniseries_or_tv_movie": {},
		"best_tv_show": {},
		"free_award_type": {},
		"best_direction_film": {},
		"direction_film": {},
		"best_director": {},
		"best_director_film": {},
		"best_actor_film": {},
		"actor_film": {},
		"best_actor_show": {},
		"best_actress_film": {},
		"actress_film": {},
		"best_actress_show": {},
		"best_supporting_actor": {},
		"supporting_actor": {},
		"best_supporting_actor_film": {},
		"supporting_actor_film": {},
		"best_supporting_actress": {},
		"supporting_actress": {},
		"best_supporting_actress_film": {},
		"supporting_actress_film": {},
		"best_comedy_perform1": {},
		"best_comedy_perform1_show": {},
		"best_comedy_perform2": {},
		"best_comedy_perform2_show": {},
		"best_book": {},
		"book": {},
		"best_critic": {},
		"critic": {},
		"gold_award": {},
		"gold": {},
		"hall_of_fame": {},
		"channel": {},
		"network": {},
		"duration": {},
		"viewership": {},
		"ratings": {},
		"last": {},
		"next": {},
		"last_link": {},
		"award_link": {},
		"next_link": {}
	},
	"paramOrder": [
		"name",
		"year",
		"number",
		"award",
		"image",
		"image_size",
		"alt",
		"caption",
		"awarded_for",
		"award_org",
		"presenting_org",
		"announced_date",
		"presented_date",
		"date",
		"site",
		"host",
		"preshow",
		"producer",
		"director",
		"organizer",
		"organiser",
		"magazine_issue",
		"website",
		"lifetime_achievement",
		"best_picture",
		"best_film",
		"film",
		"best_film_drama",
		"best_film_musical_or_comedy",
		"best_drama_series",
		"best_musical_or_comedy_series",
		"best_miniseries_tv_movie",
		"most_awards",
		"most_wins",
		"most_nominations",
		"best_direction",
		"direction",
		"best_actor",
		"actor",
		"best_actress",
		"actress",
		"free_award",
		"best_british",
		"best_film_comedy",
		"best_film_musical",
		"best_film_jury_choice",
		"best_film_jury",
		"best_film_viewers_choice",
		"best_film_viewers",
		"best_feature",
		"best_feature_film",
		"best_non_feature",
		"best_non_feature_film",
		"best_comedy_series",
		"best_drama_serial",
		"best_drama_serial_popular",
		"best_tv_movie",
		"best_miniseries_or_tv_movie",
		"best_tv_show",
		"free_award_type",
		"best_direction_film",
		"direction_film",
		"best_director",
		"best_director_film",
		"best_actor_film",
		"actor_film",
		"best_actor_show",
		"best_actress_film",
		"actress_film",
		"best_actress_show",
		"best_supporting_actor",
		"supporting_actor",
		"best_supporting_actor_film",
		"supporting_actor_film",
		"best_supporting_actress",
		"supporting_actress",
		"best_supporting_actress_film",
		"supporting_actress_film",
		"best_comedy_perform1",
		"best_comedy_perform1_show",
		"best_comedy_perform2",
		"best_comedy_perform2_show",
		"best_book",
		"book",
		"best_critic",
		"critic",
		"gold_award",
		"gold",
		"hall_of_fame",
		"channel",
		"network",
		"duration",
		"viewership",
		"ratings",
		"last",
		"next",
		"last_link",
		"award_link",
		"next_link"
	],
	"format": "block"
}
</templatedata>
{{Collapse bottom}}

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

== See also ==
=== Tracking categories used by this template ===
* {{clc|Pages using infobox film awards with unknown parameters}}
* {{clc|Pages using infobox film awards with the presenting org parameter}}
* {{clc|Pages using infobox film awards with the organizer parameter}}
* {{clc|Pages using infobox film awards with the award org parameter}}
* {{clc|Pages using infobox film awards with the preshow parameter}}
* {{clc|Pages using infobox film awards with the best book parameter}}
* {{clc|Pages using infobox film awards with the best critic parameter}}
* {{clc|Pages using infobox film awards with the gold_award parameter}}
* {{clc|Pages using infobox film awards with the hall_of_fame parameter}}
* {{clc|Pages using infobox film awards with the lifetime achievement parameter}}

=== Related templates ===
* {{tl|Infobox recurring event}}

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

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Film award templates| ]]
[[Category:Award infobox templates|Film awards]]
[[Category:Film infobox templates|Film awards]]
[[Category:Television infobox templates|Film awards]]
[[Category:Templates that add a tracking category]]
}}</includeonly>