View source for 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

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


== 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">
{{countdown
 |year  = 2024
 |month = 04
 |day   = 15
 |event = Branch Network Awards Night
}}
</syntaxhighlight>

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

{{countdown
 |year  = 2024
 |month = 04
 |day   = 15
 |event = Branch Network Awards Night
}}

=== Advanced Countdown Clock ===

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

<syntaxhighlight lang="wikitext">
{{countdown
 |year       = 2027
 |month      = 4
 |day        = 15
 |hour       = 19
 |minute     = 40
 |second     = 0
 |event      = 
 |duration   = 21
 |eventstart = unknown has started
 |eventend   = unknown has ended
}}
</syntaxhighlight>

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

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

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