Template:Countdown/doc

This is a documentation subpage for Template:Countdown. It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua: Module:Countdown

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

Duration is in seconds, so duration=3600 for a one-hour event. Alternatively, duration and duration unit=//unit// can be used in unison (e.g., duration=1|duration unit=year).

This template should not be used in articles per MOS:TIME and MOS:DATED.

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.

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

{{countdown
 |year  = 2028
 |month = 11
 |day   = 7
 |event = 2028 us presidential election
}}

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

There are 2 years, 86 days, 19 hours, 13 minutes and 42 seconds until 2028 us presidential election. (refresh)

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

{{countdown
 |year       = 2027
 |month      = 4
 |day        = 15
 |hour       = 19
 |minute     = 40
 |second     = 0
 |event      = 
 |duration   = 21
 |eventstart = unknown has started
 |eventend   = unknown has ended
}}

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

There are 245 days, 14 hours, 32 minutes and 6 seconds until the event begins. (refresh)