Template:Date formatter: Difference between revisions

Revision as of 00:04, 13 December 2024

This template compares two dates (start date and end date) and formats the output:

If the dates are the same, it displays the single date.
If the dates are different, it displays a range in the format: "December 7, 2024 – December 9, 2024".
If end date is missing, it outputs the start date, but formatted as string.

Usage

he template is designed to work with variables, such as <start date and end date>:

{{Date formatter |<start date>|<end date>}}

Parameters

Parameter	Description	Example
1 (required)	The starting date in the format `YYYY/MM/DD`.	`2024/12/07`
2 (optional)	The ending date in the format `YYYY/MM/DD`. If not provided, the template will output "Invalid input."	`2024/12/09`

Examples

The following examples use hard-coded dates, for examples sake.

{{Date formatter|2024/12/07|2024/12/07}}

December 7, 2024

{{Date formatter |2024/12/07 |2024/12/09}}

December 7, 2024 – December 9, 2024

{{Date formatter |2024/12/07}}

December 7, 2024

@@ Line 5: / Line 5: @@
      {{#time:F j, Y|{{{1}}}}} – {{#time:F j, Y|{{{2}}}}}
    }}|
-   Invalid input
+   {{#time:F j, Y|{{{1}}}}}
 }}
 </includeonly>
 <noinclude>
-This formatting template compares two dates (start_date and end_date). If the dates are the same, it displays the single date; otherwise, it displays a range in the format "December 7, 2024 - December 9, 2024".
+This template compares two dates (<code>start date</code> and <code>end date</code>) and formats the output:
+* If the dates are the same, it displays the single date.
+* If the dates are different, it displays a range in the format: "December 7, 2024 – December 9, 2024".
+* If <code>end date</code> is missing, it outputs the start date, but formatted as string.
 ==Usage==
-It is meant to be used with variables, like <nowiki>{{{start_date}}}</nowiki>:
+he template is designed to work with variables, such as <code><start date</code> and <code>end date</code>>:
 <pre>
-{{Date comparison |<start-date>|<end-date>}}
+{{Date formatter |<start date>|<end date>}}
 </pre>
-===Examples===
+=== Parameters ===
+{| class="wikitable"
+! Parameter !! Description !! Example
+|-
+| '''1''' (required) || The starting date in the format <code>YYYY/MM/DD</code>. || <code>2024/12/07</code>
+|-
+| '''2''' (optional) || The ending date in the format <code>YYYY/MM/DD</code>. If not provided, the template will output "Invalid input." || <code>2024/12/09</code>
+|}
+==Examples==
 The following examples use hard-coded dates, for examples sake.
 <pre>
-{{Date comparison|2024/12/07|2024/12/07}}
+{{Date formatter|2024/12/07|2024/12/07}}
+</pre>
+{{Date formatter|2024/12/07|2024/12/07}}
+<pre>
+{{Date formatter |2024/12/07 |2024/12/09}}
 </pre>
-{{Date comparison|2024/12/07|2024/12/07}}
+{{Date formatter |2024/12/07 |2024/12/09}}
 <pre>
-{{Date comparison |2024/12/07 |2024/12/09}}
+{{Date formatter |2024/12/07}}
 </pre>
-{{Date comparison |2024/12/07 |2024/12/09}}
+{{Date formatter |2024/12/07}}
 </noinclude>