Template:Awards/doc: Difference between revisions
meta>Jeanenawhitney create doc |
m 29 revisions imported |
||
(28 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{inuse}} | <!-- {{inuse}} --> | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
The '''Awards''' template may be used to format information about award(s) won, typically within an infobox awards section. | |||
The ''' | |||
==Usage== | ==Usage== | ||
The | The Awards template 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. | ||
===Simplest form without parameters spelled out=== | ===Simplest form without parameters spelled out=== | ||
<pre>{{ | <pre>{{Awards|||||}}</pre> | ||
Note: When using the short form without parameter names you must use the parameters in succession (award|year|title|role|name). You can not skip any parameters without an empty "|". | Note: When using the short form without parameter names you must use the parameters in succession (award|year|title|role|name). You can not skip any parameters without an empty "|". | ||
===Short form with parameters spelled out=== | ===Short form with parameters spelled out=== | ||
<pre>{{ | <pre>{{Awards|award= |year= |title= |role= |name= }}</pre> | ||
===Long form with parameters spelled out=== | ===Long form with parameters spelled out=== | ||
<pre>{{ | <pre>{{Awards | ||
| award = | | award = | ||
| year = | | year = | ||
Line 25: | Line 24: | ||
===Additional years win same award=== | ===Additional years win same award=== | ||
You may specify up to 19 additional wins (total of 20 wins) for the same award but won in different years and for different works (title). With optional role for each. | |||
You may specify up to | |||
<pre> | <pre> | ||
Line 41: | Line 39: | ||
| title5 = | | title5 = | ||
| role5 = | | role5 = | ||
... | |||
| year19 = | |||
| title19 = | |||
| role19 = | |||
</pre> | </pre> | ||
==Parameters== | ==Parameters== | ||
{| class="infobox wikitable" | {| class="infobox wikitable" | ||
! Parameter | ! Parameter | ||
Line 51: | Line 52: | ||
| award | | award | ||
| Insert the name of the award ceremony won. This could be an internal link such as:<br /> | | Insert the name of the award ceremony won. This could be an internal link such as:<br /> | ||
<nowiki>[[Academy Award for Best Director|Best Director]]</nowiki> | <nowiki>[[Academy Award for Best Director|Best Director]]</nowiki> [[:Academy Award for Best Director|Best Director]]<br /> | ||
<nowiki>[[Palme d'Or|Golden Palm]]</nowiki> | <nowiki>[[Palme d'Or|Golden Palm]]</nowiki> [[:Palme d'Or|Golden Palm]]<br /> | ||
|- | |- | ||
| year | | year | ||
Line 60: | Line 60: | ||
| title | | title | ||
| Insert the title of what this award was won for. This could be the title of a book, title of a play, title of a film, etc. The output will placed on the second line following the year. The output will be displayed as italicized text. Such as:<br /> | | Insert the title of what this award was won for. This could be the title of a book, title of a play, title of a film, etc. The output will placed on the second line following the year. The output will be displayed as italicized text. Such as:<br /> | ||
1980 ''[[All That Jazz]]'' | 1980 ''[[All That Jazz (film)|All That Jazz]]'' | ||
|- | |- | ||
| role | | role | ||
Line 66: | Line 66: | ||
|- | |- | ||
| name | | name | ||
| Insert optional award name. If this parameter is used it will be placed on the first line after the award parameter followed by a "space | | Insert optional award name. If this parameter is used it will be placed on the first line after the award parameter followed by a "space – space". Such as: | ||
[[Palme d'Or|Golden Palm]] – [[Cannes Film Festival]] | |||
|- | |- | ||
<!-- | awards | <!-- | awards | ||
| Insert any other awards won and the year(s) awarded. Use the format:<blockquote>'''<nowiki>[[Article for award name| Short form of award ceremony name followed by award name]]</nowiki>'''<br/>Year ''Title'' (optional: & | | Insert any other awards won and the year(s) awarded. Use the format:<blockquote>'''<nowiki>[[Article for award name| Short form of award ceremony name followed by award name]]</nowiki>'''<br/>Year ''Title'' (optional: – Role)</blockquote>Note: If an article for the film is available, the title should link there. | ||
|} --> | |} --> | ||
|} | |} | ||
{{clear}} | |||
== | ==See also== | ||
*{{tl|Infobox order}} | |||
*{{tl|Infobox Award}} | |||
*{{tl|Infobox writer}} | |||
*{{tl|Infobox artist}} | |||
*{{tl|Infobox actor}} | |||
*{{tl|Infobox chef}} | |||
{{ | |||
{{ | |||
{{ | |||
<includeonly>{{sandbox other||<!-- | |||
< | |||
{{ | |||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. --> | ++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. --> | ||
</includeonly> | [[Category:Awards templates| ]] | ||
[[ | }}</includeonly> | ||
<templatedata> | |||
{ | |||
"params": { | |||
"Award": { | |||
"label": "Award", | |||
"description": "The award won; if notable, place within double brackets", | |||
"example": "[[Academy Award for Best Director|Best Director]]", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"Year": { | |||
"label": "Year", | |||
"description": "Year in which the award was received", | |||
"example": "2007", | |||
"type": "date", | |||
"suggested": true | |||
}, | |||
"Name": { | |||
"label": "Name", | |||
"description": "Optional award name; if notable, place within double brackets", | |||
"example": "[[Palm d'Or|Golden Palm]]", | |||
"type": "string" | |||
}, | |||
"Title": { | |||
"label": "Title", | |||
"description": "Title of the work which received the award; if the work is notable, place it within double brackets", | |||
"example": "[[All That Jazz]]", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"Role": { | |||
"label": "Role", | |||
"description": "If award was for a performance in a play, movie, or television program, indicate the role played by the award recipient; do not Wikilink", | |||
"example": "Alice", | |||
"type": "string" | |||
} | |||
}, | |||
"description": "Place this template to add award information to a biography article; this template is most frequently used within the various {{tl|Infobox}} templates (e.g., {{tl|Infobox artist}}). It may be placed by anyone." | |||
} | |||
</templatedata> |
Latest revision as of 17:13, 3 September 2020
This is a documentation subpage for Template:Awards. It may contain usage information, categories and other content that is not part of the original template page. |
The Awards template may be used to format information about award(s) won, typically within an infobox awards section.
Usage
The Awards template 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.
Simplest form without parameters spelled out
{{Awards|||||}}
Note: When using the short form without parameter names you must use the parameters in succession (award|year|title|role|name). You can not skip any parameters without an empty "|".
Short form with parameters spelled out
{{Awards|award= |year= |title= |role= |name= }}
Long form with parameters spelled out
{{Awards | award = | year = | title = | role = | name = }}
Additional years win same award
You may specify up to 19 additional wins (total of 20 wins) for the same award but won in different years and for different works (title). With optional role for each.
| year2 = | title2 = | role2 = | year3 = | title3 = | role3 = | year4 = | title4 = | role4 = | year5 = | title5 = | role5 = ... | year19 = | title19 = | role19 =
Parameters
Parameter | Explanation |
---|---|
award | Insert the name of the award ceremony won. This could be an internal link such as: [[Academy Award for Best Director|Best Director]] Best Director |
year | Insert the year the award was won. |
title | Insert the title of what this award was won for. This could be the title of a book, title of a play, title of a film, etc. The output will placed on the second line following the year. The output will be displayed as italicized text. Such as: 1980 All That Jazz |
role | Insert optional name of the role played. |
name | Insert optional award name. If this parameter is used it will be placed on the first line after the award parameter followed by a "space – space". Such as: |
See also
- {{Infobox order}}
- {{Infobox Award}}
- {{Infobox writer}}
- {{Infobox artist}}
- {{Infobox actor}}
- {{Infobox chef}}
Place this template to add award information to a biography article; this template is most frequently used within the various {{tl|Infobox}} templates (e.g., {{tl|Infobox artist}}). It may be placed by anyone.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Award | Award | The award won; if notable, place within double brackets
| String | suggested |
Year | Year | Year in which the award was received
| Date | suggested |
Name | Name | Optional award name; if notable, place within double brackets
| String | optional |
Title | Title | Title of the work which received the award; if the work is notable, place it within double brackets
| String | suggested |
Role | Role | If award was for a performance in a play, movie, or television program, indicate the role played by the award recipient; do not Wikilink
| String | optional |