Draft: New Countdown Template - Revision history

AvidConanContributor: /* timeDiff */ Added link in section heading

2025-01-01T22:41:12Z

timeDiff: Added link in section heading

← Older revision		Revision as of 22:41, 1 January 2025
Line 22:		Line 22:
	=== Sub-templates ===		=== Sub-templates ===
	Sub-templates are smaller templates used to help make the entire template more manageable, similar to variables. '''Do note:''' "Sub-templates," as far as I can tell, is not a standard technical term.		Sub-templates are smaller templates used to help make the entire template more manageable, similar to variables. '''Do note:''' "Sub-templates," as far as I can tell, is not a standard technical term.
	==== timeDiff ====		==== [[Template:timeDiff\|timeDiff]] ====
	Calculates the difference between the current time and a defined time.		Calculates the difference between the current time and a defined time.

AvidConanContributor at 22:29, 1 January 2025

2025-01-01T22:29:49Z

← Older revision		Revision as of 22:29, 1 January 2025
Line 4:		Line 4:
	This page is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].		This page is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].

	== ~~Planned~~ ==		== Completed ==
	~~Elements of the template found in this section are either in progress or simply hypothetical. They are used to guide the process of creating the template.~~
	=== Parameters ===		=== Parameters ===
	==== 'end-date' ====		==== 'end-date' ====
Line 21:		Line 20:
	If left blank, the template will default to UTC+0.		If left blank, the template will default to UTC+0.

			=== Sub-templates ===
			Sub-templates are smaller templates used to help make the entire template more manageable, similar to variables. '''Do note:''' "Sub-templates," as far as I can tell, is not a standard technical term.
			==== timeDiff ====
			Calculates the difference between the current time and a defined time.

			== Planned ==
			Elements of the template found in this section are either in progress or simply hypothetical. They are used to guide the process of creating the template.
			=== Parameters ===
	==== 'display-style' ====		==== 'display-style' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>

AvidConanContributor: /* Parameters */ Converted underscores to hyphen in parameter names since that looks like the standard for wikis

2024-12-31T22:52:48Z

Parameters: Converted underscores to hyphen in parameter names since that looks like the standard for wikis

← Older revision		Revision as of 22:52, 31 December 2024
Line 7:		Line 7:
	Elements of the template found in this section are either in progress or simply hypothetical. They are used to guide the process of creating the template.		Elements of the template found in this section are either in progress or simply hypothetical. They are used to guide the process of creating the template.
	=== Parameters ===		=== Parameters ===
	==== '~~end_date~~' ====		==== 'end-date' ====
	*'''Required?:''' Yes<br>		*'''Required?:''' Yes<br>
	The date that the countdown ends. It can be in any date format that the #time parser function supports.		The date that the countdown ends. It can be in any date format that the #time parser function supports.

	==== '~~end_time~~' ====		==== 'end-time' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The time that the countdown ends, on the day defined by ''''end date''''. It can be in any time format that the #time parser function supports.<br>		The time that the countdown ends, on the day defined by ''''end-date''''. It can be in any time format that the #time parser function supports.<br>
	If left blank, the template will default to midnight.		If left blank, the template will default to midnight.

	==== '~~utc_offset~~' ====		==== 'utc-offset' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The time zone of the ''''~~end_time~~''' parameter, defined by the number of hours offset from UTC.<br>		The time zone of the ''''end-time''' parameter, defined by the number of hours offset from UTC.<br>
	If left blank, the template will default to UTC+0.		If left blank, the template will default to UTC+0.

	==== '~~display_style~~' ====		==== 'display-style' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The style of the countdown, which can be either text or a visual clock (created by using a table with invisible borders).		The style of the countdown, which can be either text or a visual clock (created by using a table with invisible borders).
	If left blank, the template will default to text.		If left blank, the template will default to text.

	==== '~~first_time_unit~~' ====		==== 'first-time-unit' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The first time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the largest unit of time is hours, not days. If ''''~~first_time_unit~~'''' is more precise than ''''~~last_time_unit~~'''', the template will not return anything.<br>		The first time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the largest unit of time is hours, not days. If ''''first-time-unit'''' is more precise than ''''last-time-unit'''', the template will not return anything.<br>
	If left blank, the template defaults to using days.		If left blank, the template defaults to using days.

	==== '~~last_time_unit~~' ====		==== 'last-time-unit' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The last time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the smallest unit of time is hours, not minutes or seconds. If ''''~~last_time_unit~~'''' is less precise than ''''~~first_time_unit~~'''', the template will not return anything.<br>		The last time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the smallest unit of time is hours, not minutes or seconds. If ''''last-time-unit'''' is less precise than ''''first-time-unit'''', the template will not return anything.<br>
	If left blank and ''''~~end_time~~'''' is also blank, the template defaults to using days as the last time unit. If left blank, but ''''end time'''' is not blank, the template defaults to using seconds.		If left blank and ''''end-time'''' is also blank, the template defaults to using days as the last time unit. If left blank, but ''''end time'''' is not blank, the template defaults to using seconds.

	==== '~~when_zero~~' ====		==== 'when-zero' ====
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The message to return or action to do when the countdown reaches zero. This can be used either to display a message or pass on an action to another part of a larger template. ''''~~display_style~~'''' does not affect this parameter.<br>		The message to return or action to do when the countdown reaches zero. This can be used either to display a message or pass on an action to another part of a larger template. ''''display-style'''' does not affect this parameter.<br>
	The template will not use a default for this parameter when blank.		The template will not use a default for this parameter when blank.

