Template:Start date/doc: Difference between revisions

Latest revision as of 13:54, 3 September 2020

This is a documentation subpage for Template:Start date.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used in MediaWiki:Statistics-footer.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

This template is used on approximately 342,000 pages, or roughly 5089% of all 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.

This purpose of the {{start date}} template is to return the date (or date-time) that an event or entity started or was created, and to do so in a standard format. It also includes duplicate, machine-readable date (or date-time) in the ISO date format (which is hidden by CSS), for use inside other templates (or table rows) which emit microformats. It should be used only once in each such template and never used outside such templates. The hidden date degrades gracefully when CSS is not available.

When not to use this template

Do not use this template for:

dates that are uncertain e.g., "before 4 April 1933"; "around 18 November 1939".
dates outside the range given under "Limitation", below.
other, secondary dates
outside microformat-emitting templates - if in doubt, see the parent template's documentation
more than one date in any parent template

Syntax

{{start date|year|month|day}}
{{start date|year|month|day|HH|MM|SS|TimeZone}} (MM and SS are optional; TimeZone may be a numerical value, or "Z" for UTC; see examples)

Examples

{{start date|1993}} → "1993 (1993)"
{{start date|1993|02}} → "February 1993 (1993-02)"
{{start date|1993|02|24}} → "February 24, 1993 (1993-02-24)"
{{start date|1993|02|24|08|30}} → "08:30, February 24, 1993 (1993-02-24T08:30)"
{{start date|1993|02|24|08|||+01:00}} → "February 24, 1993 (+01:00) (1993-02-24T08+01:00)"
{{start date|1993|02|24|08|||-07:00}} → "February 24, 1993 (-07:00) (1993-02-24T08-07:00)"
{{start date|1993|02|24|08|30|23}} → "08:30:23, February 24, 1993 (1993-02-24T08:30:23)"
{{start date|1993|02|24|08|30|23|Z}} → "08:30:23, February 24, 1993 (UTC) (1993-02-24T08:30:23Z)"
{{start date|1993|02|24|08|30|23|+01:00}} → "08:30:23, February 24, 1993 (+01:00) (1993-02-24T08:30:23+01:00)"
{{start date|1993|02|24|08|30|23|-07:00}} → "08:30:23, February 24, 1993 (-07:00) (1993-02-24T08:30:23-07:00)"

An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles using DMY format for dates.

Examples

{{start date|1993|02|24|df=y}} → "24 February 1993 (1993-02-24)"
{{start date|1993|02|24|08|30|df=yes}} → "08:30, 24 February 1993 (1993-02-24T08:30)"

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Start date

Date that an event or entity started or was created

Template parameters
Parameter		Description	Type	Status
YYYY	`1`	start year	Number	optional
MM	`2`	start month	Number	optional
DD	`3`	start day of month	Number	optional
HH	`4`	start hours	Number	optional
MM	`5`	start minutes Default 0	Number	optional
SS	`6`	start seconds Default 0	Number	optional
TZ	`7`	time zone offset, “+02:00”, “-06:00” or “Z” for UTC	Line	optional
day first	`df`	boolean parameter to put the date before the month name Default false	Line	optional
month first	`mf`	mf=yes: order mm-dd-yyyy (=the default order) Default yes	String	deprecated

Use in microformats

This template also returns the date, hidden by CSS, in the ISO 8601 format needed by one or more of the following microformats:

hAtom (class="updated")
hAudio (class="published")
hCalendar (class="dtstart")
hCard (class="bday")

usually, but not always, within infobox or similar templates, or tables.

Its use in hCard is for organizations, venues and similar; use {{Birth date}} or {{Birth date and age}} for people.

Similarly, {{End date}} returns the date as hCalendar's (class="dtend").

See the microformats project for further details.

Limitation

This template has no provision to deal with a date in a non-Gregorian calendar. Also, ISO 8601 requires mutual agreement among those exchanging information before using years outside the range 1583–9999 CE. Therefore, use of this template for non-Gregorian dates or dates outside that range constitutes a false claim of conformance to the ISO 8601 standard.

Any editor encountering such usage should change the date to plain text with no template; or if not confident in doing so, raise the matter on this template's talk page.

Example

{{Start date|2016|12|31}} → December 31, 2016

December&nbsp;31,&nbsp;2016<span style="display:none">&#160;(<span class="bday dtstart published updated">2016-12-31</span>)</span>

@@ Line 1: / Line 1: @@
-<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+{{Documentation subpage}}
+{{used in system|in [[MediaWiki:Statistics-footer]]}}
+{{high-risk|288,000}}
 <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
