Template:Time ago/sandbox/doc

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


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


 * parameter can be set to explicitly use certain unit. Allowed values are:,  ,  ,  ,  ,   and.
 * parameter can be set to use the specified unit or bigger units. Allowed values are:,  ,  ,  ,   and.
 * parameter can be set to override the default usage of the text " ". If the parameter is blank but not missing (i.e. ), 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  parameter. If  is set to "yes", "y", "true" or "1", all numbers from 1 to 100 will be spelled out. If  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  parameter. For example, setting yes and 24 will result in all numbers less than or equal to 24 being spelled out, and all numbers greater than 24 appearing as numerals.

Purge link
Add the parameter yes to add a purge link.

Examples

 * → 23.612159022006594 years ago
 * Wrong: → 23.612159022006594 years ago
 * → 15.816696693239475 years ago
 * → 15.816696693239475 years ago
 * → 15.816696693239475 years ago
 * → 15.816696693239475 years ago
 * → 15.816696693271181 years ago
 * → 15.816696693271181 years ago
 * → 15.81726746952689 years ago
 * &rarr; 15.249687560851092 years ago
 * &rarr; 25.257906738933286 years ago
 * &rarr; 15.249687560851092 years ago
 * &rarr; 25.257906738933286 years ago
 * &rarr; 35.26338619098807 years ago
 * &rarr; 35.26338619098807 years ago
 * → 194013.1586457725 years from now
 * Wrong: → 194113.22713892316 years from now
 * &rarr; 25.257906738933286 years ago
 * &rarr; 35.26338619098807 years ago
 * &rarr; 35.26338619098807 years ago
 * → 194013.1586457725 years from now
 * Wrong: → 194113.22713892316 years from now

TemplateData
{	"description": "This template calculates the amount of time which has passed since a provided timestamp.", "params": { "1": {			"label": "Timestamp", "description": "Base timestamp for calculation of passed time. Example format: Nov 6 2008, see template documentation for other supported formats.", "type": "string", "required": true },		"magnitude": { "label": "magnitude", "description": "Explicitly sets a specific unit to display return value. Allowed values are: seconds, minutes, hours, days, weeks, months and years.", "type": "string", "required": false },		"min_magnitude": { "label": "min_magnitude", "description": "Sets a minimum unit to display return value. Allowed values are: seconds, minutes, hours, days, months and years.", "type": "string", "required": false },		"ago": { "label": "ago", "description": "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.", "type": "string", "required": false },		"purge": { "label": "Purge link", "description": "Add the parameter purge=yes to add a WP:PURGE link.", "type": "string", "required": false },		"spellout": { "type": "string/line", "label": "Spell out numbers", "description": "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." },		"spelloutmax": { "type": "number", "label": "Spell out max", "description": "The maximum number to be spelled out as an English word." }	} }