Template:Countdown/doc

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

This template uses Lua:

Module:Countdown

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

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.

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.

<syntaxhighlight lang="wikitext"> Branch Network Awards Night has started. (refresh) </syntaxhighlight>

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

Branch Network Awards Night has started. (refresh)

Advanced Countdown Clock

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

<syntaxhighlight lang="wikitext"> There are 2 years, 16 weeks, 1 day, 5 hours, 56 minutes and 5 seconds until the event begins. (refresh) </syntaxhighlight>

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

There are 2 years, 16 weeks, 1 day, 5 hours, 56 minutes and 5 seconds until the event begins. (refresh)

<templatedata> { "params": { "year": {}, "month": {}, "day": {}, "hour": {}, "minute": {}, "second": {}, "event": {}, "duration": {}, "eventstart": {}, "eventend": {} } } </templatedata>