View source for User:AlanM1/Variables

__NOINDEX__

==Variables==
From [[Help:Magic words#Variables]]. These all take an optional parameter to operate on a page other than the current one. Append an "E" for equivalents encoded for use in MediaWiki URLs (e.g {{tl|PAGENAMEE}}, {{tl|NAMESPACEE}}).
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tl|FULLPAGENAME}}
| {{FULLPAGENAME}}
| [[help:Page name|Page title]] including [[help:Namespace|namespace]]
|-
| {{tl|PAGENAME}}
| {{PAGENAME}}
| Page title excluding namespace
|-
| {{tl|BASEPAGENAME}}
| {{BASEPAGENAME}}
| Page title excluding ''current'' [[help:Subpages|subpage]] and namespace<BR/>effectively the parent page without the namespace.
|-
| {{tl|SUBPAGENAME}}
| {{SUBPAGENAME}}
| Subpage part of title
|-
| {{tl|SUBJECTPAGENAME}}
| {{SUBJECTPAGENAME}}
| rowspan=2 | Associated non-talk page
|-
| {{tl|ARTICLEPAGENAME}}
| {{ARTICLEPAGENAME}}
<!-- from above -->
|-
| {{tl|TALKPAGENAME}}
| {{TALKPAGENAME}}
| Associated talk page
|-
| {{tl|NAMESPACE}}
| {{NAMESPACE}}
| Namespace of current page
|-
| {{tl|SUBJECTSPACE}}
| {{SUBJECTSPACE}}
| rowspan=2 | Associated non-talk namespace
|-
| {{tl|ARTICLESPACE}}
| {{ARTICLESPACE}}
<!-- From above -->
|-
| {{tl|TALKSPACE}}
| {{TALKSPACE}}
| Associated talk namespace
|}

