Template:Show by
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
 | This template should always be substituted (i.e., use {{subst:Show by}}). |
Usage
{{Show by}} is a wrapper for {{Show by date}} that will automatically display one of two statements based on whether a particular date/time has been reached.
{{subst:Show by|date/time|text before|text after|demo=}}
- Parameter 1 (
date/time) is the date and/or time that the template should show thetext after. Until that date and time, thetext beforeis shown. Thedate/timeparameter can be in any format accepted by PHP's strtotime() function. See mw:Help:Extension:ParserFunctions#.23time for more information. - Parameter 2 (
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 3 (
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 demo parameter (
demo=yes) can be used to prevent automatic substitution of the template.
This template should always be substituted ({{subst:Show by}}). This will insert the {{Show by date}} template using separate parameters for year, month, date, and time.
The {{ show by date}} template inserted by this 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 2028" to "Mr. Smith took office on 1 January 2028" 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 2028" does not usually support a statement "The movie was released on 1 January 2028" since movie dates often slip; on the other hand, it could support "The movie was scheduled for release on 1 January 2028" or the template could be used to remove the text entirely, and {{update after}} could be used to request an update.
- Be careful that the article does not contain awkward grammar before the date and will not contain awkward grammar when the "after" text is displayed.
- This template supports both absolute (e.g.
20 December 2000) and relative (e.g.+20 hours) times, but relative times should only be used if the template is manually substituted. If the template is bot substituted, the time will be relative to the time that the bot edited the page.
Limitations
- Unless
date/timespecifies a time zone, statements will be switched on the date according to Wikipedia 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, it will make a significant difference if the actual event is more than 12 hours before or after this. For example, an event that takes place on July 31 at 8:00 pm Pacific Standard Time (UTC−08:00) corresponds to 04:00, August 1 (UTC). - 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
text beforenor thetext aftermay begin or end with whitespace. 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 (see example below). - If the
text beforeortext aftercontains an "=" or "|" character that is not inside another template invocation, use the templates {{=}} or {{!}}.
Examples
| Code | Result |
|---|---|
| {{subst:show by|2028|Show this before 2028|Show this after 2028}} has started | Show this before 2028 has started |
| {{subst:show by|2026|Show this before 2026|Show this after 2026}} has started | Show this after 2026 has started |
| {{subst:show by|September 2024|Show this before September 2024|Show this after September 2024}} has started | Show this after September 2024 has started |
| {{subst:show by|2028-09-06|Show this before 2028-09-06|Show this as of 2028-09-06}} | Show this before 2028-09-06 |
| {{subst:show by|2024-09-06 12:00pm EST|Before noon Eastern Standard Time on 2024 September 6|After noon Eastern Standard Time on 2024 September 6}} | After noon Eastern Standard Time on 2024 September 6 |
| {{subst:show by|06 Sep 2028|Show this before 06 Sep 2028|}} | Show this before 06 Sep 2028 |
| {{subst:show by|06 Sep 2028||Show this after 06 Sep 2028}} | |
| {{subst:show by|2028|{{subst:show by|2024|Show this before 2024|Show this between 2024 and 2028}}|Show this as of 2028}} | Show this between 2024 and 2028 |
| {{subst:show by| -1 day |It is before yesterday|It is after yesterday}} | It is after yesterday |
| {{subst:show by| +1 day |It is before tomorrow|It is after tomorrow}} | It is before tomorrow |
| Note *{{subst:show by|2028| lost spacing }}*, and *{{subst:show by|2028| workaround }}* | Note *lost spacing*, and * workaround * |
Related templates
- {{Show by date}} The template that this is a wrapper for, with separate parameters for year, month, and day
- {{As of}}
- {{Update after}}, which shows an inline upate maintenance tag when a specified date is reached.
.svg){kind=link}