Tynian: 1 revision: Import helps

2011-01-10T23:24:28Z

1 revision: Import helps

New page

'''This page shows the values of the site-dependent variables on this wiki. The rest of the page has been deprecated by "[[mw:Help:Magic words|Help:Magic words]]" on MediaWiki.org, and is kept here for the convenience of users following links from other wikis. Any modifications, if still appropriate, should be made on that page.'''
[[Category:Moved to MediaWiki]]
----

{{H:h|editor toc}}
A '''variable''' can be considered a [[Help:Template#Predefined_templates|predefined template]] without parameters. See also [[Help:Parser function]].

This is a list of variables that can be used in the wikitext. The way they are rendered vary with time (directly depending on time, or e.g. for number of articles, depending on the creation of other articles), on the project (it changes when the wikitext is copied), or on the page in which it occurs (it changes when the wikitext is copied, when the page is renamed, and when the page is included in another page).

On the left is the variable, on the right how it is rendered at this time, in this project, on this page.

The names of the variables form part of the set of so-called "[[Help:Magic words|magic words]]" the system uses.

With [[Special:ExpandTemplates]] one can view the value of a variable, or more generally, the expanded wikitext a variable or a wikitext with variables and/or template calls produces, as intermediate step toward rendering.

==Constants==

{|
| <code><nowiki>{{SITENAME}}</nowiki></code>
| {{SITENAME}}
|-
| <code><nowiki>{{SERVER}}</nowiki></code>
| {{SERVER}}
|-
| <code><nowiki>{{SERVERNAME}}</nowiki></code>
| {{SERVERNAME}}
|-
| <code><nowiki>{{CONTENTLANGUAGE}}</nowiki></code>
| {{CONTENTLANGUAGE}}
| code of the site's default interface language ({{h:mwg|LanguageCode}})
|}

==Depending on page==

{{H:Page name variables}}

For the rendering on page A, these variables depend on page A, even if page A contains the variable due to [[help:template|inclusion]] of page B. Variables in the [[Help:Category#Sort_key|sort key]] of a category tag refer to the page with the tag, not the category page where it takes effect.

<nowiki>{{NAMESPACE}}</nowiki> and <nowiki>{{NAMESPACEE}}</nowiki> return an empty string in the article namespace <nowiki>{{ns:0}}</nowiki>,
see above and [[Help:Parser function#NS:0|NS:0]].

PAGENAMEE displays the page title in the form that is used in URLs, i.e. with underscores for spaces, and percent-encoding for special characters, and is therefore used for constructing URLs incl. ''query strings''.

For example, on [[m:Template talk:!|Template talk:!]], SUBJECTPAGENAMEE would produce <tt>Template:%21</tt>.
Don't encode PAGENAMEE etc. again, i.e. don't use it in the first parameter of '''fullurl:''' and similar parser functions,
<nowiki>{{urlencode:%21}}</nowiki> = {{urlencode:%21}} probably won't work as expected. ''Query strings''  in [[purlnet:|PURL]] redirections are an exception.

The "EE" encoding examples shown above for this page are not very interesting, only TALKPAGENAMEE and TALKSPACEE differ from TALKPAGENAME and TALKSPACE.
See [[Help:Link]] and [[Help:Magic words]] for other examples.

In a subpage, <tt><nowiki>[[../]]</nowiki></tt> renders as a link to the parent page. For example, on [[m:Link/a/b]] it gives an internal link to [[m:Link/a]], see [[Help:Link#Subpage feature]].

{{xpdoc|REVISIONID}} showing the '''current''' unique revision number of a saved page as used for [[Help:diff|diff]]s in the [[Help:page history|page history]] is in essence [[mediazilla:6181|useless]], it can't be substituted and also doesn't work in preview.

==Varying with time==
{{seealso|:en:Category:Date-computing templates}}
===Time===
The time in [[w:UTC|UTC]]. Note that if the page was displayed by the same user and has not changed (page has not been edited) since the last time it was displayed, it is possible that the page may be cached (by the user's browser) and the displayed time or date may not change. Also, if a heavily used page, rather than freshly rendered by the software each time it is generated, is instead being retrieved from a caching system (such as the main page on Wikipedia) the date or time may not change from the last time the page was originally retrieved by the caching hardware or software.
{{H:Current time variables}}

===Local time===
Local time depends on the local timezone of the wiki, not the time zone in the user preferences. These should generally use {{[[Help:ParserFunctions#.23time:|#time:]]}} if [[ParserFunctions]] are installed, but the following legacy variables are also available from MediaWiki 1.8+.

{{H:Local time variables}}

Because of the way MediaWiki and most browsers cache HTML pages, time variables which change more often than once a day will typically show the time the page was last cached, rather than the current time.

=== Statistics ===

See '''[[Help:Magic_words#Statistics|Statistics]]'''.

===Substitution===

:''Main article: '''[[Help:Substitution]]'''''

When <code><nowiki>{{<includeonly>subst:</includeonly>CURRENTTIMESTAMP}}</nowiki></code> is included and thereby substituted, the timestamp of doing that is put in the wikitext, and similarly for other variables. Examples:

;<code><nowiki>{{CURRENTTIMESTAMP}}</nowiki></code>
:{{CURRENTTIMESTAMP}} - stays a variable on pages including the template
;<code><nowiki>{{subst:CURRENTTIMESTAMP}}</nowiki></code>
:20060526024210 - became a substituted constant in the template
;<code><nowiki>{{<includeonly>subst:</includeonly>CURRENTTIMESTAMP}}</nowiki></code>
:{{<includeonly>subst:</includeonly>CURRENTTIMESTAMP}} - becomes a constant at the time of its inclusion

Templates with the "''includeonly subst magic''" must also be subst-ed.

==Other==

{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
! Word
! Example
! Example results
! Explanation
|-
| <nowiki>{{PAGESINCATEGORY:category}}</nowiki> <nowiki>{{PAGESINCATEGORY:category|R}}</nowiki>
| <code><nowiki>{{PAGESINCATEGORY:User en}}</nowiki></code> <code><nowiki>{{PAGESINCATEGORY:User en|R}}</nowiki></code>
| <code>{{PAGESINCATEGORY:User en}}</code> <code>{{PAGESINCATEGORY:User en|R}}</code>
| '''[MW1.13+]''' Returns the number of pages in a given category.
|-
| <nowiki>{{PAGESINCAT:category}}</nowiki> <nowiki>{{PAGESINCAT:category|R}}</nowiki>
| <code><nowiki>{{PAGESINCAT:User en}}</nowiki></code> <code><nowiki>{{PAGESINCAT:User en|R}}</nowiki></code>
| <code>{{PAGESINCAT:User en}}</code> <code>{{PAGESINCAT:User en|R}}</code>
| '''[MW1.13+]''' Alias of PAGESINCATEGORY.
|}{{-}}

==Examples of combinations with parser functions==

;<code><nowiki>{{fullurl:{{FULLPAGENAME}}|</nowiki>action=edit<nowiki>}}</nowiki></code>
:{{fullurl:{{FULLPAGENAME}}|action=edit}}
:  
;<code><nowiki>{{fullurl:w:en:Special:Whatlinkshere|target={{NAMESPACE}}:Contents}}</nowiki></code>
:{{fullurl:w:en:Special:Whatlinkshere|target={{NAMESPACE}}:Contents}}
:  
;<code><nowiki>{{fullurl:m:Special:Whatlinkshere|target={{FULLPAGENAME}}}}</nowiki></code>
:{{fullurl:m:Special:Whatlinkshere|target={{FULLPAGENAME}}}}
:  
;<code><nowiki>[[{{NAMESPACE}} talk:{{PAGENAME}}]]</nowiki></code>
:[[{{NAMESPACE}} talk:{{PAGENAME}}]]
:  
;<code><nowiki>{{fullurl:{{NAMESPACE}} talk:{{PAGENAME}}}}</nowiki></code>
:{{fullurl:{{NAMESPACE}} talk:{{PAGENAME}}}}
:  

The old form <code><nowiki>{{SERVER}}{{localurl:</nowiki></code>''page'' <code>}}</code> does not always work:

<code><nowiki>{{SERVER}}{{localurl:Wikipedia:Category</nowiki></code> <code>}}</code>
gives {{SERVER}}{{localurl:Wikipedia:Category}}

Apart from those problems it is in essence the same as
<code><nowiki>{{fullurl:</nowiki></code>''page'' <code>}}</code> in recent ('''1.5+''') versions of the software.

In a template, for a link to a page which depends on a template parameter, the external link style is used even for internal links, to avoid that the system links to the edit page even if the page exists. To construct the external link, variables can also be useful.

==Variable in the form of a template call==
If the syntax of a template call with parameters is applied with the name of a variable, depending on the variable the parameters are either ignored or cause the variable to be interpreted as a (non-existing) template:

#Variables like {{NUMBEROFPAGES:R}} = {{NUMBEROFPAGES:R}} with a "raw" format are always handled as variable, {{NUMBEROFPAGES:R|Para|meter}} = {{NUMBEROFPAGES:R|Para|meter}}.
#Other variables like {{CURRENTDAYNAME}} = {{CURRENTDAYNAME}} are handled as template for given parameter(s), {{CURRENTDAYNAME|x}} = {{CURRENTDAYNAME|x}}.
#Parser functions like {{lc: Lower Case}} = {{lc: Lower Case}} ignore extraneous parameters, {{lc: Lower|Case}} = {{lc: Lower|Case}}.
#Parser function ns (e.g. {{ns: 1}} = {{ns: 1}}) gives an empty string for a non-applicable numerical parameter value, and evaluates in the case of a non-numerical parameter value as template (the template name being the whole text until "|" or "}}"):
#:{{ns: 1234}} = {{ns: 1234}}
#:{{ns: t|abc}} = {{ns: t|abc}}
#Parser functions like fullurl don't support the <tt>../</tt> notation, and in namespaces supporting subpages this has odd effects: like above, they evaluate such an invalid parameter value as template, see [[Link/a]] and [[Link/a/b]]. Here it just renders the wikitext:
#:{{fullurl:../a}} = {{fullurl:../a}}.
#: The cases #2, #4, and #5 resulting in template calls are probably related.

==See also==
*[[Help:Parser function]]: a way of integrating with the parser more tightly since version 1.7.0
*[[Extending wiki markup#Parser functions|Adding parser functions]]
*The [[Help:ParserFunctions|ParserFunctions]] extension ('''#expr:''', '''#if:''', '''#ifeq:''', etc.; '''#titleparts:''')
*[[Help:Substitution]]: on applying "subst" to a variable or to a template using a variable
*[[mw:Manual:Magic words]]
*[[mw:Extension:Variables]]: ''adding new magic words like <nowiki>{{CURRENTUSER}}</nowiki>''
*[http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3/includes/MagicWord.php MagicWord.php]
*{{ml|Help:User style|Variables|JavaScript variables supplied by the server}}

{{h:f|enname=Variable}}

Help:Variable - Revision history

Tynian: 1 revision: Import helps