Template:Date-calc/doc

From Test Wiki
Revision as of 17:29, 17 December 2024 by TheAstorPastor (talk | contribs) (Created page with "<!-- Template Documentation --> == Usage == The `Date-calc` template performs date arithmetic (addition or subtraction) using days, weeks, and months. It is useful for calculating dates relative to a given date. == Parameters == * date – The starting date in any valid format recognizable by the `#time` parser function (e.g., `1 April 2024`, `{{TODAY}}`). ==Required== * operation – Specifies whether to add or subtract time. Valid values are: * add * subtract * d...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage[edit]

The `Date-calc` template performs date arithmetic (addition or subtraction) using days, weeks, and months. It is useful for calculating dates relative to a given date.

Parameters[edit]

  • date – The starting date in any valid format recognizable by the `#time` parser function (e.g., `1 April 2024`, `17 December 2024`).

Required[edit]

  • operation – Specifies whether to add or subtract time. Valid values are:
 * add
 * subtract
  • days – The number of days to add or subtract. Defaults to 0 if not provided.
  • weeks – The number of weeks to add or subtract. Defaults to 0 if not provided.
  • months – The number of months to add or subtract. Defaults to 0 if not provided.

Output[edit]

The template outputs the resulting date in the format DD Month YYYY (e.g., 15 January 2024).

Examples[edit]

Adding Time[edit]

  • To add 2 months and 10 days to 1 January 2024:
 
  {{Date-calc|date=1 January 2024|operation=add|months=2|days=10}}
  
 Output: 11 March 2024
  • To add 3 weeks to today's date:
 
  {{Date-calc|date={{TODAY}}|operation=add|weeks=3}}
  
 Output: (depends on today's date)

Subtracting Time[edit]

  • To subtract 1 month and 2 weeks from 17 December 2024:
 
  {{Date-calc|date=17 December 2024|operation=subtract|months=1|weeks=2}}
  
 Output: 3 November 2024
  • To subtract 15 days from 15 March 2024:
 
  {{Date-calc|date=15 March 2024|operation=subtract|days=15}}
  
 Output: 29 February 2024

Error Handling[edit]

If required parameters are missing:

 
  {{Date-calc|date=|operation=add}}
  
 Output: Please specify a valid date and operation (add or subtract).

Notes[edit]

  • The template uses the `#time` parser function, which supports various date formats.
  • The `days`, `weeks`, and `months` parameters can be used together or separately.
  • If all time parameters (days, weeks, and months) are omitted, no calculation is performed, and the input date is returned as-is.