வார்ப்புரு:Is decade/doc என்பதற்கான மூலத்தைப் பார்

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

=== Usage ===
This template can be used in other templates to check or analyse an input entered in the the form <code>YYYYs</code> (ie. the format used in [[:Category:Works by decade‎|Works by decade‎]], [[:Category:Births by decade‎|Births by decade‎]] and [[:Category:Deaths by decade‎|Deaths by decade‎]]).

<pre>
{{is decade|input=|function=}}
</pre>

The template can be used without named parameters as well.  The most basic usage is:

<pre>
{{is decade|}}
</pre>

==== Input ====

The input must be in the form of <code>YYYYs</code> or <code>YYYYs BCE</code>.  The maximum value is <code>2100s</code> and the minimum value is <code>2000s BCE</code>.  The inputs <code>0s</code> and <code>0s BCE</code> are treated as separate periods (ie. the year 1-10 CE and 1-10 BCE respectively).

==== Function ====

The function must be one of the numbers in this table.  This parameter is optional.  If not set, function 0 is the default.

{| class="wikitable" {{ts|mc}}
! Number || Function || Output
|-
| 0 || Basic || Removes the plural "s" from the input.
|-
| 1 || Index || Returns a number counting number of decades from <code>0s</code>.<br />ie.10s = 1, 10s BCE = -1.
|-
| 2 || Absolute || Returns the numeric part of the input only.
|-
| 3 || Logic || Returns a 1 (one) if the input is a recognised decade.
|}


If the input is not a recognised decade, this template will return <code>FALSE</code>; unless function 3 is selected, in which case it will return 0 (zero).

=== Examples ===
==== Basic ====
<pre>{{is decade|1980s}}</pre>
{{is decade|1980s}}

<pre>{{is decade|input=1980s}}</pre>
{{is decade|input=1980s}}

<pre>{{is decade|input=1980s|function=0}}</pre>
{{is decade|input=1980s|function=0}}

==== Index ====
<pre>{{is decade|input=1980s|function=1}}</pre>
{{is decade|input=1980s|function=1}}

<pre>{{is decade|input=0s|function=1}}</pre>
{{is decade|input=0s|function=1}}

<pre>{{is decade|input=0s BCE|function=1}}</pre>
{{is decade|input=0s BCE|function=1}}

<pre>{{is decade|input=1980s BCE|function=1}}</pre>
{{is decade|input=1980s BCE|function=1}}

==== Absolute ====
<pre>{{is decade|input=1980s|function=2}}</pre>
{{is decade|input=1980s|function=2}}

<pre>{{is decade|input=0s|function=2}}</pre>
{{is decade|input=0s|function=2}}

<pre>{{is decade|input=0s BCE|function=2}}</pre>
{{is decade|input=0s BCE|function=2}}

<pre>{{is decade|input=1980s BCE|function=2}}</pre>
{{is decade|input=1980s BCE|function=2}}

==== Logic ====
<pre>{{is decade|input=1980s|function=3}}</pre>
{{is decade|input=1980s|function=3}}

<pre>{{is decade|input=1980|function=3}}</pre>
{{is decade|input=1980|function=3}}

Note that the "s" has been removed from the input.  This is a year and not a decade.

<pre>{{is decade|input=Foo|function=3}}</pre>
{{is decade|input=Foo|function=3}}

==== Unrecognised input ====
<pre>{{is decade|input=Foo}}</pre>
{{is decade|input=Foo}}

<pre>{{is decade|input=Foo|function=3}}</pre>
{{is decade|input=Foo|function=3}}

=== Notes ===

An alternative form of using function 3 (logic) is to combine this template with {{tl|is number}}.

<pre>{{is number|{{is decade|input=1980s|function=2}}}}</pre>
{{is number|{{is decade|input=1980s|function=2}}}}

<pre>{{is number|{{is decade|input=Foo|function=2}}}}</pre>
{{is number|{{is decade|input=Foo|function=2}}}}

=== See also ===
* {{tl|is year}}
* {{tl|is century}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Programming templates]]
</includeonly>