Editing Template:Countdown/doc

{{Documentation/Header}}
{{JS|Gadget-Countdown}}
{{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",
			"example": "UTC+8",
			"suggested": true
		},
		"TimeStart": {
			"label": "Start Time",
			"description": "The time the event starts, formatted as a date",
			"example": "1970-01-01 00:00:00",
			"suggested": true
		},
		"TimeEnd": {
			"label": "End Time",
			"description": "The time the event ends, formatted as a date",
			"example": "1970-01-02 00:00:00",
			"required": true
		},
		"HideText": {
			"label": "Hide Text",
			"description": "Whether to hide the \"ends in\" text",
			"suggested": true
		},
		"EndText": {
			"label": "End Text",
			"description": "The text to display when the event ends",
			"suggested": true
		},
		"CountdownPrefix": {
			"label": "Countdown Prefix",
			"description": "The prefix to use for the end countdown instead of \"Ends in:\"",
			"suggested": true
		}
	},
	"description": "Template for displaying a countdown",
	"paramOrder": [
		"Region",
		"TimeStartOffset",
		"TimeEndOffset",
		"TimeStart",
		"TimeEnd",
		"HideText",
		"EndText",
		"CountdownPrefix"
	]
}
</templatedata>

==Examples==
{{Scrollbox|
==Case: Offset==
<pre>
{{Countdown
|Region=AS
|EventName=Offset1
|TimeStart=2024/01/15 23:00:00
|TimeStartOffset=GMT+8
|TimeEnd=2050/01/31 03:59:59
|TimeEndOffset=GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=Offset1
|TimeStart=2024/01/15 23:00:00
|TimeStartOffset=GMT+8
|TimeEnd=2050/01/31 03:59:59
|TimeEndOffset=GMT+8
}}
==Case: Upcoming==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample1
|TimeStart=2050/01/15 23:00:00 GMT+8
|TimeEnd=2025/01/31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample1
|TimeStart=2050/01/15 23:00:00 GMT+8
|TimeEnd=2025/01/31 03:59:59 GMT+8
}}
==Case: Started==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample2
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample2
|TimeStart=2021-01-8 10:00:00 GMT+8
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
==Case: Long Ended==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample3
|TimeStart=2020-01-16 10:00:00 GMT+8
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample3
|TimeStart=2020-01-16 10:00:00 GMT+8
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
==Case: Blank Start==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2025-01-31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2050-01-31 03:59:59 GMT+8
}}
==Case: Blank Start Ended==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample4
|TimeStart=
|TimeEnd=2020-01-31 03:59:59 GMT+8
}}
==Case: Blank End==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2025-01-31 03:59:59 GMT+8
|TimeEnd=
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2050-01-31 03:59:59 GMT+8
|TimeEnd=
}}
==Case: Blank End Started==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2020-01-31 03:59:59 GMT+8
|TimeEnd=
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample5
|TimeStart=2020-01-31 03:59:59 GMT+8
|TimeEnd=
}}
==Case: Invalid Start==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample6
|TimeStart=aaaaaaaaaaaa
|TimeEnd=2050/01/31 03:59:59 GMT+8
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample6
|TimeStart=aaaaaaaaaaaa
|TimeEnd=2050/01/31 03:59:59 GMT+8
}}
==Case: Invalid End==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample7
|TimeStart=2025/01/16 10:00:00 GMT+8
|TimeEnd=aaaaaaaaaaaa
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample7
|TimeStart=2025/01/16 10:00:00 GMT+8
|TimeEnd=aaaaaaaaaaaa
}}
==Case: Invalid Start End==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample8
|TimeStart=aaaaaaaaaaaa
|TimeEnd=aaaaaaaaaaaa
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample8
|TimeStart=aaaaaaaaaaaa
|TimeEnd=aaaaaaaaaaaa
}}
==Case: Blank==
<pre>
{{Countdown
|Region=AS
|EventName=TemplateExample9
|TimeStart=
|TimeEnd=
}}
</pre>
{{Countdown
|Region=AS
|EventName=TemplateExample9
|TimeStart=
|TimeEnd=
}}
}}
{{clr}}
==General Info==
(Countdown) - Parses EventName, TimeStart and TimeEnd into a countdown, mostly used on event mentioning pages.

*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 not accepted and will throw errors: any dots as they cause non integer values, including dot spacing (2019.1.1) and specifying timezones in non integer (+9.5).
*If no timezone is specified e.g. October 4, 2018 06:00, the syntax automatically assumes UTC.
__NOTOC__