Template:Countdown/doc

Notes

Please note the following important points before using this template.

The time on this countdown clock is GMT (UTC+0)

• if the event is held in more than a year, the number of years and everything below will be shown
• if the event is held in more than a week, the number of weeks and everything below will be shown
• if the event is held in more than 24 hours, the number of days and everything below will be shown
• if the event is held within 24 hours, the number of hours left and everything below will be shown
• if the event is held within 1 hour, the number of minutes left and the number of seconds left will be shown
• if the event is held within 1 minute, the number of seconds left will be shown

Notes for translators:

The text displayed when timer reaches zero is specified in Module:Countdown. If you want to set the text for your language, please add an entry to the alreadyStarted table in the beginning of the module, in a similar way to other already listed languages.

The labels like 2 minutes and 40 seconds are loaded from MediaWiki messages. If you don't see them translated, though, please ask an interface administrator or administrator to ensure that there exists a subpage of MediaWiki:lang for your language code.

Usage

Editors can use this template as a countdown clock for a lot of different events. The following can show you how to use this template.

Simple Countdown Clock

This type of countdown clock is suitable for events with no duration.

{{countdown
 |year  = 2024
 |month = 04
 |day   = 15
}}

If you type in the above, something like the following will appear.

The event has begun

Advanced Countdown Clock

This type of countdown clock gives more precise control over the time when the event starts and allows you to provide a message to be displayed when the event begins (instead of a default one).

{{countdown
 |year           = 2027
 |month          = 4
 |day            = 15
 |hour           = 19
 |minute         = 40
 |second         = 0
 |alreadystarted = Yay! It started!
}}

If you type in the above, something like the following will appear.

2 years, 162 days, 21 hours, 57 minutes and 41 seconds (Purge)

No description.

Template parameters

Parameter		Description	Type	Status
year	year	no description	Number	required
month	month	no description	Number	required
day	day	no description	Number	required
hour	hour	no description	Number	optional
minute	minute	no description	Number	optional
second	second	no description	Number	optional
alreadystarted	alreadystarted	no description	Line	optional