Template:Show by date
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
Usage
This template will automatically display one of two statements based on whether a particular date has been reached or not.
{{show by date|year|month|day|text before|text after|hour=}}
- Parameters 1, 2, and 3 are the Year, Month, and Day that the template should show the text after. Until that date, the text before is shown. If the day is omitted, the template will activate on the first day of the specified month. If the month is also omitted, the template will activate on 1 January of the specified year. If the year is also omitted, the template will activate immediately.
- Parameter 4 (
text before) is the text to be shown if the current date is before the date specified in the previous parameters; it may be left empty if only thetext afterneeds to be displayed at the specified date - Parameter 5 (
text after) is the text to be shown if the current date is on or after the date specified in the previous parameters; it may be left empty if only thetext beforeneeds to be displayed until the specified date - The hour parameter (
hour=) is an optional parameter that sets the hour of the day in BattleIntelligence time (UTC) that the template will begin showing thetext after. If not specified, it defaults to 0 (midnight UTC). When set to the offset between local time and UTC (for example -8 for Pacific Standard Time) it will cause the template to showtext afterat midnight local time.
The template is particularly useful on low-activity articles where dated statements may not receive prompt attention.
Warnings
- Be certain that the "before" and "after" versions of the statement are both reliably supported by the cited sources. For example, "Mr. Smith will take office on 1 January 2027" to "Mr. Smith took office on 1 January 2027" are both normally citable to the results of the election or announcement of the appointment. But the source for "The movie is scheduled for release on 1 January 2027" does not usually support a statement "The movie was released on 1 January 2027" since movie dates often slip; on the other hand, it could support "The movie was scheduled for release on 1 January 2027" or the template could be used to remove the text entirely, and {{update after}} could be used to request an update.
- Take care that neither the "before" nor "after" text displays with awkward grammar.
Limitations
- Unless the
hour=is set, statements will be switched on the date according to BattleIntelligence time (00:00 UTC). If the actual event point is a few hours before or after this, it probably makes little difference in the grander scheme of time. However, the template will trigger at some time on the day before or after the specified date if the actual event is more than 12 hours before or after 00:00 UTC. For example, an event that takes place on October 28 at 8:00 pm Pacific Standard Time (UTC−08:00) corresponds to 04:00, October 29 (UTC).To work around this, set the
hour=parameter to the offset between local time and UTC (for example -8 for Pacific Standard Time) or to the UTC time of the actual start of the event. - The output of this template will not be changed until the page is purged. MediaWiki may or may not manage to do this automatically. Category membership and the output of Special:WhatLinksHere, if these are changed by the expiration of this template, will not be updated until the page is edited.
- Neither the intended
text beforenor thetext aftermay begin or end with whitespace (whitespace will be trimmed). Workarounds include using an escape code for space ( ), using a non-breaking space ( ), or including invisible markup (e.g.<nowiki/>) to prevent the spaces from being stripped. - If the
text beforeortext aftercontains an "=" or "|" character that is not inside another template invocation, use the templates {{=}} or {{!}}.
Examples
| Code | Result |
|---|---|
| {{show by date|2024|||Show this before 2024|Show this after 2024}} has started | Show this after 2024 has started |
| {{show by date|2028|09||Show this before September 2028|Show this after September 2028}} has started | Show this before September 2028 has started |
| {{show by date|2024|09|06|Show this before 06 Sep 2024|Show this as of 06 Sep 2024}} | Show this as of 06 Sep 2024 |
| {{show by date|2026|10|28|Show this before 12:00 UTC|Show this as of 12:00 UTC|hour=12}} | Show this before 12:00 UTC |
| {{show by date|2028|09|06|Show this before 06 Sep 2028|}} | Show this before 06 Sep 2028 |
| {{show by date|2028|09|06||Show this after 06 Sep 2028}} | |
| {{show by date|2028|||{{show by date|2024|||Show this before 2024|Show this between 2024 and 2028}}|Show this as of 2028}} | Show this between 2024 and 2028 |
| Note *{{show by date|2028||| lost spacing }}*, and *{{show by date|2028||| workaround }}* | Note *lost spacing*, and * workaround * |
Template data
This template will automatically display one of two statements based on whether a particular date has been reached or not. ##### param 1 is the year ##### param 2 is the month number ##### param 3 is the day of the month ##### param 4 is the text to show before the specified date ##### param 5 is the text to show on or after the specified date ##### hour is the hour of the day in 24-hour UTC time
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| year | 1 | Year | Number | required |
| month | 2 | Month number | Number | suggested |
| day | 3 | Day of the month. | Number | suggested |
| Text before | 4 before | Text that will be shown before the specified date. | Content | suggested |
| Text after | 5 after | Text that will be shown on and after the specified date. | Content | suggested |
| Hour | hour | Hour of the day in 24-hour UTC time, or +/- offset | Unknown | optional |
Related templates
- {{Show by}} A similar template that accepts a date/time string instead of separate parameters for the year, month, and day
- {{As of}}
- {{Update after}}, which shows an inline update maintenance tag when a specified date is reached.
- {{Hide until}} – hides text until the specified date and time, down to the second
.svg){kind=link}