Template:Show by date/sandbox
 | This is the template sandbox page for Template:Show by date (diff). See also the companion subpage for test cases. |
Usage
[edit]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 Wikipedia 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.
A WP:BOT, User:AnomieBOT, will substitute the template with just the text after after the specified date.
Warnings
[edit] |
|
Limitations
[edit]- Unless the
hour=is set, 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, 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 December 2 at 8:00 pm Pacific Standard Time (UTC−08:00) corresponds to 04:00, December 3 (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
[edit]| Code | Result |
|---|---|
| {{show by date|2022|||Show this before 2022|Show this after 2022}} has started | Show this after 2022 has started |
| {{show by date|2026|09||Show this before September 2026|Show this after September 2026}} has started | Show this before September 2026 has started |
| {{show by date|2022|09|06|Show this before 06 Sep 2022|Show this as of 06 Sep 2022}} | Show this as of 06 Sep 2022 |
| {{show by date|2024|12|2|Show this before 17:00 UTC|Show this as of 17:00 UTC|hour=17}} | Show this before 17:00 UTC |
| {{show by date|2026|09|06|Show this before 06 Sep 2026|}} | Show this before 06 Sep 2026 |
| {{show by date|2026|09|06||Show this after 06 Sep 2026}} | |
| {{show by date|2026|||{{show by date|2022|||Show this before 2022|Show this between 2022 and 2026}}|Show this as of 2026}} | Show this between 2022 and 2026 |
| Note *{{show by date|2026||| lost spacing }}*, and *{{show by date|2026||| workaround }}* | Note *lost spacing*, and * workaround * |
Template data
[edit]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
[edit]- {{Show by}} A similar template that accepts a date/time string instead of separate parameters for the year, month, and day
- {{As of}}
- {{Update}}
{{Update|inaccurate=y}}is used to mark an article whose factual accuracy may be compromised (although this may be disputed) due to out of date information. This template adds the article to Category:Articles with obsolete information.
- {{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
See also
[edit]
| This is the template sandbox page for Template:Show by date (diff). See also the companion subpage for test cases. |