Template:Show by date/doc

__EXPECTED_UNCONNECTED_PAGE__

For the wrapper template that uses a freeform date/time parameter instead of separate year, month, and day parameters, see Template:Show by.

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 the text after needs 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 the text before needs 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 the text 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 show text after at 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, unless you add the parameters |nosubst=yes or |demo=yes.

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 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 October 31 at 8:00 pm Pacific Standard Time (UTC−08:00) corresponds to 04:00, November 1 (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 before nor the text after may 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 before or text after contains 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|31|Show this before 15:00 UTC|Show this as of 15:00 UTC|hour=15}}	Show this before 15: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

Template parameters

This template prefers inline formatting of parameters.

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}}
  • {{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

• Wikipedia:Avoid statements that will date quickly

Template:Show by date invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.