Template:Film date/doc
 | This is a documentation subpage for Template:Film date. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 159,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Purpose
[edit]This template has two functions:
- To provide correct formatting of film release dates and their locations within {{Infobox film}}. A citation for each date/location may also be supplied.
- To automatically categorize films according to their first release date.
Usage
[edit]This template is intended to supply a result to the |released= parameter of {{Infobox film}}. It is not intended for use outside of {{Infobox film}}.
The template adds Category:YYYY films where YYYY is the year of first release, as well as Category:Upcoming films for films that have not reached their first release yet. Please note that Category:YYYY films will only be added if the category exists, and that if only the year is included as the release date, the film is considered to be "upcoming" during that entire year.
The television equivalents of these categories (Category:YYYY television films and Category:Upcoming television films) are used when the |TV= parameter is set for use on television film articles.
Syntax
[edit]This template allows up to five release dates/locations, but normally no more than two are needed. Please see WP:FILMRELEASE for a full explanation.
One release date only
[edit]{{Film date|year|month|day|location|ref1=<ref name="xxxxx" />}}
If no location is specified, month and day may be omitted. If location is specified, then month and day must be supplied, though they may be left blank or empty if not known; |ref1= is an optional parameter allowing a named reference ("xxxxx") to be used to verify the date/location of the release.
More than one release date
[edit]{{Film date|year1|month1|day1|location1|ref1=<ref name="xxxxx" />|year2|month2|day2|location2|ref2=<ref name="yyyy" />}}and similarly for up to five dates/locations.
In this case, all the year, month, day and location parameters, except the last, must be supplied, but as before, month and day may be left empty or blank if not known. Note that |ref1=, |ref2=, etc. are optional named parameters, and either may be omitted without affecting the other parameters.
Examples
[edit]{{Film date|1993}} returns:
- 1993
{{Film date|1993|02}} returns:
- February 1993
{{Film date|1993|02|24}} returns:
- February 24, 1993
{{Film date|1993|02|24}} returns:
- February 24, 1993
{{Film date|1993|02|24|2008|03}} returns:
- February 24, 1993
- March 2008
{{Film date|1993|02|24|Latvia}} returns:
- February 24, 1993 (Latvia)
{{Film date|1993|02|24|2008|03|23}} returns:
- February 24, 1993
- March 23, 2008
Optional parameters
[edit]- df can be set to "y" or "yes" to display the day before the month. Default is month before day.
{{Film date|1993|02|24|df=y}} returns:
- 24 February 1993
{{Film date|1993|02|24|Latvia|df=y}} returns:
- 24 February 1993 (Latvia)
- fy can be set to override the automatic category. For example:
{{Film date|1993|02|24|2008|03|23}} uses the category Category:1993 films
{{Film date|1993|02|24|2008|03|23|fy=2008}} uses the category Category:2008 films.
- TV is to be used for television films. It sorts films into
[[Category:YYYY television films]]in place of[[Category:YYYY films]]. SetTV=yorTV=yesto do this.
- ref1, ref2, ref3, ref4, ref5 are used to supply named references. See above for detail.
Technical notes
[edit]References for each film date must be placed inside the template, in |ref1= or subsequent parameters, in order to comply with MOS:REFPUNCT.
Do not use any of the following markup in front of this template: : * #. Doing so will cause HTML errors. See MOS:INDENT for more guidance.
This template uses {{Start date}} to handle the hard work of date formatting, and {{Plainlist}} to format list items as recommended for use within infoboxes.
{{Film date|2001|1|28|location1|2002|2|28|location2}}
- January 28, 2001 (location1)
- February 28, 2002 (location2)
TemplateData
[edit]TemplateData for Film date
Displays information about a film's release date
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Release year 1 | 1 | no description | Number | required |
| Release month 1 | 2 | no description | Number | suggested |
| Release day 1 | 3 | no description | Number | suggested |
| Release location 1 | 4 | First location where the film was released | Content | suggested |
| Release year 2 | 5 | no description | Number | optional |
| Release month 2 | 6 | no description | Number | optional |
| Release day 2 | 7 | no description | Number | optional |
| Release location 2 | 8 | First location where the film was released | Content | optional |
| Release year 3 | 9 | no description | Number | optional |
| Release month 3 | 10 | no description | Number | optional |
| Release day 3 | 11 | no description | Number | optional |
| Release location 3 | 12 | First location where the film was released | Content | optional |
| Release year 4 | 13 | no description | Number | optional |
| Release month 4 | 14 | no description | Number | optional |
| Release day 4 | 15 | no description | Number | optional |
| Release location 4 | 16 | First location where the film was released | Content | optional |
| Release year 5 | 17 | no description | Number | optional |
| Release month 5 | 18 | no description | Number | optional |
| Release day 5 | 19 | no description | Number | optional |
| Release location 5 | 20 | First location where the film was released | Content | optional |
| Demo space | demospace | no description | Unknown | optional |
| TV | TV | Set to yes to apply TV categories | Boolean | optional |
| Category film year | fy | Sets the film year to be used in categorization | Number | optional |
| Day first | df | Set to 'yes' to show the day before the month name
| Line | optional |
| Reference 1 | ref1 | Reference for the film's first release date | Content | optional |
| Reference 2 | ref2 | Reference for the film's first release date | Content | optional |
| Reference 3 | ref3 | Reference for the film's first release date | Content | optional |
| Reference 4 | ref4 | Reference for the film's first release date | Content | optional |
| Reference 5 | ref5 | Reference for the film's first release date | Content | optional |
Tracking categories
[edit]- Category:Pages using film date with unknown parameters (8)
- Category:Pages using film date with TV parameter (0)
- Category:Template film date with category override (27): Tracking use of the
|fy=parameter, which overrides the automatic categorisation by year:
Tracking by number of release dates:
- Category:Template film date with 1 release date (137,389)
- Category:Template film date with 2 release dates (17,300)
- Category:Template film date with 3 release dates (2,126)
- Category:Template film date with 4 release dates (363)
- Category:Template film date with 5 release dates (108)
Total by-release-date: 157,286
See also
[edit]{{Start date}}{{Nowrap}}{{Small}}