Template:Time ago/doc: Difference between revisions
meta>GermanJoe + TD header |
meta>Zyxw add see also links |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{high-risk|100,000+}} | {{high-risk|100,000+}} | ||
<!-- | <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | ||
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. | 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. | ||
| Line 8: | Line 9: | ||
The result is rounded down. "Month" is defined as 31 days. | The result is rounded down. "Month" is defined as 31 days. | ||
== Usage == | |||
* <code><nowiki>{{</nowiki>'''Time ago'''|''timestamp''<nowiki>}}</nowiki></code> | * <code><nowiki>{{</nowiki>'''Time ago'''|''timestamp''<nowiki>}}</nowiki></code> | ||
| Line 17: | Line 18: | ||
* <code>ago</code> parameter can be set to override the default usage of the text "<code>ago</code>". | * <code>ago</code> parameter can be set to override the default usage of the text "<code>ago</code>". | ||
=== Purge === | |||
Add the parameter {{para|purge|yes}} to add a [[WP:PURGE|purge]] link. | Add the parameter {{para|purge|yes}} to add a [[WP:PURGE|purge]] link. | ||
== Examples == | |||
* {{tlc|Time ago| -83 minutes}} → '''{{Time ago|-83 minutes}}''' | * {{tlc|Time ago| -83 minutes}} → '''{{Time ago|-83 minutes}}''' | ||
* {{tlc|Time ago| -334 minutes}} → '''{{Time ago|-334 minutes}}''' | * {{tlc|Time ago| -334 minutes}} → '''{{Time ago|-334 minutes}}''' | ||
| Line 33: | Line 34: | ||
* {{tlc|Time ago| 2008-11-06}} → '''{{Time ago|2008-11-06}}''' | * {{tlc|Time ago| 2008-11-06}} → '''{{Time ago|2008-11-06}}''' | ||
== TemplateData == | |||
{{TemplateDataHeader}} | {{TemplateDataHeader}} | ||
<TemplateData> | <TemplateData> | ||
| Line 73: | Line 74: | ||
</TemplateData> | </TemplateData> | ||
== See also == | |||
* {{tl|Last edited by}} | * {{tl|Last edited by}} | ||
* {{tl|Years or months ago}} | |||
* {{tl|Age}} | |||
* {{tl|Start date and age}} | |||
* {{tl|Birth date and age}} | |||
<includeonly> | <includeonly> | ||
<!-- | <!-- Categories go here and interwikis go in Wikidata --> | ||
[[Category:Mathematical time and date function templates]] | [[Category:Mathematical time and date function templates]] | ||
</includeonly> | </includeonly> | ||
Revision as of 02:26, 8 October 2013
 | This is a documentation subpage for Template:Time ago. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 152,000+ pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
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.
magnitudeparameter can be set to explicitly use certain unit. Allowed values are:seconds,minutes,hours,days,weeks,monthsandyears.min_magnitudeparameter can be set to use the specified unit or bigger units. Allowed values are:seconds,minutes,hours,days,monthsandyears.agoparameter can be set to override the default usage of the text "ago".
Purge
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|{{REVISIONTIMESTAMP}}}}→ 12 years ago{{Time ago|Jan 21, 2001 3:45 PM}}→ 24 years ago{{Time ago|Nov 6 2008}}→ 17 years ago{{Time ago|Nov 6 2008|magnitude=weeks}}→ 891 weeks ago{{Time ago|Nov 6 2008|min_magnitude=days}}→ 17 years ago{{Time ago|Nov 6 2008|min_magnitude=years}}→ 17 years ago{{Time ago|Nov 6 2008|ago=in the past}}→ 17 years in the past{{Time ago|Nov 6 2008|purge=yes}}→ 17 years ago (purge){{Time ago|2008-11-06}}→ 17 years ago
TemplateData
TemplateData for Time ago
This template calculates the amount of time which has passed since a provided timestamp.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Timestamp | 1 | Base timestamp for calculation of passed time. Example format: Nov 6 2008, see template documentation for other supported formats. | String | required |
| magnitude | magnitude | Explicitly sets a specific unit to display return value. Allowed values are: seconds, minutes, hours, days, weeks, months and years. | String | optional |
| min_magnitude | min_magnitude | Sets a minimum unit to display return value. Allowed values are: seconds, minutes, hours, days, months and years. | String | optional |
| ago | ago | Parameter can be set to override the default usage of the text 'ago'. | String | optional |
| Purge link | purge | Add the parameter purge=yes to add a WP:PURGE link. | String | optional |
See also
- {{Last edited by}}
- {{Years or months ago}}
- {{Age}}
- {{Start date and age}}
- {{Birth date and age}}