These do not take a parameter:
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tl|SITENAME}}
| {{SITENAME}}
| Site name
|-
| {{tl|SERVER}}
| {{SERVER}}
| Server
|-
| {{tl|SERVERNAME}}
| {{SERVERNAME}}
| Server name
|-
| {{tl|SCRIPTPATH}}
| {{SCRIPTPATH}}
| Script path
|-
| {{tl|CURRENTVERSION}}
| {{CURRENTVERSION}}
| Current MediaWiki version
|-
| {{tl|REVISIONID}}
| {{REVISIONID}}
| Latest revision to current page
|-
| {{tl|REVISIONDAY}}
| align=right | {{REVISIONDAY}}
| rowspan=6 | Date, time, editor at last edit
|-
| {{tl|REVISIONDAY2}}
| align=right | {{REVISIONDAY2}}
<!-- From above -->
|-
| {{tl|REVISIONMONTH}}
| align=right | {{REVISIONMONTH}}
<!-- From above -->
|-
| {{tl|REVISIONYEAR}}
| align=right | {{REVISIONYEAR}}
<!-- From above -->
|-
| {{tl|REVISIONTIMESTAMP}}
| align=right | {{REVISIONTIMESTAMP}}
<!-- From above -->
|-
| {{tl|REVISIONUSER}}
| align=right | {{REVISIONUSER}}
<!-- From above -->
|-
| {{tl|CURRENTYEAR}}
| align=right | {{CURRENTYEAR}}
| rowspan=12 | Current date/time variables
|-
| {{tl|CURRENTMONTH}}
| align=right | {{CURRENTMONTH}}
<!-- From above -->
|-
| {{tl|CURRENTMONTHNAME}}
| align=right | {{CURRENTMONTHNAME}}
<!-- From above -->
|-
| {{mwl|CURRENTMONTHABBREV}}
| align=right | {{CURRENTMONTHABBREV}}
<!-- From above -->
|-
| {{tl|CURRENTDAY}}
| align=right | {{CURRENTDAY}}
<!-- From above -->
|-
| {{tl|CURRENTDAY2}}
| align=right | {{CURRENTDAY2}}
<!-- From above -->
|-
| {{tl|CURRENTDOW}}
| align=right | {{CURRENTDOW}}
<!-- From above -->
|-
| {{tl|CURRENTDAYNAME}}
| align=right | {{CURRENTDAYNAME}}
<!-- From above -->
|-
| {{tl|CURRENTTIME}}
| align=right | {{CURRENTTIME}}
<!-- From above -->
|-
| {{tl|CURRENTHOUR}}
| align=right | {{CURRENTHOUR}}
<!-- From above -->
|-
| {{tl|CURRENTWEEK}}
| align=right | {{CURRENTWEEK}}
<!-- From above -->
|-
| {{tl|CURRENTTIMESTAMP}}
| align=right | {{CURRENTTIMESTAMP}}
<!-- From above -->
|-
| {{tl|LOCALYEAR}}
| align=right | {{LOCALYEAR}}
| rowspan=12 | Site local date/time variables
|-
| {{tl|LOCALMONTH}}
| align=right | {{LOCALMONTH}}
<!-- From above -->
|-
| {{tl|LOCALMONTHNAME}}
| align=right | {{LOCALMONTHNAME}}
<!-- From above -->
|-
| {{tl|LOCALMONTHABBREV}}
| align=right | {{LOCALMONTHABBREV}}
<!-- From above -->
|-
| {{tl|LOCALDAY}}
| align=right | {{LOCALDAY}}
<!-- From above -->
|-
| {{tl|LOCALDAY2}}
| align=right | {{LOCALDAY2}}
<!-- From above -->
|-
| {{tl|LOCALDOW}}
| align=right | {{LOCALDOW}}
<!-- From above -->
|-
| {{tl|LOCALDAYNAME}}
| align=right | {{LOCALDAYNAME}}
<!-- From above -->
|-
| {{tl|LOCALTIME}}
| align=right | {{LOCALTIME}}
<!-- From above -->
|-
| {{tl|LOCALHOUR}}
| align=right | {{LOCALHOUR}}
<!-- From above -->
|-
| {{tl|LOCALWEEK}}
| align=right | {{LOCALWEEK}}
<!-- From above -->
|-
| {{tl|LOCALTIMESTAMP}}
| align=right | {{LOCALTIMESTAMP}}
<!-- From above -->
|-
| {{tl|NUMBEROFPAGES}}
| align=right | {{NUMBEROFPAGES}}
| rowspan=8 | Statistics on English Wikipedia<BR/>Add {{Font color|green|<tt>&#124;R</tt>}} to return numbers without commas
|-
| {{tl|NUMBEROFARTICLES}}
| align=right | {{NUMBEROFARTICLES}}
<!-- From above -->
|-
| {{tl|NUMBEROFFILES}}
| align=right | {{NUMBEROFFILES}}
<!-- From above -->
|-
| {{tl|NUMBEROFEDITS}}
| align=right | {{NUMBEROFEDITS}}
<!-- From above -->
<!-- No longer

|-

| {{tl|NUMBEROFVIEWS}}
| align=right | {{NUMBEROFVIEWS}}

-->

<!-- From above -->
|-
| {{tl|NUMBEROFUSERS}}
| align=right | {{NUMBEROFUSERS}}
<!-- From above -->
|-
| {{tl|NUMBEROFADMINS}}
| align=right | {{NUMBEROFADMINS}}
<!-- From above -->
|-
| {{tl|NUMBEROFACTIVEUSERS}}
| align=right | {{NUMBEROFACTIVEUSERS}}
<!-- From above -->
|}

==Parser functions==
From [[Help:Magic words#Parser functions]]. These are fully documented at the [[mw:Help:Magic_words|Meta magic words page]] or [[mw:Help:Extension:ParserFunctions|ParserFunctions Extension documentation]] unless otherwise stated. {{Font color|green|<code>{{{0}}}</code> (''arg0'')}} is the arg after the colon, before the pipe before {{Font color|green|<code>{{{1}}}</code> (''arg1'')}}.

===Metadata===
Add {{Font color|green|<tt>{{!}}R</tt>}} (i.e. {{Font color|green|<code>{{{1}}}</code>{{=}}''R''}}) to return numbers without commas.
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tld|PAGEID}}
| align=right | {{PAGEID}}
| Unique page identifier number
|-
| {{tld|PAGESIZE:{{Font color|green|''{{FULLPAGENAME}}''}}}}
| align=right | {{PAGESIZE:{{FULLPAGENAME}}}}
| Size of page {{Font color|green|<code>{{{0}}}</code>}} in bytes
|-
| {{tld|PROTECTIONLEVEL:{{Font color|green|''edit''}}}}
| align=right | {{PROTECTIONLEVEL:edit}}
| Protection level for action {{Font color|green|<code>{{{0}}}</code>}} on the current page
|-
| {{tld|PAGESINCATEGORY:{{Font color|green|''Wikipedia features''}}}}
| align=right | {{PAGESINCATEGORY:Wikipedia features}}
| Number of pages in category {{Font color|green|<code>{{{0}}}</code>}}
|-
| {{tld|NUMBERINGROUP:{{Font color|green|''checkuser''}}}}
| align=right | {{NUMBERINGROUP:checkuser}}
| Number of users in group {{Font color|green|<code>{{{0}}}</code>}}
|}

