Template:Countdown/doc
Template page
More actions
- Description
- This template creates a countdown to a specific date and time and then performs a specified action such as displaying a post countdown message or removing itself from the page. It is a shortcut to creating a countdown using the
<span class="countdown">tags.
- Syntax
- The template allows one or more optional parameters to be set but the following must be set before it will function.
- Required
- Countdown time
- To set the time, the following format is required: Month Day Year HH:MM:SS.
- Typing
{{Countdown|countdown time=January 01 2015 00:00:00}}for example will set the countdown to count down to the date and time set.
- Optional
- Countdown timezone
- By default, the countdown time is based on the local timezone of the user viewing the page. In order to specify a timezone, you can type the following after the countdown time: -offset in 24 hours
- Typing
{{Countdown|countdown time=January 01 2015 00:00:00 -0500}}for example will set the countdown with an offset to match the desired timezone.
- Pre text and post text
- A pre and post message can be set before and after the countdown timer when the countdown is actively running.
- Typing
{{Countdown|pre text=There are|post text=left until it all goes down.}}will output:
There are COUNTDOWN left until it all goes down.
- Post countdown
- By default, when the countdown ends it will start counting up past the countdown time. This behavior can be changed in a number of ways by setting a method to use when the countdown ends. There are multiple methods that can be chosen:
- Remove - This will remove the countdown from the article.
- Stop - This will stop the countdown when it reaches zero. It will NOT count up.
- Toggle - This displays a new custom message when the countdown ends. This requires that the countdown end text parameter is used to yield any useful results.
- Typing
{{Countdown|post countdown=Stop}}for example will tell the countdown to not count past zero.
- Dependencies
- This template uses the Countdown script imported from dev.wikia.