Template:Time ago/doc

Safer nicotine wiki Tobacco Harm Reduction
Jump to navigation Jump to search

The Time ago template calculates the amount of time which has passed since a provided timestamp. The result is a string similar to one of the examples below. This template should not be used with "subst" unless you don't want the stamp to change as the user refreshes the page.

Note that due to Wikipedia's caching mechanisms, you may need to purge a page using this template to update the dynamic value. See the section Purge below.

The result is rounded down. "Month" is defined as 31 days.

Usage

  • {{Time ago|timestamp}}

The timestamp can be almost any solid, readable format but to avoid ambiguity mistakes, one of the styles below is preferred.

  • magnitude parameter can be set to explicitly use certain unit. Allowed values are: seconds, minutes, hours, days, weeks, months and years.
  • min_magnitude parameter can be set to use the specified unit or bigger units. Allowed values are: seconds, minutes, hours, days, months and years.
  • ago parameter can be set to override the default usage of the text "ago". If the parameter is blank but not missing (i.e. {{time ago|2008|ago=}}), then the text "ago" is suppressed altogether. For future dates, setting "ago" as blank but not missing will suppress the text "time" (i.e. "2 years" instead of "2 years' time").

Spelling out numbers

Numbers from 1 to 100 can be spelled out in their equivalent English word by using the spellout parameter. If spellout is set to "yes", "y", "true" or "1", all numbers from 1 to 100 will be spelled out. If spellout is set to "auto", only numbers from 1 to 9 will be spelled out, as per the recommendations at MOS:NUMERAL.

It is also possible to set a custom maximum value for spelling out by using the spelloutmax parameter. For example, setting |spellout=yes and |spelloutmax=24 will result in all numbers less than or equal to 24 being spelled out, and all numbers greater than 24 appearing as numerals.

Numeric output

Add |numeric=y to print the number only (no text).

Purge link

Add the parameter |purge=yes to add a purge link.

Examples

  • {{Time ago| -83 minutes}}82 minutes ago
  • {{Time ago| -334 minutes}}5 hours ago
  • {{Time ago| +334 minutes}}5 hours' time
  • {{Time ago|{{REVISIONTIMESTAMP}}}}2 years ago
  • {{Time ago| Jan 21, 2001 3:45 PM}}23 years ago
  • Wrong: {{Time ago| 3:45 pm, 21 Jan 2001}}Error: first parameter cannot be parsed as a date or time.
  • {{Time ago|20010121154500}}23 years ago
  • {{Time ago| Nov 6 2008}}15 years ago
  • {{Time ago| Nov 6 2008|magnitude=weeks}}801 weeks ago
  • {{Time ago| Nov 6 2008|min_magnitude=days}}15 years ago
  • {{Time ago| Nov 6 2008|min_magnitude=years}}15 years ago
  • {{Time ago| Nov 6 2008|ago=in the past}}15 years in the past
  • {{Time ago| Nov 6 2008|purge=yes}}15 years ago (purge)
  • {{Time ago| 2008-11-06}}15 years ago
  • {{Time ago| June 1, 2009|spellout=yes}}fourteen years ago
  • {{Time ago| June 1, 1999|spellout=yes}}twenty-four years ago
  • {{Time ago| June 1, 2009|spellout=auto}}14 years ago
  • {{Time ago| June 1, 1999|spellout=auto}}24 years ago
  • {{Time ago| June 1, 1989|spellout=yes|spelloutmax=15}}34 years ago
  • {{Time ago| June 1, 1989|spellout=yes|spelloutmax=25}}34 years ago
  • {{Time ago|195909}}7 hours' time
  • Wrong: {{Time ago|196009}}Error: first parameter cannot be parsed as a date or time.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Time ago

This template calculates the amount of time which has passed since a provided timestamp.

Template parameters

ParameterDescriptionTypeStatus
Timestamp1

Base timestamp for calculation of passed time. Example format: Nov 6 2008, see template documentation for other supported formats.

Stringrequired
magnitudemagnitude

Explicitly sets a specific unit to display return value. Allowed values are: seconds, minutes, hours, days, weeks, months and years.

Stringoptional
min_magnitudemin_magnitude

Sets a minimum unit to display return value. Allowed values are: seconds, minutes, hours, days, months and years.

Stringoptional
agoago

Override the default usage of the text 'ago'. If it is blank but not missing then 'ago' will be removed completely; for future dates, this will remove the text 'time' as well.

Stringoptional
Purge linkpurge

Add the parameter purge=yes to add a WP:PURGE link.

Stringoptional
Spell out numbersspellout

If set to "yes", "y", "true" or "1", numbers from 1 to 100 are spelled out as English words. If set to "auto", numbers from 1 to 9 are spelled out.

Lineoptional
Spell out maxspelloutmax

The maximum number to be spelled out as an English word.

Numberoptional

See also