-== Usage ==
+{{COinS safe|n}}
-These templates ('''{{tl|Start date}}''' and '''{{tl|End date}}''') return a date, or date-time. They also include the same date (and time) duplicated in a hidden (by CSS) ISO date format, for use in [[microformat]]s. This hidden date degrades gracefully when CSS is not available.
+This purpose of the '''{{tl|start date}}''' template is to return the date (or date-time) that an event or entity started or was created, and to do so in a standard format. It also includes duplicate, machine-readable date (or date-time) in the ISO date format (which is hidden by CSS), for use inside other templates (or table rows) which emit [[microformat]]s. '''It should be used only once in each such template''' and '''never used outside such templates'''. The hidden date degrades gracefully when CSS is not available.
-==Syntax==
+== When not to use this template ==
+Do not use this template for:
+* dates that are uncertain e.g., "before 4 April 1933"; "around 18 November 1939".
+* dates outside the range given under "[[#Limitation|Limitation]]", below.
+* other, secondary dates
+* outside [[microformat]]-emitting templates - if in doubt, see the parent template's documentation
+* more than one date in any parent template
-:<nowiki>{{Start date|year|month|day}}</nowiki>
+== Syntax ==
+* {{tlx|start date|year|month|day}}
+* {{tlx|start date|year|month|day|HH|MM|SS|TimeZone}} (MM and SS are optional; TimeZone may be a numerical value, or "Z" for [[Coordinated Universal Time|UTC]]; see examples)
-:<nowiki>{{Start date|year|month|day|HH|MM|SS|TimeZone}}</nowiki> (MM and SS are optional; TimeZone may be a numerical value, or "Z" for [[Coordinated Universal Time|UTC]]; see examples)
+; Examples
+* {{tlx|start date|1993}} → "{{start date|1993}}"
+* {{tlx|start date|1993|02}} → "{{start date|1993|02}}"
+* {{tlx|start date|1993|02|24}} → "{{start date|1993|02|24}}"
+* {{tlx|start date|1993|02|24|08|30}} → "{{start date|1993|02|24|08|30}}"
+* {{tlx|start date|1993|02|24|08<nowiki>|||+01:00</nowiki>}} → "{{start date|1993|02|24|08|||+01:00}}"
+* {{tlx|start date|1993|02|24|08<nowiki>|||-07:00</nowiki>}} → "{{start date|1993|02|24|08|||-07:00}}"
+* {{tlx|start date|1993|02|24|08|30|23}} → "{{start date|1993|02|24|08|30|23}}"
+* {{tlx|start date|1993|02|24|08|30|23|Z}} → "{{start date|1993|02|24|08|30|23|Z}}"
+* {{tlx|start date|1993|02|24|08|30|23|+01:00}} → "{{start date|1993|02|24|08|30|23|+01:00}}"
+* {{tlx|start date|1993|02|24|08|30|23|-07:00}} → "{{start date|1993|02|24|08|30|23|-07:00}}"
-or
+An optional parameter, <code>df</code>, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles using DMY format for dates.
-:<nowiki>{{End date|year|month|day}}</nowiki>
+; Examples
+* {{tlx|start date|<nowiki>1993|02|24|df=y</nowiki>}} → "{{start date|1993|02|24|df=y}}"
+* {{tlx|start date|<nowiki>1993|02|24|08|30|df=yes</nowiki>}} → "{{start date|1993|02|24|08|30|df=yes}}"
-Examples:
+== TemplateData ==
+{{TemplateDataHeader}}
+<templatedata>
+{
+	"description": "Date that an event or entity started or was created",
+	"params": {
+		"1": {
+			"label": "YYYY",
+			"description": "start year",
+			"type": "number"
+		},
+		"2": {
+			"label": "MM",
+			"description": "start month",
+			"inherits": "1"
+		},
+		"3": {
+			"label": "DD",
+			"description": "start day of month",
+			"inherits": "1"
+		},
+		"4": {
+			"label": "HH",
+			"description": "start hours",
+			"inherits": "1"
+		},
+		"5": {
+			"label": "MM",
+			"description": "start minutes",
+			"inherits": "1",
+			"default": "0"
+		},
+		"6": {
+			"label": "SS",
+			"description": "start seconds",
+			"inherits": "5"
+		},
+		"7": {
+			"label": "TZ",
+			"description": "time zone offset, “+02:00”, “-06:00” or “Z” for UTC",
+			"inherits": "1",
+			"type": "string/line"
+		},
+		"df": {
+			"label": "day first",
+			"description": "boolean parameter to put the date before the month name",
+			"default": "false",
+			"type": "string/line"
+		},
+		"mf": {
+			"label": "month first",
+			"description": "mf=yes: order mm-dd-yyyy (=the default order)",
+			"type": "string",
+			"default": "yes",
+			"deprecated": "trivial because default. Or use df=yes (for mf=no)."
+		}
+	}
+}
+</templatedata>
-:<nowiki>{{Start date|1993}}</nowiki> returns "{{Start date|1993}}"
+== Use in microformats ==
+{{UF-date-part}}
-:<nowiki>{{Start date|1993|2}}</nowiki> returns "{{Start date|1993|2}}"
-:<nowiki>{{Start date|1993|2|24}}</nowiki> returns "{{Start date|1993|2|24}}"
-:<nowiki>{{Start date|1993|2|24|08|30}}</nowiki> returns "{{Start date|1993|2|24|08|30}}"
-:<nowiki>{{Start date|1993|2|24|08|||+01:00}}</nowiki> returns "{{Start date|1993|2|24|08|||+01:00}}"
-:<nowiki>{{Start date|1993|2|24|08|||-07:00}}</nowiki> returns "{{Start date|1993|2|24|08|||-07:00}}"
-:<nowiki>{{Start date|1993|2|24|08|30|23}}</nowiki> returns "{{Start date|1993|2|24|08|30|23}}"
-:<nowiki>{{Start date|1993|2|24|08|30|23|Z}}</nowiki> returns "{{Start date|1993|2|24|08|30|23|Z}}"
-:<nowiki>{{Start date|1993|2|24|08|30|23|+01:00}}</nowiki> returns "{{Start date|1993|2|24|08|30|23|+01:00}}"
-:<nowiki>{{Start date|1993|2|24|08|30|23|-07:00}}</nowiki> returns "{{Start date|1993|2|24|08|30|23|-07:00}}"
-:<s><nowiki>{{End date|1993|2|24}}</nowiki> returns "{{End date|1993|2|24}}"</s>
-:<nowiki>{{End date|1993|2|24|08|30}}</nowiki> returns "{{End date|1993|2|24|08|30}}"
-An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles about events in parts of the world where the day precedes the month in a date.
-Examples:
-:<nowiki>{{Start date|1993|2|24|df=y}}</nowiki> returns "{{Start date|1993|2|24|df=y}}"
-:<nowiki>{{Start date|1993|2|24|08|30|df=yes}}</nowiki> returns "{{Start date|1993|2|24|08|30|df=yes}}"
+=== Example ===
+{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{Start date|2016|12|31}}</nowiki>}}
-:<s><nowiki>{{End date|1993|2|24|df=yes}}</nowiki> returns "{{End date|1993|2|24|df=yes}}"</s>
+== See also ==
+* {{tlg|start-date}}, an alternative to this template.
+* {{tlg|film date}}, a similar template for use with {{tl|Infobox film}}.
+* {{tlg|start date and age}}
+* {{tlg|start date and years ago}}
+* {{tlg|Start and end dates}}
+* {{tlg|end date}}
+* {{tlg|end-date}}
+* {{tlg|trim date}}
+* [[Wikipedia:WikiProject Microformats|WikiProject Microformats]]
-'''Note:''' The template will appear broken when the parameters are left blank (as seen above).
+{{Birth, death and age templates|dates}}
-== Use in microformats ==
-{{UF-date-part}}
-<includeonly>
+<includeonly>{{Sandbox other|
-<!-- ADD CATEGORIES BELOW THIS LINE -->
+| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
-[[Category:Date mathematics templates|{{PAGENAME}}]]
+[[Category:Date mathematics templates]]
-[[Category:Templates generating hAtom|{{PAGENAME}}]]
+[[Category:Templates generating hAtom]]
-[[Category:Templates generating hCalendars|{{PAGENAME}}]]
+[[Category:Templates generating hCalendars]]
-[[Category:Templates generating hCards|{{PAGENAME}}]]
+[[Category:Templates generating hCards]]
-<!-- ADD INTERWIKIS BELOW THIS LINE -->
+}}</includeonly>
-[[es:Plantilla:Fecha]]
-[[id:Templat:Tanggal mulai]]
-[[ja:Template:Start date]]
-[[zh:Template:Start date]]
-</includeonly>

Template:Start date/doc: Difference between revisions

Latest revision as of 13:54, 3 September 2020

Contents

When not to use this template

Syntax

TemplateData

Use in microformats

Limitation

Example

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages