Template:Countdown/doc

This is the documentation page for Countdown. It contains usage information, categories, and other content not part of the original template page.
Main	Documentation	Usage

This template uses JS found at MediaWiki:Gadget-Countdown.js.

See also: Template:Countdownall

Parameters

Template for displaying a countdown

Template parameters

Parameter		Description	Type	Status
Region	Region	The region the countdown is for Example NA	Unknown	suggested
Start Offset	TimeStartOffset	The offset for the start time Example UTC+8	Unknown	suggested
End Offset	TimeEndOffset	The offset for the end time Example UTC+8	Unknown	suggested
Start Time	TimeStart	The time the event starts, formatted as a date Example 1970-01-01 00:00:00	Unknown	suggested
End Time	TimeEnd	The time the event ends, formatted as a date Example 1970-01-02 00:00:00	Unknown	required
Hide Text	HideText	Whether to hide the "ends in" text	Unknown	suggested
End Text	EndText	The text to display when the event ends	Unknown	suggested
Countdown Prefix	CountdownPrefix	The prefix to use for the end countdown instead of "Ends in:"	Unknown	suggested

Examples

Case: Offset

{{Countdown
|Region=AS
|EventName=Offset1
|TimeStart=2024/01/15 23:00:00
|TimeStartOffset=GMT+8
|TimeEnd=2050/01/31 03:59:59
|TimeEndOffset=GMT+8
}}

(AS) Ends in: January 30, 2050 07:59:59 PM UTC(AS) Ends in: 8495d 21h 43m 46s (Update)

Case: Upcoming

{{Countdown
|Region=AS
|EventName=TemplateExample1
|TimeStart=2050/01/15 23:00:00 GMT+8
|TimeEnd=2025/01/31 03:59:59 GMT+8
}}

(AS) Starts in: January 15, 2050 03:00:00 PM UTC(AS) Ends in: January 30, 2025 07:59:59 PM UTC(AS) Starts in: 8480d 16h 43m 47s (Update)

Case: Started

{{Countdown
|Region=AS
|EventName=TemplateExample2
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}

(AS) Ends in: January 30, 2050 07:59:59 PM UTC(AS) Ends in: 8495d 21h 43m 46s (Update)

Case: Long Ended

{{Countdown
|Region=AS
|EventName=TemplateExample3
|TimeStart=2020-01-16 10:00:00 GMT+8
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}

Case: Blank Start

{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2025-01-31 03:59:59 GMT+8
}}

(AS) Ends in: January 30, 2050 07:59:59 PM UTC(AS) Ends in: 8495d 21h 43m 46s (Update)

Case: Blank Start Ended

{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}

Case: Blank End

{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2025-01-31 03:59:59 GMT+8
|TimeEnd=
}}

(AS) Starts in: January 30, 2050 07:59:59 PM UTC(AS) Ends in: October 27, 2026 10:16:13 PM UTC(AS) Starts in: 8495d 21h 43m 46s (Update)

Case: Blank End Started

{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2020-01-31 03:59:59 GMT+8
|TimeEnd=
}}

Case: Invalid Start

{{Countdown
|Region=AS
|EventName=TemplateExample6
|TimeStart=aaaaaaaaaaaa
|TimeEnd=2050/01/31 03:59:59 GMT+8
}}

Case: Invalid End

{{Countdown
|Region=AS
|EventName=TemplateExample7
|TimeStart=2025/01/16 10:00:00 GMT+8
|TimeEnd=aaaaaaaaaaaa
}}

Case: Invalid Start End

{{Countdown
|Region=AS
|EventName=TemplateExample8
|TimeStart=aaaaaaaaaaaa
|TimeEnd=aaaaaaaaaaaa
}}

Case: Blank

{{Countdown
|Region=AS
|EventName=TemplateExample9
|TimeStart=
|TimeEnd=
}}

General Info

(Countdown) - Parses EventName, TimeStart and TimeEnd into a countdown, mostly used on event mentioning pages.

• Utilizes the parser functions {{#time:F d, Y h:i:s A e|}} and {{#time:F d, Y|}} and is thus able to accept a variety of formats which are parsed and stored internally as UTC.
• The following are accepted: backslashes (2019/1/1), dashes (2019-1-1), most manner of timezones (+9, +9 hours. +0930, JST, GMT +9) and commas in the correct spacing (November 20, 2019).
• The following are not accepted and will throw errors: any dots as they cause non integer values, including dot spacing (2019.1.1) and specifying timezones in non integer (+9.5).
• If no timezone is specified e.g. October 4, 2018 06:00, the syntax automatically assumes UTC.