Difference between revisions of "Template:Age nts/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(add documentation and TemplateData from Template:Age, misc formatting)
blackwiki>Zyxw
(add {{Lua|Module:Age}}, misc formatting)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
 +
{{Lua|Module:Age}}
  
== Usage ==
 
 
This acts just like {{tl|Age}} but will sort correctly in sortable tables.
 
This acts just like {{tl|Age}} but will sort correctly in sortable tables.
  
 
The template returns the number of full years between two specified dates.  If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.
 
The template returns the number of full years between two specified dates.  If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.
  
; Syntax<nowiki>:</nowiki>
+
== Usage ==
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code>  or  
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code>  or  
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''}}</code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''}}</code>
  
; Examples<nowiki>:</nowiki>
+
== Examples ==
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23|2003|7|14}}"
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23|2003|7|14}}"
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23}}"
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23}}"
Line 19: Line 19:
 
: (BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)
 
: (BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)
  
; Note<nowiki>:</nowiki>
+
== Note ==
 
: This template does not check for incorrect input:
 
: This template does not check for incorrect input:
 
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|6|233}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|6|233}}" (surplus days do not count as extra months)
 
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|6|233}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|6|233}}" (surplus days do not count as extra months)
 
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|88|14}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|88|14}}" (surplus months do not count as extra years)
 
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|88|14}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|88|14}}" (surplus months do not count as extra years)
  
==TemplateData==
+
== TemplateData ==
{{TemplateDataHeader}}
+
{{TemplateData header}}
 
<templatedata>{
 
<templatedata>{
 
"description": "This template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.",
 
"description": "This template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.",
Line 71: Line 71:
 
</templatedata>
 
</templatedata>
  
==See also==
+
== See also ==
 
* {{tl|nts}} - number table sorting
 
* {{tl|nts}} - number table sorting
 
* [[Wikipedia:Age calculation templates]]
 
* [[Wikipedia:Age calculation templates]]
Line 81: Line 81:
 
[[Category:Date mathematics templates]]
 
[[Category:Date mathematics templates]]
 
[[Category:Sorting templates]]
 
[[Category:Sorting templates]]
 +
 
}}</includeonly>
 
}}</includeonly>

Revision as of 18:43, 23 October 2018

This acts just like {{Age}} but will sort correctly in sortable tables.

The template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.

Usage

{{Age nts|year|month|day|year2|month2|day2}} or
{{Age nts|year|month|day}}

Examples

{{Age nts|1989|7|23|2003|7|14}} returns "13"
{{Age nts|1989|7|23}} returns "36"
When entering dates before the Common Era, use astronomical year numbering: 1 BCE is represented by 0, 2 BCE by -1, 3 BCE by -2 etc. For example, the following expression returns the number of full years elapsed since the battle of Cannae, which took place on August 2, 216 BCE:
{{Age nts|-215|8|2}} returns "2,240"
(BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)

Note

This template does not check for incorrect input:
{{Age nts|1980|7|14|1993|6|233}} returns "Error: Second date should be year, month, day" (surplus days do not count as extra months)
{{Age nts|1980|7|14|1993|88|14}} returns "Error: Second date should be year, month, day" (surplus months do not count as extra years)

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Age nts

This template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.

Template parameters

ParameterDescriptionTypeStatus
Year ("from" date)1

The year of the "from" date

Numberrequired
Month ("from" date)2

The month of the "from" date, 1 through 12

Numberrequired
Day ("from" date)3

The day (of month) of the "from" date, 1 through 31

Numberrequired
Year2 ("to" date)4

The year of the "to" date, if required

Default
{{CURRENTYEAR}}
Numberoptional
Month2 ("to" date)5

The month of the "to" date, if required

Default
{{CURRENTMONTH}}
Numberoptional
Day2 ("to" date)6

The day (of month) of the "to" date, if required

Default
{{CURRENTDAY}}
Numberoptional

See also