Difference between revisions of "Help:Magic words"

Latest revision as of 23:42, 31 October 2013

Magic words are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words; for a technical reference, see {{ #ifeq:

 GridPACK

| MediaWiki | Manual:Magic words | [[{{#if:|{{#ifexist:Manual:Magic words||mw:}}}}Manual:Magic words|Manual:Magic words]] }}.

There are three general types of magic words:

• Behavior switches: these are uppercase words surrounded by double underscores, e.g. __FOO__.
• Variables: these are uppercase words surrounded by double braces, e.g. {{FOO}}. As such, they look a lot like templates.
• Parser functions: these take parameters and are either of the form {{foo:...}} or {{#foo:...}}. See also {{ #ifeq:

 GridPACK

| MediaWiki | Help:Extension:ParserFunctions | [[{{#if:|{{#ifexist:Help:Extension:ParserFunctions||mw:}}}}Help:Extension:ParserFunctions|Help:Extension:ParserFunctions]] }}.

Variables and parser functions can use subst:, just like templates. Page-dependent magic words will affect or return data about the current page (by default), even if the word is added through a transcluded template or included system message.

Behavior switches

A behavior switch controls the layout or behavior of the page and can often be used to specify desired omissions and inclusions in the content.

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

Variables

Variables return information about the current page, wiki, or date. Their syntax is similar to templates. Variables marked as "[expensive]" are tracked by the software, and the number that can be included on a page is limited.

If a template name conflicts with a variable, the variable will be used (so to transclude the template Template:PAGENAME you would need to write {{Template:PAGENAME}}). In some cases, adding parameters will force the parser to invoke a template; for example, {{CURRENTDAYNAME|x}} transcludes Template:CURRENTDAYNAME, not the variable.

Date and time

The following variables return the current date and time in UTC.

Due to MediaWiki and browser caching, these variables frequently show when the page was cached rather than the current time.

The date and time magic words are formatted in the wiki content language. Since {{#ifeq: 94680 | ?

| r? {{#if:  ||}}
| {{#if:1.19|1.19}}

}}, they depend on the page content language.

The following variables do the same as the preceding ones, but using the site's server config or $wgLocaltimezone.

• {{LOCALYEAR}}
• {{LOCALMONTH}}
• {{LOCALMONTHNAME}}
• {{LOCALMONTHNAMEGEN}}
• {{LOCALMONTHABBREV}}
• {{LOCALDAY}}
• {{LOCALDAY2}}
• {{LOCALDOW}}
• {{LOCALDAYNAME}}
• {{LOCALTIME}}
• {{LOCALHOUR}}
• {{LOCALWEEK}}
• {{LOCALTIMESTAMP}}

For more thorough time formatting, you may want to install Extension:ParserFunctions to use the #time parser function.

Technical metadata

Note: Revision variables return data about the latest edit to the current page, even if viewing an older version of the page.

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

Statistics

Numbers returned by these variables normally contain separators (commas or spaces, depending on the local language), but can return raw numbers with the ":R" flag (for example, {{NUMBEROFPAGES}} → 295 and {{NUMBEROFPAGES:R}} → 295). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}, or {{PAGESINCATEGORY:Help|subcats}} and {{PAGESINCATEGORY:Help|subcats|R}}). Also applicable to {{PAGESIZE:page name}} hereinbefore.

The number magic words are formatted in the wiki content language. Since {{#ifeq: 94680 | ?

| r? {{#if:  ||}}
| {{#if:1.19|1.19}}

}}, it depends on the page content language.

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

Page names

The {{BASEPAGENAME}} and {{SUBPAGENAME}} magic words only work in namespaces that have subpages enabled. See {{ #ifeq:

 GridPACK

| MediaWiki | Manual:$wgNamespacesWithSubpages | [[{{#if:|{{#ifexist:Manual:$wgNamespacesWithSubpages||mw:}}}}Manual:$wgNamespacesWithSubpages|Manual:$wgNamespacesWithSubpages]] }} for information on enabling subpages.

As of {{ #ifeq:

 GridPACK

| MediaWiki | 1.15+ | [[{{#if:|{{#ifexist:rev:46662||mw:}}}}rev:46662|1.15+]] }}, these can all take a parameter, allowing specification of the page to be operated on, instead of just the current page:

• {{PAGENAME:Template:Main Page}} → Main Page

{{#if: Page titles containing certain characters, such as apostrophes ' or asterisks *, may produce unexpected results when handled with these magic words, e.g. {{PAGESINCATEGORY:{{PAGENAME}}}}. See bugs {{ #ifeq:

 GridPACK

| MediaWiki | 14779 | [[{{#if:|{{#ifexist:bugzilla:14779||mw:}}}}bugzilla:14779|14779]] }}, {{ #ifeq:

 GridPACK

| MediaWiki | 16474 | [[{{#if:|{{#ifexist:bugzilla:16474||mw:}}}}bugzilla:16474|16474]] }} and {{ #ifeq:

 GridPACK

| MediaWiki | 35628 | [[{{#if:|{{#ifexist:bugzilla:35628||mw:}}}}bugzilla:35628|35628]]

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

For example, if page name is "L'Aquila", the following code will produce the string "Numeric char encoding":

{{#switch:{{PAGENAME}}
| L'Aquila = No translation
| L = Not OK
| L'Aquila = Entity escaping
| L'Aquila = Numeric char encoding
}}

URL encoded page names

The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters HTML escaped using numeric character encoding):

• {{FULLPAGENAMEE}}
• {{PAGENAMEE}}
• {{BASEPAGENAMEE}}
• {{SUBPAGENAMEE}}
• {{SUBJECTPAGENAMEE}}
• {{ARTICLEPAGENAMEE}}
• {{TALKPAGENAMEE}}

Note that {{PAGENAME}}, {{PAGENAMEE}} and {{urlencode:}} have distinct implementations. See Manual:PAGENAMEE encoding for details.

Namespaces

The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded):

• {{NAMESPACEE}}
• {{SUBJECTSPACEE}}
• {{TALKSPACEE}}

As of {{ #ifeq:

 GridPACK

| MediaWiki | 1.15+ | [[{{#if:|{{#ifexist:rev:46630||mw:}}}}rev:46630|1.15+]] }}, these can take a full-page-name parameter and will return the requested namespace associated with that page, instead of with the current page:

• {{NAMESPACE:Template:Main Page}} → Template
• {{SUBJECTSPACE:Template:Main Page}} → Template
• {{TALKSPACE:Template:Main Page}} → Template talk

Parameter must not be a namespace name:

• {{SUBJECTSPACE:Help talk}} →   (Empty)

Parser functions

Parser functions are very similar to variables, but take one or more parameters (technically, any magic word that takes a parameter is a parser function), and the name is sometimes prefixed with a hash to distinguish them from templates.

This page only describes parser functions that are integral to the MediaWiki software. Other parser functions may be added by MediaWiki extensions such as the {{ #ifeq:

 GridPACK

| MediaWiki | ParserFunctions extension | [[{{#if:|{{#ifexist:Extension:ParserFunctions||mw:}}}}Extension:ParserFunctions|ParserFunctions extension]] }}. For those see Help:Extension:ParserFunctions.

URL data

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

 GridPACK

Namespaces

{{ns:}} returns the current localized name for the namespace with that index, canonical name, or local alias. Thus {{ns:6}}, {{ns:File}}, and {{ns:Image}} (an old name for the File namespace) all return "File". On a wiki where the content language is French, {{ns:Fichier}} is also valid, but {{ns:Datei}} (the localisation of "File" in German) is not.

{{nse:}} is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links.

Don't confuse localised namespaces with custom namespaces.

Formatting

 GridPACK

 GridPACK

 GridPACK

 GridPACK

See also: Extension:StringFunctions.

Localisation

Here are the magic words which are used as main localisation tools. Other magic words will often depend on the wiki's locale and configuration or on the chosen language: see in particular #Date and time, #Formatting, #Miscellaneous. More magic words are added by the Translate extension.

The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on PLURAL, GRAMMAR, GENDER.

 GridPACK

 GridPACK

Miscellaneous

 GridPACK

 GridPACK

 GridPACK

 GridPACK

}}

 |Afrikaans
 |Afrikaans
 }}

 |العربية
 |العربية
 }}

 |asturianu
 |asturianu
 }}

 |azərbaycanca
 |azərbaycanca
 }}

 |جهلسری بلوچی
 |جهلسری بلوچی
 }}

 |български
 |български
 }}

 |brezhoneg
 |brezhoneg
 }}

 |বাংলা
 |বাংলা
 }}

 |bosanski
 |bosanski
 }}

 |català
 |català
 }}

 |čeština
 |čeština
 }}

 |dansk
 |dansk
 }}

 |Deutsch
 |Deutsch
 }}

 |Zazaki
 |Zazaki
 }}

 |Ελληνικά
 |Ελληνικά
 }}

 |Esperanto
 |Esperanto
 }}

 |español
 |español
 }}

 |فارسی
 |فارسی
 }}

 |suomi
 |suomi
 }}

 |français
 |français
 }}

 |galego
 |galego
 }}

 |ગુજરાતી
 |ગુજરાતી
 }}

 |עברית
 |עברית
 }}

 |हिन्दी
 |हिन्दी
 }}

 |magyar
 |magyar
 }}

 |Հայերեն
 |Հայերեն
 }}

 |Bahasa Indonesia
 |Bahasa Indonesia
 }}

 |Ido
 |Ido
 }}

 |italiano
 |italiano
 }}

 |日本語
 |日本語
 }}

 |ქართული
 |ქართული
 }}

 |қазақша
 |қазақша
 }}

 |ភាសាខ្មែរ
 |ភាសាខ្មែរ
 }}

 |한국어
 |한국어
 }}

 |Ripoarisch
 |Ripoarisch
 }}

 |kernowek
 |kernowek
 }}

 |Latina
 |Latina
 }}

 |Baso Minangkabau
 |Baso Minangkabau
 }}

 |македонски
 |македонски
 }}

 |മലയാളം
 |മലയാളം
 }}

 |मराठी
 |मराठी
 }}

 |Bahasa Melayu
 |Bahasa Melayu
 }}

 |Nederlands
 |Nederlands
 }}

 |norsk bokmål
 |norsk bokmål
 }}

 |occitan
 |occitan
 }}

 |ଓଡ଼ିଆ
 |ଓଡ଼ିଆ
 }}

 |polski
 |polski
 }}

 |português
 |português
 }}

 |português do Brasil
 |português do Brasil
 }}

 |română
 |română
 }}

 |русский
 |русский
 }}

 |සිංහල
 |සිංහල
 }}

 |slovenčina
 |slovenčina
 }}

 |slovenščina
 |slovenščina
 }}

 |shqip
 |shqip
 }}

 |српски / srpski
 |српски / srpski
 }}

 |svenska
 |svenska
 }}

 |தமிழ்
 |தமிழ்
 }}

 |ไทย
 |ไทย
 }}

 |Türkçe
 |Türkçe
 }}

 |українська
 |українська
 }}

 |Tiếng Việt
 |Tiếng Việt
 }}

 |ייִדיש
 |ייִדיש
 }}

 |粵語
 |粵語
 }}

 |中文
 |中文
 }}

 |中文（简体）‎
 |中文（简体）‎
 }}

 |中文（繁體）‎
 |中文（繁體）‎
 }}

 |中文（台灣）‎
 |中文（台灣）‎
 }}