Difference between revisions of "Help:Magic words"
m (1 revision: Help Documentation Lifted with Permission from Mediawiki) |
(Minor link tweaks.) |
||
Line 1: | Line 1: | ||
− | '''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 | + | '''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 [[mw:Manual:Magic words|Manual:Magic words]]. |
There are three general types of magic words: | There are three general types of magic words: | ||
*'''[[#Behavior switches|Behavior switches]]''': these are uppercase words surrounded by double underscores, ''e.g.'' '''__FOO__'''. | *'''[[#Behavior switches|Behavior switches]]''': these are uppercase words surrounded by double underscores, ''e.g.'' '''__FOO__'''. | ||
*'''[[#Variables|Variables]]''': these are uppercase words surrounded by double braces, ''e.g.'' '''<code><nowiki>{{FOO}}</nowiki></code>'''. As such, they look a lot like [[Help:Templates|templates]]. | *'''[[#Variables|Variables]]''': these are uppercase words surrounded by double braces, ''e.g.'' '''<code><nowiki>{{FOO}}</nowiki></code>'''. As such, they look a lot like [[Help:Templates|templates]]. | ||
− | *'''[[#Parser functions|Parser functions]]''': these take parameters and are either of the form '''<code><nowiki>{{foo:...}}</nowiki></code>''' or '''<code><nowiki>{{#foo:...}}</nowiki></code>'''. See also | + | *'''[[#Parser functions|Parser functions]]''': these take parameters and are either of the form '''<code><nowiki>{{foo:...}}</nowiki></code>''' or '''<code><nowiki>{{#foo:...}}</nowiki></code>'''. See also [[mw:Help:Extension:ParserFunctions|Help:Extension:ParserFunctions]]. |
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. | 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. | ||
Line 18: | Line 18: | ||
! {{Hl2}}| Versions | ! {{Hl2}}| Versions | ||
|- | |- | ||
− | ! {{Hl3}} colspan="3"| '''[[Table of contents]]''' | + | ! {{Hl3}} colspan="3"| '''[[mw:Table of contents|Table of contents]]''' |
|- | |- | ||
| <code><nowiki>__NOTOC__</nowiki></code> | | <code><nowiki>__NOTOC__</nowiki></code> | ||
− | | Hides the [[table of contents]] (TOC). | + | | Hides the [[mw:Table of contents|table of contents]] (TOC). |
| | | | ||
|- | |- | ||
Line 35: | Line 35: | ||
|- | |- | ||
| <code><nowiki>__NOEDITSECTION__</nowiki></code> | | <code><nowiki>__NOEDITSECTION__</nowiki></code> | ||
− | | Hides the section edit links beside headings. This is especially useful, where a heading is created from within a template: the normal wiki section-edit would in this case edit the template code, which is normally | + | | Hides the section edit links beside headings. This is especially useful, where a heading is created from within a template: the normal wiki section-edit would in this case edit the template code, which is normally counter-intuitive to the user. If a template contains multiple headings, it may be necessary to add "<code><nowiki>__NOEDITSECTION__</nowiki></code>" after each heading. |
| | | | ||
|- | |- | ||
| <code><nowiki>__NEWSECTIONLINK__</nowiki></code> | | <code><nowiki>__NEWSECTIONLINK__</nowiki></code> | ||
− | | Adds a link ([[MediaWiki:Addsection|"+" by default]]) beside the "edit" tab for adding a new section on a non-talk page (see | + | | Adds a link ([[MediaWiki:Addsection|"+" by default]]) beside the "edit" tab for adding a new section on a non-talk page (see [[mw:Help:Section#Adding a section at the end|Adding a section to the end). |
| 1.7+ | | 1.7+ | ||
|- | |- | ||
| <code><nowiki>__NONEWSECTIONLINK__</nowiki></code> | | <code><nowiki>__NONEWSECTIONLINK__</nowiki></code> | ||
| Removes the link beside the "edit" tab on pages in talk namespaces. | | Removes the link beside the "edit" tab on pages in talk namespaces. | ||
− | | | + | | [[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/47522 1.15+]] |
|- | |- | ||
! {{Hl3}} colspan="3"| '''Categories''' | ! {{Hl3}} colspan="3"| '''Categories''' | ||
Line 73: | Line 73: | ||
|- | |- | ||
| <code><nowiki>__END__</nowiki></code> | | <code><nowiki>__END__</nowiki></code> | ||
− | | Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in | + | | Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/19213 19213]. |
| 1.1–1.8 | | 1.1–1.8 | ||
|- | |- | ||
| <code><nowiki>__INDEX__</nowiki></code> | | <code><nowiki>__INDEX__</nowiki></code> | ||
− | | Tell search engines to index the page (overrides | + | | Tell search engines to index the page (overrides [[mw:Manual:$wgArticleRobotPolicies|$wgArticleRobotPolicies]], but not robots.txt). |
| 1.14+ | | 1.14+ | ||
|- | |- | ||
| <code><nowiki>__NOINDEX__</nowiki></code> | | <code><nowiki>__NOINDEX__</nowiki></code> | ||
| Tell search engines not to index the page (i.e. do not list in search engines' results). | | Tell search engines not to index the page (i.e. do not list in search engines' results). | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/37973 1.14+] |
|- | |- | ||
| <code><nowiki>__STATICREDIRECT__</nowiki></code> | | <code><nowiki>__STATICREDIRECT__</nowiki></code> | ||
| On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title". | | On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title". | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/37928 1.13+] |
|} | |} | ||
Line 101: | Line 101: | ||
Due to MediaWiki and browser caching, these variables frequently show when the page was ''cached'' rather than the current time. | 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 | + | The date and time magic words are formatted in the wiki content language. Since [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/94680 1.19], they depend on the [[mw:Page_content_language|content language]]. |
{| class="wikitable" | {| class="wikitable" | ||
Line 201: | Line 201: | ||
* <nowiki>{{LOCALTIMESTAMP}}</nowiki></code> | * <nowiki>{{LOCALTIMESTAMP}}</nowiki></code> | ||
− | * ''For more thorough time formatting, you may want to install [[Extension:ParserFunctions]] to use the [[Help:Extension:ParserFunctions#.23time|#time parser function]]''. | + | * ''For more thorough time formatting, you may want to install [[mw:Extension:ParserFunctions|Extension:ParserFunctions]] to use the [[mw:Help:Extension:ParserFunctions#.23time|#time parser function]]''. |
=== Technical metadata === | === Technical metadata === | ||
Line 218: | Line 218: | ||
| <code><nowiki>{{SITENAME}}</nowiki></code> | | <code><nowiki>{{SITENAME}}</nowiki></code> | ||
| {{SITENAME}} | | {{SITENAME}} | ||
− | | The wiki's site name ( | + | | The wiki's site name ([[mw:Manual:$wgSitename|$wgSitename]]). |
| | | | ||
|- | |- | ||
| <code><nowiki>{{SERVER}}</nowiki></code> | | <code><nowiki>{{SERVER}}</nowiki></code> | ||
| {{SERVER}} | | {{SERVER}} | ||
− | | Domain URL ( | + | | Domain URL ([[mw:Manual:$wgServer|$wgServer]]). |
| | | | ||
|- | |- | ||
| <code><nowiki>{{SERVERNAME}}</nowiki></code> | | <code><nowiki>{{SERVERNAME}}</nowiki></code> | ||
| {{SERVERNAME}} | | {{SERVERNAME}} | ||
− | | Domain name (no longer dependent on | + | | Domain name (no longer dependent on [[mw:Manual:$wgServerName|$wgServerName]] as of version 1.17). |
| | | | ||
|- | |- | ||
| <code><nowiki>{{DIRMARK}}</nowiki></code><br /><code><nowiki>{{DIRECTIONMARK}}</nowiki></code> | | <code><nowiki>{{DIRMARK}}</nowiki></code><br /><code><nowiki>{{DIRECTIONMARK}}</nowiki></code> | ||
| {{DIRMARK}}<br />{{DIRECTIONMARK}} | | {{DIRMARK}}<br />{{DIRECTIONMARK}} | ||
− | | Outputs a unicode-directional mark that matches the wiki's default language's direction (<code>&lrm;</code> on left-to-right wikis, <code>&rlm;</code> on right-to-left wikis), useful in text with multi-directional text. Since | + | | Outputs a unicode-directional mark that matches the wiki's default language's direction (<code>&lrm;</code> on left-to-right wikis, <code>&rlm;</code> on right-to-left wikis), useful in text with multi-directional text. Since [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/94680 1.19], it depends on the [[mw:page content language|page content language]]. |
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/14442 1.7+] |
|- | |- | ||
| <code><nowiki>{{SCRIPTPATH}}</nowiki></code> | | <code><nowiki>{{SCRIPTPATH}}</nowiki></code> | ||
| {{SCRIPTPATH}} | | {{SCRIPTPATH}} | ||
− | | Relative script path ( | + | | Relative script path ([[mw:Manual:$wgScriptPath|$wgScriptPath]]). |
| | | | ||
|- | |- | ||
| <code><nowiki>{{STYLEPATH}}</nowiki></code> | | <code><nowiki>{{STYLEPATH}}</nowiki></code> | ||
| {{STYLEPATH}} | | {{STYLEPATH}} | ||
− | | Relative style path ( | + | | Relative style path ([[mw:Manual:$wgStylePath|$wgStylePath]]). |
| 1.16+ | | 1.16+ | ||
|- | |- | ||
Line 249: | Line 249: | ||
| {{CURRENTVERSION}} | | {{CURRENTVERSION}} | ||
| The wiki's MediaWiki version. | | The wiki's MediaWiki version. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/14199 1.7+] |
|- | |- | ||
| <code><nowiki>{{CONTENTLANGUAGE}}</nowiki></code><br /><code><nowiki>{{CONTENTLANG}}</nowiki></code> | | <code><nowiki>{{CONTENTLANGUAGE}}</nowiki></code><br /><code><nowiki>{{CONTENTLANG}}</nowiki></code> | ||
| {{CONTENTLANGUAGE}}<br />{{CONTENTLANG}} | | {{CONTENTLANGUAGE}}<br />{{CONTENTLANG}} | ||
− | | The wiki's default interface language ( | + | | The wiki's default interface language ([[mw:Manual:$wgLanguageCode|$wgLanguageCode]]). |
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/14661 1.7+] |
|- | |- | ||
! {{Hl3}} colspan="4"| '''Page''' | ! {{Hl3}} colspan="4"| '''Page''' | ||
Line 261: | Line 261: | ||
| {{PAGEID}} | | {{PAGEID}} | ||
| Returns the page identifier. | | Returns the page identifier. | ||
− | | | + | | [https://gerrit.wikimedia.org/r/9858 1.20+] |
|-style="background:#FED;" | |-style="background:#FED;" | ||
| <code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>|R}}</nowiki> | | <code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>|R}}</nowiki> | ||
| {{PAGESIZE:Help:Magic_words}}<br />{{PAGESIZE:Help:Magic_words|R}} | | {{PAGESIZE:Help:Magic_words}}<br />{{PAGESIZE:Help:Magic_words|R}} | ||
| '''[Expensive]''' Returns the byte size of the specified page. Use "<code><nowiki>|R</nowiki></code>" to get raw (unformatted) numbers. | | '''[Expensive]''' Returns the byte size of the specified page. Use "<code><nowiki>|R</nowiki></code>" to get raw (unformatted) numbers. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/33551 1.13+] |
|- | |- | ||
| <code><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></code> | | <code><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></code> | ||
| <!-- Leave this empty. --> | | <!-- Leave this empty. --> | ||
| Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the current page or an empty string if not protected. | | Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the current page or an empty string if not protected. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/45587 1.15+] |
|- | |- | ||
! {{Hl3}} colspan="4"| '''Latest revision to current page''' | ! {{Hl3}} colspan="4"| '''Latest revision to current page''' | ||
Line 292: | Line 292: | ||
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code> | | <code><nowiki>{{REVISIONMONTH}}</nowiki></code> | ||
| {{REVISIONMONTH}} | | {{REVISIONMONTH}} | ||
− | | Month edit was made (zero-padded number as of | + | | Month edit was made (zero-padded number as of [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/66200 1.17+], unpadded number in prior versions). |
| 1.8+ | | 1.8+ | ||
|- | |- | ||
Line 298: | Line 298: | ||
| {{REVISIONMONTH1}} | | {{REVISIONMONTH1}} | ||
| Month edit was made (unpadded number). | | Month edit was made (unpadded number). | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/66200 1.17+] |
|- | |- | ||
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code> | | <code><nowiki>{{REVISIONYEAR}}</nowiki></code> | ||
Line 313: | Line 313: | ||
| {{REVISIONUSER}} | | {{REVISIONUSER}} | ||
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit. | | The username of the user who made the most recent edit to the page, or the current user when previewing an edit. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/48149 1.15+] |
|- | |- | ||
! {{Hl3}} colspan="4"| '''Affects page content''' | ! {{Hl3}} colspan="4"| '''Affects page content''' | ||
Line 319: | Line 319: | ||
| <code><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></code> | | <code><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></code> | ||
| | | | ||
− | | Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores are allowed (this can be changed with | + | | Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores are allowed (this can be changed with [[mw:Manual:$wgRestrictDisplayTitle|$wgRestrictDisplayTitle]]). It can be disabled or enabled by [[mw:Manual:$wgAllowDisplayTitle|$wgAllowDisplayTitle]]; disabled by default before 1.10+, enabled by default thereafter. |
| 1.7+ | | 1.7+ | ||
|- | |- | ||
Line 325: | Line 325: | ||
| | | | ||
| Used for categorizing pages, sets a default [[Help:Categories|category sort key]]. For example if you put <code><nowiki>{{DEFAULTSORT:Smith, John}}</nowiki></code> at the end of [[John Smith]], the page would be sorted under "S" by default in categories. It can take a second argument of ''noerror'' or ''noreplace'' to suppress error messages when multiple defaultsortkeys are used on one page or to make it do nothing if multiple defaultsortkeys are used. | | Used for categorizing pages, sets a default [[Help:Categories|category sort key]]. For example if you put <code><nowiki>{{DEFAULTSORT:Smith, John}}</nowiki></code> at the end of [[John Smith]], the page would be sorted under "S" by default in categories. It can take a second argument of ''noerror'' or ''noreplace'' to suppress error messages when multiple defaultsortkeys are used on one page or to make it do nothing if multiple defaultsortkeys are used. | ||
− | | 1.10+<br/> | + | | 1.10+<br/>[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/96767 1.19+] (for noerror and noreplace) |
|} | |} | ||
Line 332: | Line 332: | ||
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, <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code> → {{NUMBEROFPAGES}} and <code><nowiki>{{NUMBEROFPAGES:R}}</nowiki></code> → {{NUMBEROFPAGES:R}}). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example <code><nowiki>{{PAGESINCATEGORY:Help}}</nowiki></code> and <code><nowiki>{{PAGESINCATEGORY:Help|R}}</nowiki></code>, or <code><nowiki>{{PAGESINCATEGORY:Help|subcats}}</nowiki></code> and <code><nowiki>{{PAGESINCATEGORY:Help|subcats|R}}</nowiki></code>). Also applicable to <code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></code> hereinbefore. | 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, <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code> → {{NUMBEROFPAGES}} and <code><nowiki>{{NUMBEROFPAGES:R}}</nowiki></code> → {{NUMBEROFPAGES:R}}). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example <code><nowiki>{{PAGESINCATEGORY:Help}}</nowiki></code> and <code><nowiki>{{PAGESINCATEGORY:Help|R}}</nowiki></code>, or <code><nowiki>{{PAGESINCATEGORY:Help|subcats}}</nowiki></code> and <code><nowiki>{{PAGESINCATEGORY:Help|subcats|R}}</nowiki></code>). Also applicable to <code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></code> hereinbefore. | ||
− | The number magic words are formatted in the wiki content language. Since | + | The number magic words are formatted in the wiki content language. Since [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/94680 1.19], it depends on the [[mw:Page_Content_Language:page content language]]. |
{| class="wikitable" | {| class="wikitable" | ||
Line 350: | Line 350: | ||
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code> | | <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code> | ||
| {{NUMBEROFARTICLES}} | | {{NUMBEROFARTICLES}} | ||
− | | Number of pages in | + | | Number of pages in [mw:Manual:Using custom namespaces#Content namespaces|content namespaces]]. |
| | | | ||
|- | |- | ||
Line 361: | Line 361: | ||
| {{NUMBEROFEDITS}} | | {{NUMBEROFEDITS}} | ||
| Number of page edits. | | Number of page edits. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/21319 1.10+] |
|- | |- | ||
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code> | | <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code> | ||
| {{NUMBEROFVIEWS}} | | {{NUMBEROFVIEWS}} | ||
| Number of page views. Usually useless on a wiki using [[Manual:Cache|caching]]. | | Number of page views. Usually useless on a wiki using [[Manual:Cache|caching]]. | ||
− | | | + | | [http://chg-wiki.geog.ucsb.edu/index.php?title=Rev:42721&action=edit&redlink=1 1.14+] |
|- | |- | ||
| <code><nowiki>{{NUMBEROFUSERS}}</nowiki></code> | | <code><nowiki>{{NUMBEROFUSERS}}</nowiki></code> | ||
Line 375: | Line 375: | ||
| <code><nowiki>{{NUMBEROFADMINS}}</nowiki></code> | | <code><nowiki>{{NUMBEROFADMINS}}</nowiki></code> | ||
| {{NUMBEROFADMINS}} | | {{NUMBEROFADMINS}} | ||
− | | Number of users in the ''sysop'' | + | | Number of users in the ''sysop'' [[mw:Manual:User rights|group]]. |
| 1.7+ | | 1.7+ | ||
|- | |- | ||
Line 381: | Line 381: | ||
| {{NUMBEROFACTIVEUSERS}} | | {{NUMBEROFACTIVEUSERS}} | ||
| Number of active users, based on the criteria used in [[Special:Statistics]]. | | Number of active users, based on the criteria used in [[Special:Statistics]]. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/47392 1.15+] |
|- style="background:#FED;" | |- style="background:#FED;" | ||
| <code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINCAT:</nowiki>''categoryname''<nowiki>}}</nowiki></code> | | <code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINCAT:</nowiki>''categoryname''<nowiki>}}</nowiki></code> | ||
| {{PAGESINCATEGORY:Help}}<br />{{PAGESINCAT:Help}} | | {{PAGESINCATEGORY:Help}}<br />{{PAGESINCAT:Help}} | ||
| '''[Expensive]''' Number of pages (including any subcategories and files) in the given [[Help:Categories|category]]. | | '''[Expensive]''' Number of pages (including any subcategories and files) in the given [[Help:Categories|category]]. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/32932 1.13+] |
|- style="background:#FED;" | |- style="background:#FED;" | ||
| <code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|all}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|pages}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|subcats}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|files}}</nowiki></code> | | <code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|all}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|pages}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|subcats}}</nowiki></code><br /><code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>|files}}</nowiki></code> | ||
Line 400: | Line 400: | ||
| <code><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></code><br /><code><nowiki>{{NUMINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></code> | | <code><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></code><br /><code><nowiki>{{NUMINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></code> | ||
| {{NUMBERINGROUP:bureaucrat}}<br />{{NUMINGROUP:bureaucrat}}<br /><small><nowiki>({{NUMBERINGROUP:bureaucrat}} used here)</nowiki></small> | | {{NUMBERINGROUP:bureaucrat}}<br />{{NUMINGROUP:bureaucrat}}<br /><small><nowiki>({{NUMBERINGROUP:bureaucrat}} used here)</nowiki></small> | ||
− | | Number of users in a specific | + | | Number of users in a specific [[mw:Manual:User rights|group]]. |
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/40116 1.14+] |
|- | |- | ||
| <code><nowiki>{{PAGESINNS:</nowiki>''index''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINNAMESPACE:</nowiki>''index''<nowiki>}}</nowiki></code> | | <code><nowiki>{{PAGESINNS:</nowiki>''index''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINNAMESPACE:</nowiki>''index''<nowiki>}}</nowiki></code> | ||
| ''Not enabled'' | | ''Not enabled'' | ||
− | | Number of pages in the given [[Help:Namespaces|namespace]] (replace ''index'' with the relevant [[Manual:Namespace|namespace index]]). For instance, <code><nowiki>{{PAGESINNAMESPACE:</nowiki>''14''<nowiki>}}</nowiki></code> will output the number of category pages. <code><nowiki>{{PAGESINNS:0}}</nowiki></code> differs from <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code> in that the former includes redirects and disambiguation pages. Disabled by default, enable with | + | | Number of pages in the given [[Help:Namespaces|namespace]] (replace ''index'' with the relevant [[mw:Manual:Namespace|namespace index]]). For instance, <code><nowiki>{{PAGESINNAMESPACE:</nowiki>''14''<nowiki>}}</nowiki></code> will output the number of category pages. <code><nowiki>{{PAGESINNS:0}}</nowiki></code> differs from <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code> in that the former includes redirects and disambiguation pages. Disabled by default, enable with [[mw:Manual:$wgAllowSlowParserFunctions|$wgAllowSlowParserFunctions]]. |
| 1.7+ | | 1.7+ | ||
|} | |} | ||
Line 430: | Line 430: | ||
| {{BASEPAGENAME}} | | {{BASEPAGENAME}} | ||
| Page title excluding the current [[Help:Subpages|subpage]] and namespace ("Title/foo" on "Title/foo/bar"). | | Page title excluding the current [[Help:Subpages|subpage]] and namespace ("Title/foo" on "Title/foo/bar"). | ||
− | For more complex splitting, use <code><nowiki>{{</nowiki>[[Help:Extension:ParserFunctions#.23titleparts|#titleparts:]]<nowiki>}}</nowiki></code> from [[Help:Extension:ParserFunctions|ParserFunctions extension]]. | + | For more complex splitting, use <code><nowiki>{{</nowiki>[[mw:Help:Extension:ParserFunctions#.23titleparts|#titleparts:]]<nowiki>}}</nowiki></code> from [[mw:Help:Extension:ParserFunctions|ParserFunctions extension]]. |
| 1.7+ | | 1.7+ | ||
|- | |- | ||
Line 449: | Line 449: | ||
|} | |} | ||
− | The <code><nowiki>{{BASEPAGENAME}}</nowiki></code> and <code><nowiki>{{SUBPAGENAME}}</nowiki></code> magic words only work in namespaces that have subpages enabled. See | + | The <code><nowiki>{{BASEPAGENAME}}</nowiki></code> and <code><nowiki>{{SUBPAGENAME}}</nowiki></code> magic words only work in namespaces that have subpages enabled. See [[mw:Manual:$wgNamespacesWithSubpages|$wgNamespacesWithSubpages]] for information on enabling subpages. |
− | As of | + | As of [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/46662 1.15+], these can all take a parameter, allowing specification of the page to be operated on, instead of just the current page: |
* <code><nowiki>{{PAGENAME:Template:Main Page}}</nowiki></code> → '''{{PAGENAME:Template:Main Page}}''' | * <code><nowiki>{{PAGENAME:Template:Main Page}}</nowiki></code> → '''{{PAGENAME:Template:Main Page}}''' | ||
− | {{Warning|Page titles containing certain characters, such as single quotes (') or asterisks <code>*</code>, may produce unexpected results when handled with these magic words, e.g. <code><nowiki>{{PAGESINCATEGORY:{{PAGENAME}}}}</nowiki></code>. See bugs | + | {{Warning|Page titles containing certain characters, such as single quotes (') or asterisks <code>*</code>, may produce unexpected results when handled with these magic words, e.g. <code><nowiki>{{PAGESINCATEGORY:{{PAGENAME}}}}</nowiki></code>. See bugs []https://bugzilla.wikimedia.org/show_bug.cgi?id=14779 14779], [https://bugzilla.wikimedia.org/show_bug.cgi?id=16474 16474] and [https://bugzilla.wikimedia.org/show_bug.cgi?id=35628 35628].}} |
For example, if page name is "L'Aquila", the following code will produce the string "Numeric char encoding": | For example, if page name is "L'Aquila", the following code will produce the string "Numeric char encoding": | ||
Line 476: | Line 476: | ||
* <nowiki>{{TALKPAGENAMEE}}</nowiki></code> | * <nowiki>{{TALKPAGENAMEE}}</nowiki></code> | ||
− | Note that <code><nowiki>{{PAGENAME}}</nowiki></code>, <code><nowiki>{{PAGENAMEE}}</nowiki></code> and <code><nowiki>{{urlencode:}}</nowiki></code> have distinct implementations. See [[Manual:PAGENAMEE encoding]] for details. | + | Note that <code><nowiki>{{PAGENAME}}</nowiki></code>, <code><nowiki>{{PAGENAMEE}}</nowiki></code> and <code><nowiki>{{urlencode:}}</nowiki></code> have distinct implementations. See [[mw:Manual:PAGENAMEE encoding|Manual:PAGENAMEE encoding]] for details. |
===Namespaces=== | ===Namespaces=== | ||
Line 512: | Line 512: | ||
* <nowiki>{{TALKSPACEE}}</nowiki></code> | * <nowiki>{{TALKSPACEE}}</nowiki></code> | ||
− | As of | + | As of [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/46662 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: |
* <code><nowiki>{{NAMESPACE:Template:Main Page}}</nowiki></code> → '''{{NAMESPACE:Template:Main Page}}''' | * <code><nowiki>{{NAMESPACE:Template:Main Page}}</nowiki></code> → '''{{NAMESPACE:Template:Main Page}}''' | ||
* <code><nowiki>{{SUBJECTSPACE:Template:Main Page}}</nowiki></code> → '''{{SUBJECTSPACE:Template:Main Page}}''' | * <code><nowiki>{{SUBJECTSPACE:Template:Main Page}}</nowiki></code> → '''{{SUBJECTSPACE:Template:Main Page}}''' | ||
Line 523: | Line 523: | ||
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. | 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 | + | 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 [[mw:Extension:ParserFunctions|ParserFunctions extension}}. For those see [[mw:Help:Extension:ParserFunctions|Help:Extension:ParserFunctions]]. |
=== URL data === | === URL data === | ||
Line 542: | Line 542: | ||
| <code><nowiki>{{fullurl:Category:Top level}}</nowiki></code> → {{fullurl:Category:Top level}}<br /> | | <code><nowiki>{{fullurl:Category:Top level}}</nowiki></code> → {{fullurl:Category:Top level}}<br /> | ||
<code><nowiki>{{fullurl:Category:Top level|action=edit}}</nowiki></code> → {{fullurl:Category:Top level|action=edit}} | <code><nowiki>{{fullurl:Category:Top level|action=edit}}</nowiki></code> → {{fullurl:Category:Top level|action=edit}} | ||
− | | A protocol-relative path to the title. This will also resolve [[Manual:Interwiki|interwiki]] prefixes. '''Note''': Unbracketed (plain) protocol-relative links are not automagically linked. | + | | A protocol-relative path to the title. This will also resolve [[mw:Manual:Interwiki|interwiki]] prefixes. '''Note''': Unbracketed (plain) protocol-relative links are not automagically linked. |
| 1.5+ | | 1.5+ | ||
|- | |- | ||
Line 548: | Line 548: | ||
| <code><nowiki>{{canonicalurl:Category:Top level}}</nowiki></code> → {{canonicalurl:Category:Top level}}<br /> | | <code><nowiki>{{canonicalurl:Category:Top level}}</nowiki></code> → {{canonicalurl:Category:Top level}}<br /> | ||
<code><nowiki>{{canonicalurl:Category:Top level|action=edit}}</nowiki></code> → {{canonicalurl:Category:Top level|action=edit}} | <code><nowiki>{{canonicalurl:Category:Top level|action=edit}}</nowiki></code> → {{canonicalurl:Category:Top level|action=edit}} | ||
− | | The absolute path to the title, using the canonical URL. This will also resolve [[Manual:Interwiki|Interwiki]] prefixes. | + | | The absolute path to the title, using the canonical URL. This will also resolve [[mw:Manual:Interwiki|Interwiki]] prefixes. |
| 1.18+ | | 1.18+ | ||
|- | |- | ||
Line 555: | Line 555: | ||
<code><nowiki>{{filepath:Wiki.png|nowiki}}</nowiki></code> → {{filepath:Wiki.png|nowiki}}<br /> | <code><nowiki>{{filepath:Wiki.png|nowiki}}</nowiki></code> → {{filepath:Wiki.png|nowiki}}<br /> | ||
<code><nowiki>{{filepath:Example.svg|300}}</nowiki></code> → {{filepath:Example.svg|300}}<br /> | <code><nowiki>{{filepath:Example.svg|300}}</nowiki></code> → {{filepath:Example.svg|300}}<br /> | ||
− | | A protocol-relative path to the full size or thumbnail ( | + | | A protocol-relative path to the full size or thumbnail ([http://www.mediawiki.org/wiki/Special:Code/MediaWiki/80813 1.18+]) of a media file. |
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/25854 1.12+]<br />[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/80813 1.18+] |
|- | |- | ||
| <code><nowiki>{{urlencode:</nowiki>''string''<nowiki>}}</nowiki></code> (or <code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|QUERY}}</nowiki></code>)<br /><code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|WIKI}}</nowiki></code><br /><code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|PATH}}</nowiki></code> | | <code><nowiki>{{urlencode:</nowiki>''string''<nowiki>}}</nowiki></code> (or <code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|QUERY}}</nowiki></code>)<br /><code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|WIKI}}</nowiki></code><br /><code><nowiki>{{urlencode:</nowiki>''string''<nowiki>|PATH}}</nowiki></code> | ||
Line 562: | Line 562: | ||
Note that the default changed from <code>|WIKI</code> to <code>|QUERY</code> in 1.17; this may break templates that rely on this function. | Note that the default changed from <code>|WIKI</code> to <code>|QUERY</code> in 1.17; this may break templates that rely on this function. | ||
| The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete [[Extension:StringFunctions]]. | | The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete [[Extension:StringFunctions]]. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/14273 1.7+] (or [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/64726 1.17+])<br />[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/64726 1.17+]<br />[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/64726 1.17+] |
|- | |- | ||
| <code><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></code> | | <code><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></code> | ||
| <code><nowiki>{{anchorencode:x y z á é}}</nowiki></code> → {{anchorencode:x y z á é}} | | <code><nowiki>{{anchorencode:x y z á é}}</nowiki></code> → {{anchorencode:x y z á é}} | ||
| The input encoded for use in URL section anchors (after the “#” symbol in a URL). | | The input encoded for use in URL section anchors (after the “#” symbol in a URL). | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/16279 1.8+] |
|} | |} | ||
===Namespaces=== | ===Namespaces=== | ||
− | <code><nowiki>{{ns:}}</nowiki></code> returns the current localized name for the [[Help: | + | <code><nowiki>{{ns:}}</nowiki></code> returns the current localized name for the [[Help:Namespaces|namespace]] with that index, canonical name, or local alias. Thus <code><nowiki>{{ns:6}}</nowiki></code>, <code><nowiki>{{ns:File}}</nowiki></code>, and <code><nowiki>{{ns:Image}}</nowiki></code> (an old name for the File namespace) all return "{{ns:6}}". On a wiki where the content language was French, <code><nowiki>{{ns:Fichier}}</nowiki></code> would also be valid, but <code><nowiki>{{ns:Datei}}</nowiki></code> (the localisation of "File" into German) would not. |
<code><nowiki>{{nse:}}</nowiki></code> is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links. | <code><nowiki>{{nse:}}</nowiki></code> is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links. | ||
Line 659: | Line 659: | ||
| Takes an unformatted number (arab, no group separators and <code>.</code> as decimal separator) and outputs it in the localized digit script and formatted with decimal and decimal group separators, according to the wiki's default locale. <br /> | | Takes an unformatted number (arab, no group separators and <code>.</code> as decimal separator) and outputs it in the localized digit script and formatted with decimal and decimal group separators, according to the wiki's default locale. <br /> | ||
The <code><nowiki>|</nowiki>R</code> parameter can be used to reverse the behaviour, for use in mathematical situations: it's reliable and should be used only to deformat numbers who are known to be formatted exactly as formatnum formats them with the wiki's locale. <br/> | The <code><nowiki>|</nowiki>R</code> parameter can be used to reverse the behaviour, for use in mathematical situations: it's reliable and should be used only to deformat numbers who are known to be formatted exactly as formatnum formats them with the wiki's locale. <br/> | ||
− | <small>{{warning}}Leading zeroes are not removed, you can use <nowiki>{{#expr:00001}}</nowiki> instead if you have [[Extension:ParserFunctions]] installed.</small><br/> | + | <small>{{warning}}Leading zeroes are not removed, you can use <nowiki>{{#expr:00001}}</nowiki> instead if you have [[mw:Extension:ParserFunctions|Extension:ParserFunctions]] installed.</small><br/> |
<small>{{warning}} If you don't input numbers in the exact format required, don't expect any reliable output, especially on non-English wikis.</small> | <small>{{warning}} If you don't input numbers in the exact format required, don't expect any reliable output, especially on non-English wikis.</small> | ||
---- | ---- | ||
If you really need to format (according the wiki's locale) a number in unknown input format, you could try and use <code>formatnum</code> two times (but not if it can have a decimal group, or its separator will be eaten or the number won't be formatted). | If you really need to format (according the wiki's locale) a number in unknown input format, you could try and use <code>formatnum</code> two times (but not if it can have a decimal group, or its separator will be eaten or the number won't be formatted). | ||
− | | 1.7+<br /> | + | | 1.7+<br />[http://www.mediawiki.org/wiki/Special:Code/MediaWiki/32012 1.13+] |
|- | |- | ||
| | | | ||
Line 685: | Line 685: | ||
Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only. | Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only. | ||
| Formats an unlinked date based on user "Date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: <code>mdy</code>, <code>dmy</code>, <code>ymd</code>, <code>ISO 8601</code> (all case sensitive). If only the month and day are given, only <code>mdy</code> and <code>dmy</code> are valid. If a format is not specified or is invalid, the input format is used as a default. If the supplied date is not recognized as a valid date (specifically, if it contains any metadata such as from a nested use of these or similar templates), it is rendered unchanged, and no (additional) metadata is generated. <br/><small>{{warning}}Although the ISO 8601 standard requires that dates be in the Gregorian calendar, the ISO parameter in this function will still format dates that fall outside the usual Gregorian range (e.g. dates prior to 1583). Also, the magic word cannot properly convert between negative years (used with ISO 8601) and years BC or years BCE (used in general writing).</small> | | Formats an unlinked date based on user "Date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: <code>mdy</code>, <code>dmy</code>, <code>ymd</code>, <code>ISO 8601</code> (all case sensitive). If only the month and day are given, only <code>mdy</code> and <code>dmy</code> are valid. If a format is not specified or is invalid, the input format is used as a default. If the supplied date is not recognized as a valid date (specifically, if it contains any metadata such as from a nested use of these or similar templates), it is rendered unchanged, and no (additional) metadata is generated. <br/><small>{{warning}}Although the ISO 8601 standard requires that dates be in the Gregorian calendar, the ISO parameter in this function will still format dates that fall outside the usual Gregorian range (e.g. dates prior to 1583). Also, the magic word cannot properly convert between negative years (used with ISO 8601) and years BC or years BCE (used in general writing).</small> | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/48249 1.15+] |
|- | |- | ||
| <code><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></code> | | <code><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></code> | ||
Line 709: | Line 709: | ||
| <code><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''char''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''string''<nowiki>}}</nowiki></code> | | <code><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''char''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''string''<nowiki>}}</nowiki></code> | ||
| <code><nowiki>{{padleft:xyz|5}}</nowiki></code> → {{padleft:xyz|5}}<br /> <code><nowiki>{{padleft:xyz|5|_}}</nowiki></code> → {{padleft:xyz|5|_}} <code><nowiki>{{padleft:xyz|5|abc}}</nowiki></code> → {{padleft:xyz|5|abc}} <code><nowiki>{{padleft:xyz|2}}</nowiki></code> → {{padleft:xyz|2}}<br /> <code><nowiki>{{padleft:|1|xyz}}</nowiki></code> → {{padleft:|1|xyz}} (first character of the string)<br /> | | <code><nowiki>{{padleft:xyz|5}}</nowiki></code> → {{padleft:xyz|5}}<br /> <code><nowiki>{{padleft:xyz|5|_}}</nowiki></code> → {{padleft:xyz|5|_}} <code><nowiki>{{padleft:xyz|5|abc}}</nowiki></code> → {{padleft:xyz|5|abc}} <code><nowiki>{{padleft:xyz|2}}</nowiki></code> → {{padleft:xyz|2}}<br /> <code><nowiki>{{padleft:|1|xyz}}</nowiki></code> → {{padleft:|1|xyz}} (first character of the string)<br /> | ||
− | | Inserts a string of padding characters (character chosen in third parameter; default "0") of a specified length (second parameter) next to a chosen base character or variable (first parameter). The final digits or characters in the base replace the final characters in the padding; i.e. <code><nowiki>{{padleft:44|3|0}}</nowiki></code> produces {{padleft:44|3}}. The padding string may be truncated if its length does not evenly divide the required number of characters. <br />''' | + | | Inserts a string of padding characters (character chosen in third parameter; default "0") of a specified length (second parameter) next to a chosen base character or variable (first parameter). The final digits or characters in the base replace the final characters in the padding; i.e. <code><nowiki>{{padleft:44|3|0}}</nowiki></code> produces {{padleft:44|3}}. The padding string may be truncated if its length does not evenly divide the required number of characters. <br />'''[[mediazilla:16852|Bug}} (fixed in [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/45734 r45734]):''' multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters. |
| 1.8+ | | 1.8+ | ||
|- | |- | ||
Line 722: | Line 722: | ||
|} | |} | ||
− | '''See also:''' [[Extension:StringFunctions]]. | + | '''See also:''' [[mw:Extension:StringFunctions|Extension:StringFunctions]]. |
=== Localisation === | === 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 [[Extension:Translate|Translate extension]]. | + | 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 [[mw:Extension:Translate|Translate extension]]. |
− | The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on [ | + | The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on [http://translatewiki.net/wiki/FAQ#PLURAL Plural], [http://translatewiki.net/wiki/Grammar Grammar], [http://translatewiki.net/wiki/Gender Gender]. |
{| class="wikitable" | {| class="wikitable" | ||
Line 739: | Line 739: | ||
|- | |- | ||
| <code><nowiki>{{plural:2|</nowiki>''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></code> | | <code><nowiki>{{plural:2|</nowiki>''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></code> | ||
− | | <code><nowiki>{{plural:0|is|are}}</nowiki></code> → {{plural:0|is|are}}<br /> <code><nowiki>{{plural:1*1|is|are}}</nowiki></code> → {{plural:1*1|is|are}}<br /> <code><nowiki>{{plural:21 mod 10|is|are}}</nowiki></code> → {{plural:21 mod 10|is|are}}<br /> <code><nowiki>{{plural:{{#expr:21 mod 10}}|is|are}}</nowiki></code> → {{plural:{{#expr:21 mod 10}}|is|are}}<br /> <code><nowiki>{{plural:1|is|are}}</nowiki></code> → {{plural:1|is|are}}<br /> <code><nowiki>{{plural:2|is|are}}</nowiki></code> → {{plural:2|is|are}}<br /> (for [[ | + | | <code><nowiki>{{plural:0|is|are}}</nowiki></code> → {{plural:0|is|are}}<br /> <code><nowiki>{{plural:1*1|is|are}}</nowiki></code> → {{plural:1*1|is|are}}<br /> <code><nowiki>{{plural:21 mod 10|is|are}}</nowiki></code> → {{plural:21 mod 10|is|are}}<br /> <code><nowiki>{{plural:{{#expr:21 mod 10}}|is|are}}</nowiki></code> → {{plural:{{#expr:21 mod 10}}|is|are}}<br /> <code><nowiki>{{plural:1|is|are}}</nowiki></code> → {{plural:1|is|are}}<br /> <code><nowiki>{{plural:2|is|are}}</nowiki></code> → {{plural:2|is|are}}<br /> (for [[w:Polish language|Polish]]):<br /><code><nowiki>{{plural:2|milion|miliony|milionów}}</nowiki></code> → miliony |
− | | Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. Its functioning is [[ | + | | Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. Its functioning is [[mw:Help:Magic_words#Language-dependent_word_conversions|language-dependent]]. Plural transformations are used for languages like Russian based on "count mod 10". You should not expect this to handle fractions (like 44.5) — see [[mediazilla:28128|bug 28128]]. |
| | | | ||
|- | |- | ||
| <code><nowiki>{{grammar:N|</nowiki>''noun''<nowiki>}}</nowiki></code> | | <code><nowiki>{{grammar:N|</nowiki>''noun''<nowiki>}}</nowiki></code> | ||
| | | | ||
− | | Outputs the correct inflected form of the given word described by the inflection code after the colon ([[ | + | | Outputs the correct inflected form of the given word described by the inflection code after the colon ([[mw:Help:Magic_words#Language-dependent_word_conversions|language-dependent]]). Grammar transformations are used for inflected languages like Polish. See also [[mw:Manual:$wgGrammarForms|Manual:$wgGrammarForms]]. |
| 1.7+ | | 1.7+ | ||
|- | |- | ||
Line 756: | Line 756: | ||
| <code><nowiki>{{int:</nowiki>''message name''<nowiki>}}</nowiki> | | <code><nowiki>{{int:</nowiki>''message name''<nowiki>}}</nowiki> | ||
| <code><nowiki>{{int:</nowiki>edit<nowiki>}}</nowiki></code> → '''{{int:edit}}''' <br /><small>''(depends on user language; try: [{{fullurl:{{FULLPAGENAME}}|uselang=fr}}#Localisation fr] • [{{fullurl:{{FULLPAGENAME}}|uselang=ja}}#Localisation ja])''</small> | | <code><nowiki>{{int:</nowiki>edit<nowiki>}}</nowiki></code> → '''{{int:edit}}''' <br /><small>''(depends on user language; try: [{{fullurl:{{FULLPAGENAME}}|uselang=fr}}#Localisation fr] • [{{fullurl:{{FULLPAGENAME}}|uselang=ja}}#Localisation ja])''</small> | ||
− | | Internationalizes (translates) the given '''int'''erface (MediaWiki namespace) message into the user language. ''Note that this can damage / confuse cache consistency in MediaWiki 1.17 and earlier, see [[ | + | | Internationalizes (translates) the given '''int'''erface (MediaWiki namespace) message into the user language. ''Note that this can damage / confuse cache consistency in MediaWiki 1.17 and earlier, see [[mediazilla:14404|bug 14404]].'' |
| | | | ||
|- | |- | ||
Line 778: | Line 778: | ||
<code><nowiki>{{#language:ar|en}}</nowiki></code> | <code><nowiki>{{#language:ar|en}}</nowiki></code> | ||
| {{#language:language code}} <br />{{#language:ar}} <br />{{#language:language code|target language code}} <br />Arabic | | {{#language:language code}} <br />{{#language:ar}} <br />{{#language:language code|target language code}} <br />Arabic | ||
− | | The full name of the language for the given [[language code]]: native name (language autonym) by default, name translated in target language if a target language code is specified. | + | | The full name of the language for the given [[mw:language code|language code]]: native name (language autonym) by default, name translated in target language if a target language code is specified. |
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/14490 1.7+] |
− | + | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/91875 1.18+] (translation) | |
|- | |- | ||
| <code><nowiki>{{#special:</nowiki>''special page name''<nowiki>}}</nowiki> <br /><nowiki>{{#special:userlogin}}</nowiki></code> | | <code><nowiki>{{#special:</nowiki>''special page name''<nowiki>}}</nowiki> <br /><nowiki>{{#special:userlogin}}</nowiki></code> | ||
| {{#special:special page name}} <br />{{#special:userlogin}} | | {{#special:special page name}} <br />{{#special:userlogin}} | ||
| The localized name for the given canonical Special: page. | | The localized name for the given canonical Special: page. | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/17321 1.9+] |
|- | |- | ||
| <code><nowiki>{{#speciale:</nowiki>''special page name''<nowiki>}}</nowiki> <br /><nowiki>{{#speciale:userlogin}}</nowiki></code> | | <code><nowiki>{{#speciale:</nowiki>''special page name''<nowiki>}}</nowiki> <br /><nowiki>{{#speciale:userlogin}}</nowiki></code> | ||
| {{#speciale:special page name}} <br />{{#speciale:userlogin}} | | {{#speciale:special page name}} <br />{{#speciale:userlogin}} | ||
| The localized and URL-encoded name for the given canonical Special: page. | | The localized and URL-encoded name for the given canonical Special: page. | ||
− | | | + | | [https://gerrit.wikimedia.org/r/4340 1.20+] |
|- | |- | ||
| <code><nowiki>{{#tag:</nowiki>''tagname'' <br/><nowiki>|</nowiki>''content'' <br/><nowiki>|</nowiki>''attribute1=value1'' <br /><nowiki>|</nowiki>''attribute2=value2''<br /><nowiki>}}</nowiki></code> | | <code><nowiki>{{#tag:</nowiki>''tagname'' <br/><nowiki>|</nowiki>''content'' <br/><nowiki>|</nowiki>''attribute1=value1'' <br /><nowiki>|</nowiki>''attribute2=value2''<br /><nowiki>}}</nowiki></code> | ||
Line 802: | Line 802: | ||
<code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>|</nowiki></code>''Your content goes here''<code><nowiki>|</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code> | <code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>|</nowiki></code>''Your content goes here''<code><nowiki>|</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code> | ||
− | Example for the [[Extension:Cite|Cite extension]]'s <code><ref></code> tags: | + | Example for the [[mw:Extension:Cite|Cite extension]]'s <code><ref></code> tags: |
<code><nowiki>{{#tag:ref|Citation text goes here, and you can include parser functions like {{#expr: ... }} and magic words like {{PAGENAME}}.|name="multiple"}}</nowiki></code> | <code><nowiki>{{#tag:ref|Citation text goes here, and you can include parser functions like {{#expr: ... }} and magic words like {{PAGENAME}}.|name="multiple"}}</nowiki></code> | ||
<small>{{warning}}You must write <code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>||</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code> to pass an empty content. No space is permitted in the area reserved for content between the pipe characters {{!}}{{!}} before ''attribute1''.</small> | <small>{{warning}}You must write <code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>||</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code> to pass an empty content. No space is permitted in the area reserved for content between the pipe characters {{!}}{{!}} before ''attribute1''.</small> | ||
− | | | + | | [http://www.mediawiki.org/wiki/Special:Code/MediaWiki/29482 1.12+] |
|} | |} | ||
Revision as of 19:09, 13 November 2012
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 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 Help:Extension:ParserFunctions.
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.
Contents
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.
Word | Description | Versions |
---|---|---|
Table of contents | ||
__NOTOC__
|
Hides the table of contents (TOC). | |
__FORCETOC__
|
Forces the table of contents to appear at its normal position (above the first header). | |
__TOC__
|
Places a table of contents at the word's current position (overriding __NOTOC__ ). If this is used multiple times, the table of contents will appear at the first word's position.
|
|
Editing | ||
__NOEDITSECTION__
|
Hides the section edit links beside headings. This is especially useful, where a heading is created from within a template: the normal wiki section-edit would in this case edit the template code, which is normally counter-intuitive to the user. If a template contains multiple headings, it may be necessary to add "__NOEDITSECTION__ " after each heading.
|
|
__NEWSECTIONLINK__
|
Adds a link ("+" by default) beside the "edit" tab for adding a new section on a non-talk page (see [[mw:Help:Section#Adding a section at the end|Adding a section to the end). | 1.7+ |
__NONEWSECTIONLINK__
|
Removes the link beside the "edit" tab on pages in talk namespaces. | [1.15+] |
Categories | ||
__NOGALLERY__
|
Used on a category page, replaces thumbnails in the category view with normal links. | 1.7+ |
__HIDDENCAT__
|
Used on a category page, hides the category from the lists of categories in its members and parent categories (there is an option in the user preferences to show them). | 1.13+ |
Language conversion | ||
__NOCONTENTCONVERT__ __NOCC__
|
On wikis with language variants, don't perform any content language conversion (character and phase) in article display; for example, only show Chinese (zh) instead of variants like zh_cn, zh_tw, zh_sg, or zh_hk. | |
__NOTITLECONVERT__ __NOTC__
|
On wikis with language variants, don't perform language conversion on the title (all other content is converted). | |
Other | ||
__START__
|
No effect. | |
__END__
|
Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in 19213. | 1.1–1.8 |
__INDEX__
|
Tell search engines to index the page (overrides $wgArticleRobotPolicies, but not robots.txt). | 1.14+ |
__NOINDEX__
|
Tell search engines not to index the page (i.e. do not list in search engines' results). | 1.14+ |
__STATICREDIRECT__
|
On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title". | 1.13+ |
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 1.19, they depend on the content language.
Variable | Output | Description | Versions |
---|---|---|---|
Year | |||
{{CURRENTYEAR}}
|
2024 | Year | |
Month | |||
{{CURRENTMONTH}}
|
10 | Month (zero-padded number) | |
{{CURRENTMONTHNAME}}
|
October | Month (name) | |
{{CURRENTMONTHNAMEGEN}}
|
October | Month (genitive form) | |
{{CURRENTMONTHABBREV}}
|
Oct | Month (abbreviation) | 1.5+ |
Day | |||
{{CURRENTDAY}}
|
31 | Day of the month (unpadded number) | |
{{CURRENTDAY2}}
|
31 | Day of the month (zero-padded number) | 1.6+ |
{{CURRENTDOW}}
|
4 | Day of the week (unpadded number), 0 (for Sunday) through 6 (for Saturday) | |
{{CURRENTDAYNAME}}
|
Thursday | Day of the week (name) | |
Time | |||
{{CURRENTTIME}}
|
23:16 | Time (24-hour HH:mm format) | |
{{CURRENTHOUR}}
|
23 | Hour (24-hour zero-padded number) | |
Other | |||
{{CURRENTWEEK}}
|
44 | Week (number) | |
{{CURRENTTIMESTAMP}}
|
20241031231633 | YYYYMMDDHHmmss timestamp | 1.7+ |
The following variables do the same as the above, 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.
Variable | Output | Description | Versions |
---|---|---|---|
Site | |||
{{SITENAME}}
|
CHG-Wiki | The wiki's site name ($wgSitename). | |
{{SERVER}}
|
https://wiki.chc.ucsb.edu | Domain URL ($wgServer). | |
{{SERVERNAME}}
|
wiki.chc.ucsb.edu | Domain name (no longer dependent on $wgServerName as of version 1.17). | |
{{DIRMARK}} {{DIRECTIONMARK}}
|
|
Outputs a unicode-directional mark that matches the wiki's default language's direction (‎ on left-to-right wikis, ‏ on right-to-left wikis), useful in text with multi-directional text. Since 1.19, it depends on the page content language.
|
1.7+ |
{{SCRIPTPATH}}
|
Relative script path ($wgScriptPath). | ||
{{STYLEPATH}}
|
/skins | Relative style path ($wgStylePath). | 1.16+ |
{{CURRENTVERSION}}
|
1.34.0 | The wiki's MediaWiki version. | 1.7+ |
{{CONTENTLANGUAGE}} {{CONTENTLANG}}
|
en en |
The wiki's default interface language ($wgLanguageCode). | 1.7+ |
Page | |||
{{PAGEID}}
|
22 | Returns the page identifier. | 1.20+ |
{{PAGESIZE:page name}} {{PAGESIZE:page name|R}}
|
47,539 47539 |
[Expensive] Returns the byte size of the specified page. Use "|R " to get raw (unformatted) numbers.
|
1.13+ |
{{PROTECTIONLEVEL:action}}
|
Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the current page or an empty string if not protected. | 1.15+ | |
Latest revision to current page | |||
{{REVISIONID}}
|
422 | Unique revision ID. | 1.5+ |
{{REVISIONDAY}}
|
13 | Day edit was made (unpadded number). | 1.8+ |
{{REVISIONDAY2}}
|
13 | Day edit was made (zero-padded number). | 1.8+ |
{{REVISIONMONTH}}
|
11 | Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions). | 1.8+ |
{{REVISIONMONTH1}}
|
11 | Month edit was made (unpadded number). | 1.17+ |
{{REVISIONYEAR}}
|
2012 | Year edit was made. | 1.8+ |
{{REVISIONTIMESTAMP}}
|
20121113190936 | Timestamp as of time of edit. | 1.8+ |
{{REVISIONUSER}}
|
Libby | The username of the user who made the most recent edit to the page, or the current user when previewing an edit. | 1.15+ |
Affects page content | |||
{{DISPLAYTITLE:title}}
|
Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores are allowed (this can be changed with $wgRestrictDisplayTitle). It can be disabled or enabled by $wgAllowDisplayTitle; disabled by default before 1.10+, enabled by default thereafter. | 1.7+ | |
{{DEFAULTSORT:sortkey}} {{DEFAULTSORTKEY:sortkey}} {{DEFAULTCATEGORYSORT:sortkey}} {{DEFAULTSORT:sortkey|noerror}} {{DEFAULTSORT:sortkey|noreplace}}
|
Used for categorizing pages, sets a default category sort key. For example if you put {{DEFAULTSORT:Smith, John}} at the end of John Smith, the page would be sorted under "S" by default in categories. It can take a second argument of noerror or noreplace to suppress error messages when multiple defaultsortkeys are used on one page or to make it do nothing if multiple defaultsortkeys are used.
|
1.10+ 1.19+ (for noerror and noreplace) |
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}}
→ 376 and {{NUMBEROFPAGES:R}}
→ 376). 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 1.19, it depends on the mw:Page_Content_Language:page content language.
Variable | Output | Description | Versions |
---|---|---|---|
Entire wiki | |||
{{NUMBEROFPAGES}}
|
376 | Number of wiki pages. | 1.7+ |
{{NUMBEROFARTICLES}}
|
51 | content namespaces]]. | |
{{NUMBEROFFILES}}
|
62 | Number of uploaded files. | 1.5+ |
{{NUMBEROFEDITS}}
|
109,943 | Number of page edits. | 1.10+ |
{{NUMBEROFVIEWS}}
|
Template:NUMBEROFVIEWS | Number of page views. Usually useless on a wiki using caching. | 1.14+ |
{{NUMBEROFUSERS}}
|
26 | Number of registered users. | 1.7+ |
{{NUMBEROFADMINS}}
|
6 | Number of users in the sysop group. | 1.7+ |
{{NUMBEROFACTIVEUSERS}}
|
0 | Number of active users, based on the criteria used in Special:Statistics. | 1.15+ |
{{PAGESINCATEGORY:categoryname}} {{PAGESINCAT:categoryname}}
|
49 49 |
[Expensive] Number of pages (including any subcategories and files) in the given category. | 1.13+ |
{{PAGESINCATEGORY:categoryname|all}} {{PAGESINCATEGORY:categoryname|pages}} {{PAGESINCATEGORY:categoryname|subcats}} {{PAGESINCATEGORY:categoryname|files}}
|
49 49 0 0 |
[Expensive] Respectively, the number of
in the given category. |
1.20+ |
{{NUMBERINGROUP:groupname}} {{NUMINGROUP:groupname}}
|
5 5 ({{NUMBERINGROUP:bureaucrat}} used here) |
Number of users in a specific group. | 1.14+ |
{{PAGESINNS:index}} {{PAGESINNAMESPACE:index}}
|
Not enabled | Number of pages in the given namespace (replace index with the relevant namespace index). For instance, {{PAGESINNAMESPACE:14}} will output the number of category pages. {{PAGESINNS:0}} differs from {{NUMBEROFARTICLES}} in that the former includes redirects and disambiguation pages. Disabled by default, enable with $wgAllowSlowParserFunctions.
|
1.7+ |
Page names
Variable | Output | Description | Versions |
---|---|---|---|
{{FULLPAGENAME}}
|
Help:Magic words | Namespace and page title. | 1.6+ |
{{PAGENAME}}
|
Magic words | Page title. | |
{{BASEPAGENAME}}
|
Magic words | Page title excluding the current subpage and namespace ("Title/foo" on "Title/foo/bar").
For more complex splitting, use |
1.7+ |
{{SUBPAGENAME}}
|
Magic words | The subpage title ("foo" on "Title/foo"). | 1.6+ |
{{SUBJECTPAGENAME}} {{ARTICLEPAGENAME}}
|
Help:Magic words Help:Magic words |
The namespace and title of the associated subject page. | 1.7+ |
{{TALKPAGENAME}}
|
Help talk:Magic words | The namespace and title of the associated talk page. | 1.7+ |
The {{BASEPAGENAME}}
and {{SUBPAGENAME}}
magic words only work in namespaces that have subpages enabled. See $wgNamespacesWithSubpages for information on enabling subpages.
As of 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
Warning:
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
Variable | Output | Description | Versions |
---|---|---|---|
{{NAMESPACE}}
|
Help | Name of the page's namespace | |
{{NAMESPACENUMBER}}
|
12 | ID of the page's namespace | 1.20+ |
{{SUBJECTSPACE}} {{ARTICLESPACE}}
|
Help Help |
Name of the associated content namespace | 1.7+ |
{{TALKSPACE}}
|
Help talk | Name of the associated talk namespace | 1.7+ |
The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded):
{{NAMESPACEE}}
- {{SUBJECTSPACEE}}
{{TALKSPACEE}}
As of 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}}
→ '
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 [[mw:Extension:ParserFunctions|ParserFunctions extension}}. For those see Help:Extension:ParserFunctions.
URL data
Parser function | Input → Output | Description | Versions |
---|---|---|---|
{{localurl:page name}} {{localurl:page name|query_string}}
|
{{localurl:MediaWiki}} → /MediaWiki{{localurl:MediaWiki|printable=yes}} → /index.php?title=MediaWiki&printable=yes
|
The relative path to the title. | |
{{fullurl:page name}} {{fullurl:page name|query_string}} {{fullurl:interwiki:remote page name|query_string}}
|
{{fullurl:Category:Top level}} → https://wiki.chc.ucsb.edu/Category:Top_level
|
A protocol-relative path to the title. This will also resolve interwiki prefixes. Note: Unbracketed (plain) protocol-relative links are not automagically linked. | 1.5+ |
{{canonicalurl:page name}} {{canonicalurl:page name|query_string}} {{canonicalurl:interwiki:remote page name|query_string}}
|
{{canonicalurl:Category:Top level}} → https://wiki.chc.ucsb.edu/Category:Top_level
|
The absolute path to the title, using the canonical URL. This will also resolve Interwiki prefixes. | 1.18+ |
{{filepath:file name}} {{filepath:file name|nowiki}} {{filepath:file name|thumbnail_size}}
|
{{filepath:Wiki.png}} → https://wiki.chc.ucsb.edu/images/b/bc/Wiki.png
|
A protocol-relative path to the full size or thumbnail (1.18+) of a media file. | 1.12+ 1.18+ |
{{urlencode:string}} (or {{urlencode:string|QUERY}} ){{urlencode:string|WIKI}} {{urlencode:string|PATH}}
|
{{urlencode:x y z á é}} (or {{urlencode:x y z á é|QUERY}}) → x+y+z+%C3%A1+%C3%A9{{urlencode:x y z á é|WIKI}} → x_y_z_%C3%A1_%C3%A9{{urlencode:x y z á é|PATH}} → x%20y%20z%20%C3%A1%20%C3%A9
Note that the default changed from |
The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete Extension:StringFunctions. | 1.7+ (or 1.17+) 1.17+ 1.17+ |
{{anchorencode:string}}
|
{{anchorencode:x y z á é}} → x_y_z_.C3.A1_.C3.A9
|
The input encoded for use in URL section anchors (after the “#” symbol in a URL). | 1.8+ |
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 was French, {{ns:Fichier}}
would also be valid, but {{ns:Datei}}
(the localisation of "File" into German) would 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.
Content namespaces | Talk namespaces | |||
---|---|---|---|---|
Usage | Output | Usage | Output | |
{{ns:-2}} or {{ns:Media}}
|
Media | |||
{{ns:-1}} or {{ns:Special}}
|
Special | |||
{{ns:0}} or {{ns:}}
|
{{ns:1}} or {{ns:Talk}}
|
Talk | ||
{{ns:2}} or {{ns:User}}
|
User | {{ns:3}} or {{ns:User talk}}
|
User talk | |
{{ns:4}} or {{ns:Project}}
|
CHG-Wiki | {{ns:5}} or {{ns:Project talk}}
|
CHG-Wiki talk | |
{{ns:6}} or {{ns:File}} or {{ns:Image}}
|
File | {{ns:7}} or {{ns:File talk}} or {{ns:Image talk}}
|
File talk | |
{{ns:8}} or {{ns:MediaWiki}}
|
MediaWiki | {{ns:9}} or {{ns:MediaWiki talk}}
|
MediaWiki talk | |
{{ns:10}} or {{ns:Template}}
|
Template | {{ns:11}} or {{ns:Template talk}}
|
Template talk | |
{{ns:12}} or {{ns:Help}}
|
Help | {{ns:13}} or {{ns:Help talk}}
|
Help talk | |
{{ns:14}} or {{ns:Category}}
|
Category | {{ns:15}} or {{ns:Category talk}}
|
Category talk |
Formatting
Usage | Input → Output | Description | Version |
---|---|---|---|
{{formatnum:unformatted num}} {{formatnum:formatnum-formatted num|R}}
|
{{formatnum:987654321.654321}} → 987,654,321.654321
Unsupported: Examples of wrong input (unreliable output), with or without |
Takes an unformatted number (arab, no group separators and . as decimal separator) and outputs it in the localized digit script and formatted with decimal and decimal group separators, according to the wiki's default locale. The If you really need to format (according the wiki's locale) a number in unknown input format, you could try and use |
1.7+ 1.13+ |
|
|
Formats an unlinked date based on user "Date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: mdy , dmy , ymd , ISO 8601 (all case sensitive). If only the month and day are given, only mdy and dmy are valid. If a format is not specified or is invalid, the input format is used as a default. If the supplied date is not recognized as a valid date (specifically, if it contains any metadata such as from a nested use of these or similar templates), it is rendered unchanged, and no (additional) metadata is generated. Warning: Although the ISO 8601 standard requires that dates be in the Gregorian calendar, the ISO parameter in this function will still format dates that fall outside the usual Gregorian range (e.g. dates prior to 1583). Also, the magic word cannot properly convert between negative years (used with ISO 8601) and years BC or years BCE (used in general writing). |
1.15+ |
{{lc:string}}
|
{{lc:DATA CENTER}} → data center
|
The lowercase input. | 1.5+ |
{{lcfirst:string}}
|
{{lcfirst:DATA center}} → dATA center
|
The input with the very first character lowercase. | 1.5+ |
{{uc:string}}
|
{{uc:text transform}} → TEXT TRANSFORM
|
The uppercase input. | 1.5+ |
{{ucfirst:string}}
|
{{ucfirst:text TRANSFORM}} → Text TRANSFORM
|
The input with the very first character uppercase. | 1.5+ |
{{padleft:xyz|stringlength}} {{padleft:xyz|strlen|char}} {{padleft:xyz|strlen|string}}
|
{{padleft:xyz|5}} → 00xyz{{padleft:xyz|5|_}} → __xyz {{padleft:xyz|5|abc}} → abxyz {{padleft:xyz|2}} → xyz{{padleft:|1|xyz}} → x (first character of the string) |
Inserts a string of padding characters (character chosen in third parameter; default "0") of a specified length (second parameter) next to a chosen base character or variable (first parameter). The final digits or characters in the base replace the final characters in the padding; i.e. {{padleft:44|3|0}} produces 044. The padding string may be truncated if its length does not evenly divide the required number of characters. [[mediazilla:16852|Bug}} (fixed in r45734): multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters. |
1.8+ |
{{padright:xyz|stringlength}} {{padright:xyz|strlen|char}} {{padright:xyz|strlen|string}}
|
{{padright:xyz|5}} → xyz00
|
Identical to padleft, but adds padding characters to the right side. |
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.
Usage | Input → Output | Description | Version |
---|---|---|---|
{{plural:2|is|are}}
|
{{plural:0|is|are}} → are{{plural:1*1|is|are}} → is{{plural:21 mod 10|is|are}} → are{{plural:{{#expr:21 mod 10}}|is|are}} → is{{plural:1|is|are}} → is{{plural:2|is|are}} → are(for Polish): {{plural:2|milion|miliony|milionów}} → miliony
|
Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. Its functioning is language-dependent. Plural transformations are used for languages like Russian based on "count mod 10". You should not expect this to handle fractions (like 44.5) — see bug 28128. | |
{{grammar:N|noun}}
|
Outputs the correct inflected form of the given word described by the inflection code after the colon (language-dependent). Grammar transformations are used for inflected languages like Polish. See also Manual:$wgGrammarForms. | 1.7+ | |
{{gender:username
|
(Depends on the named user's gender) | A switch for the gender set in Special:Preferences. Note: If 3rd parameter is omitted and user hasn't defined his/her gender, then |
1.15+ |
{{int:message name}}
|
{{int:edit}} → Edit (depends on user language; try: fr • ja) |
Internationalizes (translates) the given interface (MediaWiki namespace) message into the user language. Note that this can damage / confuse cache consistency in MediaWiki 1.17 and earlier, see bug 14404. | |
{{int:editsectionhint|MediaWiki}}
|
{{int:editsectionhint|MediaWiki}} → Edit section: MediaWiki
|
You may also use parameters with translations. Parameters are designated in messages with: $1, $2, $3, etc. For example, here is the message for editsectionhint: Edit section: $1 In this example, MediaWiki replaces $1. |
Miscellaneous
Usage | Output | Description | Version |
---|---|---|---|
{{#language:language code}}
|
language code العربية language code Arabic |
The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a target language code is specified. | 1.7+
1.18+ (translation) |
{{#special:special page name}}
|
Special:Special page name Special:UserLogin |
The localized name for the given canonical Special: page. | 1.9+ |
{{#speciale:special page name}}
|
Special:Special_page_name Special:UserLogin |
The localized and URL-encoded name for the given canonical Special: page. | 1.20+ |
{{#tag:tagname
|
(Depends on parser tag) | Alias for XML-style MediaWiki parser tags or extension tags. It allows execution of wiki code and parser functions within tags before the tag is processed. It also prevents parsing of tags in conditional paths that aren't executed (like in #if statements). Content between tags is passed as the first parameter, and any attributes for the tags can be passed as subsequent parameters. This example:
…can be rewritten like this:
Example for the Cite extension's
Warning: You must write |
1.12+ |
Language: | English |
---|