AvidConanContributor: Removed Variables section

2024-12-28T03:45:49Z

Removed Variables section

← Older revision		Revision as of 03:45, 28 December 2024
Line 40:		Line 40:
	The message to return or action to do when the countdown reaches zero. This can be used either to display a message or pass on an action to another part of a larger template. ''''display_style'''' does not affect this parameter.<br>		The message to return or action to do when the countdown reaches zero. This can be used either to display a message or pass on an action to another part of a larger template. ''''display_style'''' does not affect this parameter.<br>
	The template will not use a default for this parameter when blank.		The template will not use a default for this parameter when blank.

	~~=== Variables ===~~
	~~(Note: Check to see if variables can be used in this wiki before writing any documentation for this section)~~

	== Usages ==		== Usages ==

AvidConanContributor: Added contributors section

2024-12-27T03:44:08Z

Added contributors section

← Older revision		Revision as of 03:44, 27 December 2024
Line 47:		Line 47:
	* Countdown to episode broadcasts and manga file releases		* Countdown to episode broadcasts and manga file releases
	* Control the '''newepisode''' and '''newmovie''' templates to display a different message when either type of program has been broadcasted/released.		* Control the '''newepisode''' and '''newmovie''' templates to display a different message when either type of program has been broadcasted/released.

			== Contributors ==
			<!-- Add your signature in this bullet list to join the project! No need to be dedicate yourself 100%, this is just so we can track who is officially making edits

			To add your signature, use "~~~" (no quotes).
			-->
			* [[User:AvidConanContributor\|Avico]] ([[User talk:AvidConanContributor\|talk]])

AvidConanContributor at 22:56, 26 December 2024

2024-12-26T22:56:36Z

← Older revision		Revision as of 22:56, 26 December 2024
Line 1:		Line 1:
	The actual draft for the template can be found here: [[Template:Countdown/sandbox]]<br>		The actual draft for the template can be found here: [[Template:Countdown/sandbox]]<br>
			The test page for the draft template is found here: [[Template:Countdown/testcases]]

	This page is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].		This page is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].

AvidConanContributor at 22:55, 26 December 2024

2024-12-26T22:55:27Z

