The Petit Planet Wiki

Template:Countdown/doc: Difference between revisions

Browse history interactively

ReisuDesign (talk | contribs)

3 user groups
4,145 edits
undo
VisualWikitext
Created page with "{{Documentation/Header}} {{See also|Template:Countdownall}} == Parameters == <templatedata> { "params": { "Region": { "description": "The region the countdown is for", "example": "NA", "suggested": true }, "TimeStartOffset": { "label": "Start Offset", "description": "The offset for the start time", "example": "UTC+8", "suggested": true }, "TimeEndOffset": { "label": "End Offset", "description": "The offset for the end time", "exam..."
 
ReisuDesign (talk | contribs)
confirmed, Interface administrators, moderator
4,145 edits
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Documentation/Header}}
{{Documentation/Header}}
{{JS|Gadget-Countdown}}
{{See also|Template:Countdownall}}
{{See also|Template:Countdownall}}
== Parameters ==
== Parameters ==
Line 65: Line 66:


==Examples==
==Examples==
<div class="mw-collapsible mw-collapsed">
{{Scrollbox|
==Case: Offset==
===Case: Offset===
<pre>
<pre>
{{Countdown
{{Countdown
Line 73: Line 74:
|TimeStart=2024/01/15 23:00:00
|TimeStart=2024/01/15 23:00:00
|TimeStartOffset=GMT+8
|TimeStartOffset=GMT+8
|TimeEnd=2025/01/31 03:59:59
|TimeEnd=2050/01/31 03:59:59
|TimeEndOffset=GMT+8
|TimeEndOffset=GMT+8
}}
}}
Line 82: Line 83:
|TimeStart=2024/01/15 23:00:00
|TimeStart=2024/01/15 23:00:00
|TimeStartOffset=GMT+8
|TimeStartOffset=GMT+8
|TimeEnd=2025/01/31 03:59:59
|TimeEnd=2050/01/31 03:59:59
|TimeEndOffset=GMT+8
|TimeEndOffset=GMT+8
}}
}}
==Case: Upcoming==
===Case: Upcoming===
<pre>
<pre>
{{Countdown
{{Countdown
|Region=AS
|Region=AS
|EventName=TemplateExample1
|EventName=TemplateExample1
|TimeStart=2025/01/15 23:00:00 GMT+8
|TimeStart=2050/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 97: Line 98:
|Region=AS
|Region=AS
|EventName=TemplateExample1
|EventName=TemplateExample1
|TimeStart=2025/01/15 23:00:00 GMT+8
|TimeStart=2050/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==
===Case: Started===
<pre>
<pre>
{{Countdown
{{Countdown
Line 106: Line 107:
|EventName=TemplateExample2
|EventName=TemplateExample2
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeEnd=2025-01-31 03:59:59 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
}}
</pre>
</pre>
Line 113: Line 114:
|EventName=TemplateExample2
|EventName=TemplateExample2
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeEnd=2025-01-31 03:59:59 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
}}
==Case: Long Ended==
===Case: Long Ended===
<pre>
<pre>
{{Countdown
{{Countdown
Line 130: Line 131:
|TimeEnd=2020-01-31 03:59:59 GMT+8
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
}}
==Case: Blank Start==
===Case: Blank Start===
<pre>
<pre>
{{Countdown
{{Countdown
Line 143: Line 144:
|EventName=TemplateExample4
|EventName=TemplateExample4
|TimeStart=
|TimeStart=
|TimeEnd=2025-01-31 03:59:59 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
}}
==Case: Blank Start Ended==
===Case: Blank Start Ended===
<pre>
<pre>
{{Countdown
{{Countdown
Line 160: Line 161:
|TimeEnd=2020-01-31 03:59:59 GMT+8
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
}}
==Case: Blank End==
===Case: Blank End===
<pre>
<pre>
{{Countdown
{{Countdown
Line 172: Line 173:
|Region=AS
|Region=AS
|EventName=TemplateExample5
|EventName=TemplateExample5
|TimeStart=2025-01-31 03:59:59 GMT+8
|TimeStart=2050-01-31 03:59:59 GMT+8
|TimeEnd=
|TimeEnd=
}}
}}
==Case: Blank End Started==
===Case: Blank End Started===
<pre>
<pre>
{{Countdown
{{Countdown
Line 190: Line 191:
|TimeEnd=
|TimeEnd=
}}
}}
==Case: Invalid Start==
===Case: Invalid Start===
<pre>
<pre>
{{Countdown
{{Countdown
Line 196: Line 197:
|EventName=TemplateExample6
|EventName=TemplateExample6
|TimeStart=aaaaaaaaaaaa
|TimeStart=aaaaaaaaaaaa
|TimeEnd=2025/01/31 03:59:59 GMT+8
|TimeEnd=2050/01/31 03:59:59 GMT+8
}}
}}
</pre>
</pre>
Line 203: Line 204:
|EventName=TemplateExample6
|EventName=TemplateExample6
|TimeStart=aaaaaaaaaaaa
|TimeStart=aaaaaaaaaaaa
|TimeEnd=2025/01/31 03:59:59 GMT+8
|TimeEnd=2050/01/31 03:59:59 GMT+8
}}
}}
==Case: Invalid End==
===Case: Invalid End===
<pre>
<pre>
{{Countdown
{{Countdown
Line 220: Line 221:
|TimeEnd=aaaaaaaaaaaa
|TimeEnd=aaaaaaaaaaaa
}}
}}
==Case: Invalid Start End==
===Case: Invalid Start End===
<pre>
<pre>
{{Countdown
{{Countdown
Line 235: Line 236:
|TimeEnd=aaaaaaaaaaaa
|TimeEnd=aaaaaaaaaaaa
}}
}}
==Case: Blank==
===Case: Blank===
<pre>
<pre>
{{Countdown
{{Countdown
Line 250: Line 251:
|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).
Retrieved from "https://petitplanet.wiki/Template:Countdown/doc"