Jump to content

Template:Countdown: Difference between revisions

From The Petit Planet Wiki
ReisuDesign (talk | contribs)
No edit summary
ReisuDesign (talk | contribs)
No edit summary
 
Line 14: Line 14:
data-padding="{{{Padding|no}}}"
data-padding="{{{Padding|no}}}"
data-labels="{{{Labels|short}}}"
data-labels="{{{Labels|short}}}"
data-day-label="{{{DayLabel|}}}"
    data-hide-zeros="{{{HideZeros|yes}}}"
    data-day-label="{{{DayLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"
Line 34: Line 35:
data-padding="{{{Padding|no}}}"
data-padding="{{{Padding|no}}}"
data-labels="{{{Labels|short}}}"
data-labels="{{{Labels|short}}}"
data-day-label="{{{DayLabel|}}}"
    data-hide-zeros="{{{HideZeros|yes}}}"
    data-day-label="{{{DayLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"
Line 65: Line 67:
data-padding="{{{Padding|no}}}"
data-padding="{{{Padding|no}}}"
data-labels="{{{Labels|short}}}"
data-labels="{{{Labels|short}}}"
data-day-label="{{{DayLabel|}}}"
    data-hide-zeros="{{{HideZeros|yes}}}"
    data-day-label="{{{DayLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-hour-label="{{{HourLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"
data-minute-label="{{{MinuteLabel|}}}"

Latest revision as of 08:21, 19 September 2026

Template documentation
Note: parts of or the entire template might not be visible without values provided.
This template uses JS found at MediaWiki:Gadget-Countdown.js.

Parameters

[edit source]

Template for displaying a countdown

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
RegionRegion

The region the countdown is for

Example
NA
Unknownsuggested
Start OffsetTimeStartOffset

The offset for the start time

Example
UTC+8
Unknownsuggested
End OffsetTimeEndOffset

The offset for the end time

Example
UTC+8
Unknownsuggested
Start TimeTimeStart

The time the event starts, formatted as a date

Example
1970-01-01 00:00:00
Unknownsuggested
End TimeTimeEnd

The time the event ends, formatted as a date

Example
1970-01-02 00:00:00
Unknownrequired
Hide TextHideText

Whether to hide the "ends in" text

Unknownsuggested
End TextEndText

The text to display when the event ends

Unknownsuggested
Countdown PrefixCountdownPrefix

The prefix to use for the end countdown instead of "Ends in:"

Unknownsuggested

Examples

[edit source]

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: 8496d 5h 59m 16s (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: 8481d 0h 59m 17s (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: 8496d 5h 59m 16s (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: 8496d 5h 59m 16s (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: 8496d 5h 59m 16s (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

[edit source]

(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.