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. |
Uses Lua: |
Notes
[edit]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).
Usage
[edit]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
[edit]This type of countdown clock is suitable for events with no duration.
{{countdown |year = 2020 |month = 04 |day = 15 |event = Branch Network Awards Night }}
If you type in the above, something like the following will appear.
Branch Network Awards Night has started. (refresh)
Advanced Countdown Clock
[edit]This type of countdown clock is suitable for events with a duration.
{{countdown |year = 2022 |month = 4 |day = 15 |hour = 19 |minute = 40 |second = 0 |event = |duration = 21 |eventstart = unknown has started |eventend = unknown has ended |countup = no }}
If you type in the above, something like the following will appear.
unknown has ended (refresh)
Note: when the event is concluded, but you still want to see the amount of days passed, set countup
to yes
.
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
year | year | no description | Unknown | optional |
month | month | no description | Unknown | optional |
day | day | no description | Unknown | optional |
hour | hour | no description | Unknown | optional |
minute | minute | no description | Unknown | optional |
second | second | no description | Unknown | optional |
event | event | no description | Unknown | optional |
duration | duration | no description | Unknown | optional |
eventstart | eventstart | no description | Unknown | optional |
eventend | eventend | no description | Unknown | optional |
countup | countup | no description | Unknown | optional |