Editing Template:Countdown/doc
Appearance
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
{{Documentation/Header}} | {{Documentation/Header}} | ||
{{See also|Template:Countdownall}} | {{See also|Template:Countdownall}} | ||
== Parameters == | == Parameters == | ||
| Line 66: | Line 65: | ||
==Examples== | ==Examples== | ||
<div class="mw-collapsible mw-collapsed"> | |||
==Case: Offset== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 74: | Line 73: | ||
|TimeStart=2024/01/15 23:00:00 | |TimeStart=2024/01/15 23:00:00 | ||
|TimeStartOffset=GMT+8 | |TimeStartOffset=GMT+8 | ||
|TimeEnd= | |TimeEnd=2025/01/31 03:59:59 | ||
|TimeEndOffset=GMT+8 | |TimeEndOffset=GMT+8 | ||
}} | }} | ||
| Line 83: | Line 82: | ||
|TimeStart=2024/01/15 23:00:00 | |TimeStart=2024/01/15 23:00:00 | ||
|TimeStartOffset=GMT+8 | |TimeStartOffset=GMT+8 | ||
|TimeEnd= | |TimeEnd=2025/01/31 03:59:59 | ||
|TimeEndOffset=GMT+8 | |TimeEndOffset=GMT+8 | ||
}} | }} | ||
==Case: Upcoming== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
|Region=AS | |Region=AS | ||
|EventName=TemplateExample1 | |EventName=TemplateExample1 | ||
|TimeStart= | |TimeStart=2025/01/15 23:00:00 GMT+8 | ||
|TimeEnd=2025/01/31 03:59:59 GMT+8 | |TimeEnd=2025/01/31 03:59:59 GMT+8 | ||
}} | }} | ||
| Line 98: | Line 97: | ||
|Region=AS | |Region=AS | ||
|EventName=TemplateExample1 | |EventName=TemplateExample1 | ||
|TimeStart= | |TimeStart=2025/01/15 23:00:00 GMT+8 | ||
|TimeEnd=2025/01/31 03:59:59 GMT+8 | |TimeEnd=2025/01/31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Started== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 107: | Line 106: | ||
|EventName=TemplateExample2 | |EventName=TemplateExample2 | ||
|TimeStart=2021-01-8 10:00:00 GMT+8 | |TimeStart=2021-01-8 10:00:00 GMT+8 | ||
|TimeEnd= | |TimeEnd=2025-01-31 03:59:59 GMT+8 | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 114: | Line 113: | ||
|EventName=TemplateExample2 | |EventName=TemplateExample2 | ||
|TimeStart=2021-01-8 10:00:00 GMT+8 | |TimeStart=2021-01-8 10:00:00 GMT+8 | ||
|TimeEnd= | |TimeEnd=2025-01-31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Long Ended== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 131: | Line 130: | ||
|TimeEnd=2020-01-31 03:59:59 GMT+8 | |TimeEnd=2020-01-31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Blank Start== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 144: | Line 143: | ||
|EventName=TemplateExample4 | |EventName=TemplateExample4 | ||
|TimeStart= | |TimeStart= | ||
|TimeEnd= | |TimeEnd=2025-01-31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Blank Start Ended== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 161: | Line 160: | ||
|TimeEnd=2020-01-31 03:59:59 GMT+8 | |TimeEnd=2020-01-31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Blank End== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 173: | Line 172: | ||
|Region=AS | |Region=AS | ||
|EventName=TemplateExample5 | |EventName=TemplateExample5 | ||
|TimeStart= | |TimeStart=2025-01-31 03:59:59 GMT+8 | ||
|TimeEnd= | |TimeEnd= | ||
}} | }} | ||
==Case: Blank End Started== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 191: | Line 190: | ||
|TimeEnd= | |TimeEnd= | ||
}} | }} | ||
==Case: Invalid Start== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 197: | Line 196: | ||
|EventName=TemplateExample6 | |EventName=TemplateExample6 | ||
|TimeStart=aaaaaaaaaaaa | |TimeStart=aaaaaaaaaaaa | ||
|TimeEnd= | |TimeEnd=2025/01/31 03:59:59 GMT+8 | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 204: | Line 203: | ||
|EventName=TemplateExample6 | |EventName=TemplateExample6 | ||
|TimeStart=aaaaaaaaaaaa | |TimeStart=aaaaaaaaaaaa | ||
|TimeEnd= | |TimeEnd=2025/01/31 03:59:59 GMT+8 | ||
}} | }} | ||
==Case: Invalid End== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 221: | Line 220: | ||
|TimeEnd=aaaaaaaaaaaa | |TimeEnd=aaaaaaaaaaaa | ||
}} | }} | ||
==Case: Invalid Start End== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 236: | Line 235: | ||
|TimeEnd=aaaaaaaaaaaa | |TimeEnd=aaaaaaaaaaaa | ||
}} | }} | ||
==Case: Blank== | |||
<pre> | <pre> | ||
{{Countdown | {{Countdown | ||
| Line 251: | Line 250: | ||
|TimeEnd= | |TimeEnd= | ||
}} | }} | ||
</div> | |||
{{clr}} | {{clr}} | ||
==General Info== | ==General Info== | ||
(Countdown) - Parses EventName, TimeStart and TimeEnd into a countdown, mostly used on event mentioning pages. | (Countdown) - Parses EventName, TimeStart and TimeEnd into a countdown, mostly used on event mentioning pages. | ||
*This template works with a JavaScript snippet imported from the [https://dev.fandom.com/wiki/Countdown developer's wiki] into this wiki's [[MediaWiki:ImportJS]]. It does NOT use the countdown extension. | |||
*Utilizes the [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions parser functions] <nowiki>{{#time:F d, Y h:i:s A e|}} and {{#time:F d, Y|}}</nowiki> and is thus able to accept a variety of formats which are parsed and stored internally as UTC. | *Utilizes the [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions parser functions] <nowiki>{{#time:F d, Y h:i:s A e|}} and {{#time:F d, Y|}}</nowiki> and is thus able to accept a variety of formats which are parsed and stored internally as UTC. | ||
*The following are accepted: backslashes (2019/1/1), dashes (2019-1-1), most manner of timezones (+9, +9 hours. +0930, JST, GMT +9) and commas in the correct spacing (November 20, 2019). | *The following are accepted: backslashes (2019/1/1), dashes (2019-1-1), most manner of timezones (+9, +9 hours. +0930, JST, GMT +9) and commas in the correct spacing (November 20, 2019). | ||