← Older revision		Revision as of 22:55, 26 December 2024
Line 32:		Line 32:
	*'''Required?:''' Optional<br>		*'''Required?:''' Optional<br>
	The last time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the smallest unit of time is hours, not minutes or seconds. If ''''last_time_unit'''' is less precise than ''''first_time_unit'''', the template will not return anything.<br>		The last time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the smallest unit of time is hours, not minutes or seconds. If ''''last_time_unit'''' is less precise than ''''first_time_unit'''', the template will not return anything.<br>
	If left blank and ''''end_time'''' is also blank, the template defaults to using days. If left blank, but ''''end time'''' is not blank, the template defaults to using seconds.		If left blank and ''''end_time'''' is also blank, the template defaults to using days as the last time unit. If left blank, but ''''end time'''' is not blank, the template defaults to using seconds.

	==== 'when_zero' ====		==== 'when_zero' ====

AvidConanContributor at 22:54, 26 December 2024

2024-12-26T22:54:11Z

← Older revision		Revision as of 22:54, 26 December 2024
Line 1:		Line 1:
	The draft for ~~this~~ template can be found here: [[Template:Countdown/sandbox]]<br>		The actual draft for the template can be found here: [[Template:Countdown/sandbox]]<br>
	This page ~~itself~~ is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].		This page is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].

	== Planned ==		== Planned ==

AvidConanContributor at 22:36, 26 December 2024

2024-12-26T22:36:13Z

← Older revision		Revision as of 22:36, 26 December 2024
Line 1:		Line 1:
	The draft for this template can be found here: [[Template:Countdown/sandbox]]		The draft for this template can be found here: [[Template:Countdown/sandbox]]<br>
	This page itself is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].		This page itself is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].

AvidConanContributor: Replaced the redirect with a draft documentation of the new template

2024-12-26T22:35:59Z

Replaced the redirect with a draft documentation of the new template

← Older revision		Revision as of 22:35, 26 December 2024
Line 1:		Line 1:
	~~#REDIRECT~~ [[Template:~~NewCountdown~~]]		The draft for this template can be found here: [[Template:Countdown/sandbox]]
			This page itself is a draft of the documentation that will eventually be moved over to [[Template:Countdown]].

			== Planned ==
			Elements of the template found in this section are either in progress or simply hypothetical. They are used to guide the process of creating the template.
			=== Parameters ===
			==== 'end_date' ====
			*'''Required?:''' Yes<br>
			The date that the countdown ends. It can be in any date format that the #time parser function supports.

			==== 'end_time' ====
			*'''Required?:''' Optional<br>
			The time that the countdown ends, on the day defined by ''''end date''''. It can be in any time format that the #time parser function supports.<br>
			If left blank, the template will default to midnight.

			==== 'utc_offset' ====
			*'''Required?:''' Optional<br>
			The time zone of the ''''end_time''' parameter, defined by the number of hours offset from UTC.<br>
			If left blank, the template will default to UTC+0.

			==== 'display_style' ====
			*'''Required?:''' Optional<br>
			The style of the countdown, which can be either text or a visual clock (created by using a table with invisible borders).
			If left blank, the template will default to text.

			==== 'first_time_unit' ====
			*'''Required?:''' Optional<br>
			The first time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the largest unit of time is hours, not days. If ''''first_time_unit'''' is more precise than ''''last_time_unit'''', the template will not return anything.<br>
			If left blank, the template defaults to using days.

			==== 'last_time_unit' ====
			*'''Required?:''' Optional<br>
			The last time unit to be displayed on the countdown. For example, putting "hours" will create a countdown where the smallest unit of time is hours, not minutes or seconds. If ''''last_time_unit'''' is less precise than ''''first_time_unit'''', the template will not return anything.<br>
			If left blank and ''''end_time'''' is also blank, the template defaults to using days. If left blank, but ''''end time'''' is not blank, the template defaults to using seconds.

			==== 'when_zero' ====
			*'''Required?:''' Optional<br>
			The message to return or action to do when the countdown reaches zero. This can be used either to display a message or pass on an action to another part of a larger template. ''''display_style'''' does not affect this parameter.<br>
			The template will not use a default for this parameter when blank.

			=== Variables ===
			(Note: Check to see if variables can be used in this wiki before writing any documentation for this section)

			== Usages ==
			* Countdown to episode broadcasts and manga file releases
			* Control the '''newepisode''' and '''newmovie''' templates to display a different message when either type of program has been broadcasted/released.