===Formatting===
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tld|lc:STRING}}
| {{lc:String}}
| Convert {{Font color|green|<code>{{{0}}}</code>}} to lower-case
|-
| {{tld|lcfirst:STRING}}
| {{lcfirst:STRING}}
| Convert first character of {{Font color|green|<code>{{{0}}}</code>}} to lower case
|-
| {{tld|uc:string}}
| {{uc:string}}
| Convert {{Font color|green|<code>{{{0}}}</code>}} to upper case
|-
| {{tld|ucfirst:string}}
| {{ucfirst:string}}
| Convert first character of {{Font color|green|<code>{{{0}}}</code>}} to upper case
|-
| {{tld|formatnum:1234567}}
| {{formatnum:1234567}}
| Format {{Font color|green|<code>{{{0}}}</code>}} with comma separators
|-
| {{tld|formatnum:1,234,567|R}}
| {{formatnum:1,234,567|R}}
| Unformat {{Font color|green|<code>{{{0}}}</code>}} with comma separators
|-
| {{tld|{{Pound}}formatdate:7 October 2012|default_format}}
| {{#formatdate:7 October 2012|mdy}}
| Formats date in {{Font color|green|<code>{{{0}}}</code>}} according to user's preference. If no preference set, {{Font color|green|<code>{{{1}}}</code> (''default_format'')}} (one of {{Font color|green|<tt>''mdy, dmy, ymd, ISO 8601''</tt>}}) is used.
|-
| {{tld|padleft:string|8}}
| {{padleft:string|8}}
| rowspan=4 | Pad {{Font color|green|<code>{{{0}}}</code>}} with zeros to the right or left; an alternative padding string can be given as {{Font color|green|<code>{{{2}}}</code>}}; the alternative padding string may be truncated if its length does not evenly divide by the required number of characters (i.e. the result is always {{Font color|green|<code>{{{1}}}</code>}} chars long)
|-
| {{tld|padleft:string|8|/}}
| {{padleft:string|8|/}}
<!-- From above -->
|-
| {{tld|padright:string|8}}
| {{padright:string|8}}
<!-- From above -->
|-
| {{tld|padright:string|8|/}}
| {{padright:string|8|/}}
<!-- From above -->
|-
| {{tld|plural:1|is|are}}
| {{plural:1|is|are}}
| rowspan=2 | Returns {{Font color|green|<code>{{{1}}}</code>}} if {{Font color|green|<code>{{{0}}}</code>}} is 1, {{Font color|green|<code>{{{2}}}</code>}} if {{Font color|green|<code>{{{0}}}</code>}} is greater than 1
|-
| {{tld|plural:3|is|are}}
| {{plural:3|is|are}}
<!-- From above -->
|-
| {{tld|{{Pound}}time:format_string|date_time_object}}
| <!--{{#time:''format string''|''date/time object''}}-->
| Format {{Font color|green|<code>{{{1}}}</code>}} date/time according to {{Font color|green|<code>{{{0}}}</code>}} format string (see [[mw:Help:Extension:ParserFunctions#.23time extension documentation page]])
|-
| {{tld|{{Pound}}timel:format_string|date_time_object}}
| <!--{{#timel:''format string''|''date/time object''}}-->
| Like <tt>#time</tt>, but for local time.
|-
| {{tld|gender:''username''|masculine|female|neutral}}
| {{gender:''username''|''masculine''|''female''|''neutral''}}
| Produces alternative text according to the gender specified by the given user in his/her preferences
|-
| {{tld|{{Pound}}tag:''tagname'' | content | parameter1=value1 | parameter2=value2}}
| {{#tag:''tagname'' | ''content'' | ''parameter1''=''value1'' | ''parameter2''=''value2''}}
| Equivalent to an HTML tag or pair of tags; can be used for [[wikipedia:REFNEST|nesting references]]
|}

===Paths===
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tld|localurl:{{PAGENAME}}}}<BR/>{{tld|localurl:{{PAGENAME}}|query string}}
| {{localurl:{{PAGENAME}}}}<BR/>{{localurl:{{PAGENAME}}|query string}}
| Relative path to the title
|-
| {{tld|fullurl:{{PAGENAME}}}}<BR/>{{tld|fullurl:{{PAGENAME}}|query_string}}
| {{fullurl:{{PAGENAME}}}}<BR/>{{fullurl:{{PAGENAME}}|query_string}}
| Absolute path to the title, without a protocol prefix
|-
| {{tld|canonicalurl:{{PAGENAME}}}}<BR/>{{tld|canonicalurl:{{PAGENAME}}|query_string}}
| {{canonicalurl:{{PAGENAME}}}}<BR/>{{canonicalurl:{{PAGENAME}}|query_string}}
| Absolute path to the title, with a protocol prefix
|-
| {{tld|filepath:file name}}
| {{filepath:file name}}
| Absolute URL to a media file
|-
| {{tld|urlencode:string}}
| {{urlencode:string}}
| Input encoded for use in URLs
|-
| {{tld|anchorencode:string}}
| {{anchorencode:string}}
| Input encoded for use in URL section anchors
|-
| {{tld|ns:n}}<BR/>{{tld|nse:n}}
| <nowiki>{{ns:n}}</nowiki><BR/><nowiki>{{nse:n}}</nowiki>
| Name for the namespace with index n; use {{nse:}} for the equivalent encoded for MediaWiki URLs
|-
| {{tld|{{Pound}}rel2abs:path}}
| {{#rel2abs:path}}
| Converts a relative file path to absolute; see the [[mw:Help:Extension:ParserFunctions|extension documentation]]
|-
| {{tld|{{Pound}}titleparts:pagename|number of segments to return|first segment to return}}
| {{#titleparts:pagename|number of segments to return|first segment to return}}
| Splits title into parts; see the [[mw:Help:Extension:ParserFunctions|extension documentation]]
|}

===Conditional expressions===
These are covered at the [[mw:Help:Extension:ParserFunctions|extension documentation page]]. Some parameters are optional.
{| class="wikitable"
|-
! Template
! Result
! Descrip
|-
| {{tld|{{Pound}}expr: ''expression'' }}</tt>
| {{#expr: ''expression'' }}
| Evaluates the given expression; see [[Help:Calculation]]
|-
| {{tld|{{Pound}}if: ''test string'' | ''value if non-empty'' | ''value if empty'' }}</tt>
| {{#if: ''test string'' | ''value if non-empty'' | ''value if empty'' }}
| Selects one of two values based on whether the test string is empty
|-
| {{tld|{{Pound}}ifeq: ''string 1'' | ''string 2'' | ''value if equal'' | ''value if unequal'' }}</tt>
| {{#ifeq: ''string 1'' | ''string 2'' | ''value if equal'' | ''value if unequal'' }}
| Selects one of two values based on whether the test strings are equal – numerically if applicable
|-
| {{tld|{{Pound}}iferror: ''test string'' | ''value if error'' | ''value if correct'' }}</tt>
| {{#iferror: ''test string'' | ''value if error'' | ''value if correct'' }}
| Selects value based on whether the test string generates a parser error
|-
| {{tld|{{Pound}}ifexpr: ''expression'' | ''value if true'' | ''value if false'' }}</tt>
| {{#ifexpr: ''expression'' | ''value if true'' | ''value if false'' }}
| Selects value based on evaluation of expression
|-
| {{tld|{{Pound}}ifexist: ''page title'' | ''value if exists'' | ''value if doesn't exist'' }}</tt>
| {{#ifexist: ''page title'' | ''value if exists'' | ''value if doesn't exist'' }}
| Selects value depending on whether a page title exists
|-
| {{tld|{{Pound}}switch: ''test'' | ''case1'' = ''value for case 1'' | ... | ''default'' }}</tt>
| {{#switch: ''test'' | ''case1'' = ''value for case 1'' | ... | ''default'' }}
| Provides alternatives based on the value of the test string
|}

Note that with <code>#if:</code> expressions, a variable like <code>{{{1}}}</code> always requires a final pipe: <code>{{{1|}}}</code>. If it is absent, then whenever the parameter 1 is absent, instead of leaving the field blank the software will use the actual text ''<code>{{{1}}}</code>'' and the field will never be empty.

For the use of these functions in tables, see [[Wikipedia:Conditional tables|Conditional tables]].