Actions

Help

Difference between revisions of "Magic words"

From OPOSSEM

m (alternate → alternative per WP:COMMONALITY)
m (1 revision)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Shortcut|WP:MAGIC}}
+
'''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 {{Mediawiki|Manual:Magic words}}.
  
−
'''Magic words''' (which include '''parser functions''', '''variables''' and '''behavior switches''')  are features of [[WP:wikitext|wikitext]] that enable various instructions to be given to the [[Help:MediaWiki|MediaWiki]] software (for example, to suppress or position the table of contents), or else serve to produce variable output, as is often required in [[WP:Templates|templates]].
+
There are three general types of magic words:
 +
*'''[[#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]].
 +
*'''[[#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 {{mediawiki|Help:Extension:ParserFunctions}}.
  
−
A quick reference for magic words can be found on this page. For more complete and updated documentation, refer to the following pages on the MediaWiki site:
+
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.
−
*'''[[mw:Help:Magic words]]''' for all standard magic words, including the "standard" parser functions
 
−
*'''[[mw:Help:Extension:ParserFunctions]]''' for some additional parser functions, including conditional expressions
 
  
−
==General information==
+
==Behavior switches==
−
There are three types of magic words:
+
A behavior switch controls the layout or behaviour of the page and can often be used to specify desired omissions and inclusions in the content.
−
*'''Behavior switches:''' uppercase words surrounded by double underscores, e.g. <tt><nowiki>__NOTOC__</nowiki></tt>, or keywords using parser function syntax
+
 
−
*'''Variables:''' uppercase words surrounded by double braces, e.g. <tt><nowiki>{{PAGENAME}}</nowiki></tt> (thus resembling [[Help:Templates|templates]])
+
{| class="wikitable"
−
*'''Parser functions:''' keywords (some beginning #) in double braces with parameters after a colon, e.g. <tt><nowiki>{{#expr:2+2}}</nowiki></tt>
+
|-
 +
! {{Hl2}}| Word
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
! {{Hl3}} colspan="3"| '''Table of contents'''
 +
|-
 +
| <code><nowiki>__NOTOC__</nowiki></code>
 +
| Hides the table of contents (TOC).
 +
|
 +
|-
 +
| <code><nowiki>__FORCETOC__</nowiki></code>
 +
| Forces the table of content to appear at its normal position (above the first header).
 +
|
 +
|-
 +
| <code><nowiki>__TOC__</nowiki></code>
 +
| Places a table of contents at the word's current position (overriding <code><nowiki>__NOTOC__</nowiki></code>). If this is used multiple times, the table of contents will appear at the first word's position.
 +
|
 +
|-
 +
! {{Hl3}} colspan="3"| '''Editing'''
 +
|-
 +
| <code><nowiki>__NOEDITSECTION__</nowiki></code>
 +
| Hides the section edit links beside headings.
 +
|
 +
|-
 +
| <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 {{mediawiki|m:Help:Section#Adding a section at the end|Adding a section to the end}}).
 +
| 1.7+
 +
|-
 +
| <code><nowiki>__NONEWSECTIONLINK__</nowiki></code>
 +
| Removes the link beside the "edit" tab on pages in talk namespaces.
 +
| {{mediawiki|rev:47522|1.15+}}
 +
|-
 +
! {{Hl3}} colspan="3"| '''Categories'''
 +
|-
 +
| <code><nowiki>__NOGALLERY__</nowiki></code>
 +
| Used on a category page, replaces thumbnails in the category view with normal links.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>__HIDDENCAT__</nowiki></code>
 +
| 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 [[Help:Preferences|user preferences]] to show them).<!-- hiddencategory hiddencat hide category categories -->
 +
| 1.13+
 +
|-
 +
! {{Hl3}} colspan="3"| '''Language conversion'''
 +
|-
 +
| <code><nowiki>__NOCONTENTCONVERT__</nowiki></code> <br /> <code><nowiki>__NOCC__</nowiki></code>
 +
| 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.
 +
|
 +
|-
 +
| <code><nowiki>__NOTITLECONVERT__</nowiki></code> <br /> <code><nowiki>__NOTC__</nowiki></code>
 +
| On wikis with language variants, don't perform language conversion on the title (all other content is converted).
 +
|
 +
|-
 +
! {{Hl3}} colspan="3"| '''Other'''
 +
|-
 +
| <code><nowiki>__START__</nowiki></code>
 +
| No effect.
 +
|
 +
|-
 +
| <code><nowiki>__END__</nowiki></code>
 +
| Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in {{mediawiki|rev:19213|19213}}.
 +
| 1.1–1.8
 +
|-
 +
| <code><nowiki>__INDEX__</nowiki></code>
 +
| Tell search engines to index the page (overrides {{mediawiki|Manual:$wgArticleRobotPolicies|$wgArticleRobotPolicies}}, but not robots.txt).
 +
| 1.14+
 +
|-
 +
| <code><nowiki>__NOINDEX__</nowiki></code>
 +
| Tell search engines not to index the page (ie, do not list in search engines' results).
 +
| {{mediawiki|rev:37973|1.14+}}
 +
|-
 +
| <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".
 +
| {{mediawiki|rev:37928|1.13+}}
 +
|}
 +
 
 +
==Variables==
 +
Variables return information about the current page, wiki, or date. Their syntax is similar to [[Help:Templates|templates]]. Variables marked as "<span style="background:#FED;">'''[expensive]'''</span>" 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 [[{{ns:10}}:PAGENAME]] you would need to write <code><nowiki>{{</nowiki>{{ns:10}}:PAGENAME<nowiki>}}</nowiki></code>). In some cases, adding parameters will force the parser to invoke a template; for example, <code><nowiki>{{CURRENTDAYNAME|x}}</nowiki></code> transcludes [[{{ns:10}}: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.
  
−
Some magic words are case-insensitive, but not all. Whitespace is stripped from the start and end of keywords and parameters, as in template syntax.
+
{| class="wikitable"
 +
|-
 +
! {{Hl2}}| Variable
 +
! {{Hl2}}| Output
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
! {{Hl3}} colspan="4"| '''Year'''
 +
|-
 +
| <code><nowiki>{{CURRENTYEAR}}</nowiki></code>
 +
| {{CURRENTYEAR}}
 +
| Year
 +
|
 +
|-
 +
! {{Hl3}} colspan="4"| '''Month'''
 +
|-
 +
| <code><nowiki>{{CURRENTMONTH}}</nowiki></code>
 +
| {{CURRENTMONTH}}
 +
| Month (zero-padded number)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTMONTHNAME}}</nowiki></code>
 +
| {{CURRENTMONTHNAME}}
 +
| Month (name)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTMONTHNAMEGEN}}</nowiki></code>
 +
| {{CURRENTMONTHNAMEGEN}}
 +
| Month ([[wikipedia:genitive|genitive form]])
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTMONTHABBREV}}</nowiki></code>
 +
| {{CURRENTMONTHABBREV}}
 +
| Month (abbreviation)
 +
| 1.5+
 +
|-
 +
! {{Hl3}} colspan="4"| '''Day'''
 +
|-
 +
| <code><nowiki>{{CURRENTDAY}}</nowiki></code>
 +
| {{CURRENTDAY}}
 +
| Day of the month (unpadded number)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTDAY2}}</nowiki></code>
 +
| {{CURRENTDAY2}}
 +
| Day of the month (zero-padded number)
 +
| 1.6+
 +
|-
 +
| <code><nowiki>{{CURRENTDOW}}</nowiki></code>
 +
| {{CURRENTDOW}}
 +
| Day of the week (unpadded number)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTDAYNAME}}</nowiki></code>
 +
| {{CURRENTDAYNAME}}
 +
| Day of the week (name)
 +
|
 +
|-
 +
! {{Hl3}} colspan="4"| '''Time'''
 +
|-
 +
| <code><nowiki>{{CURRENTTIME}}</nowiki></code>
 +
| {{CURRENTTIME}}
 +
| Time (24-hour HH:mm format)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTHOUR}}</nowiki></code>
 +
| {{CURRENTHOUR}}
 +
| Hour (24-hour zero-padded number)
 +
|
 +
|-
 +
! {{Hl3}} colspan="4"| '''Other'''
 +
|-
 +
| <code><nowiki>{{CURRENTWEEK}}</nowiki></code>
 +
| {{CURRENTWEEK}}
 +
| Week (number)
 +
|
 +
|-
 +
| <code><nowiki>{{CURRENTTIMESTAMP}}</nowiki></code>
 +
| {{CURRENTTIMESTAMP}}
 +
| YYYYMMDDHHmmss timestamp
 +
| 1.7+
 +
|}
  
−
Page-dependent magic words will affect or return data about the ''current'' page, even if the word is added through a transcluded template or included system message.
+
The following variables do the same as the above, but using the site's server config or $wgLocaltimezone.
 +
* <code><nowiki>{{LOCALYEAR}}</nowiki></code>
 +
* <code><nowiki>{{LOCALMONTH}}</nowiki></code>
 +
* <code><nowiki>{{LOCALMONTHNAME}}</nowiki></code>
 +
* <code><nowiki>{{LOCALMONTHNAMEGEN}}</nowiki></code>
 +
* <code><nowiki>{{LOCALMONTHABBREV}}</nowiki></code>
 +
* <code><nowiki>{{LOCALDAY}}</nowiki></code>
 +
* <code><nowiki>{{LOCALDAY2}}</nowiki></code>
 +
* <code><nowiki>{{LOCALDOW}}</nowiki></code>
 +
* <code><nowiki>{{LOCALDAYNAME}}</nowiki></code>
 +
* <code><nowiki>{{LOCALTIME}}</nowiki></code>
 +
* <code><nowiki>{{LOCALHOUR}}</nowiki></code>
 +
* <code><nowiki>{{LOCALWEEK}}</nowiki></code>
 +
* <code><nowiki>{{LOCALTIMESTAMP}}</nowiki></code>
  
−
It is possible to [[Help:Substitution|substitute]] parser functions and variables in the same way that templates are substituted (using the <tt>subst:</tt> keyword). This causes their current value (as evaluated at the time of substitution) to be written into the wikitext.
+
:''For more thorough time formatting, you may want to install [[Extension:ParserFunctions]] to use the [[Help:Extension:ParserFunctions#.23time|#time parser function]]''
  
−
==Behavior switches==
+
===Technical metadata===
−
''For documentation, refer to the [[mw:Help:Magic words#Behavior switches|Behavior Switches]] section of the MediaWiki page.''
+
''Note:'' Revision variables return data about the '''latest edit to the current page''', even if viewing an older version of the page.
−
*<tt><nowiki>__NOTOC__</nowiki></tt> (can appear anywhere in the wikitext; suppresses the table of contents)
+
{| class="wikitable"
−
*<tt><nowiki>__FORCETOC__</nowiki></tt> (can appear anywhere in the wikitext; makes a table of contents appear in its normal position above the first header)
+
|-
−
*<tt><nowiki>__TOC__</nowiki></tt> (places a table of contents at the word's position)
+
! {{Hl2}}| Variable
 +
! {{Hl2}}| Output
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
! {{Hl3}} colspan="4"| '''Site'''
 +
|-
 +
| <code><nowiki>{{SITENAME}}</nowiki></code>
 +
| {{SITENAME}}
 +
| The wiki's site name ({{mediawiki|Manual:$wgSitename|$wgSitename}}).
 +
|
 +
|-
 +
| <code><nowiki>{{SERVER}}</nowiki></code>
 +
| {{SERVER}}
 +
| domain URL ({{mediawiki|Manual:$wgServer|$wgServer}})
 +
|
 +
|-
 +
| <code><nowiki>{{SERVERNAME}}</nowiki></code>
 +
| {{SERVERNAME}}
 +
| domain name (No longer dependent on {{mediawiki|Manual:$wgServerName|$wgServerName}} as of version 1.17)
 +
|
 +
|-
 +
| <code><nowiki>{{DIRMARK}}</nowiki></code><br /><code><nowiki>{{DIRECTIONMARK}}</nowiki></code>
 +
| {{DIRMARK}}<br />{{DIRECTIONMARK}}
 +
| Outputs a unicode-directional mark that matches the wiki's default language's direction (<code>&amp;lrm;</code> on left-to-right wikis, <code>&amp;rlm;</code> on right-to-left wikis), useful in text with multi-directional text.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{SCRIPTPATH}}</nowiki></code>
 +
| {{SCRIPTPATH}}
 +
| relative script path ({{mediawiki|Manual:$wgScriptPath|$wgScriptPath}})
 +
|
 +
|-
 +
| <code><nowiki>{{STYLEPATH}}</nowiki></code>
 +
| {{STYLEPATH}}
 +
| relative style path ({{mediawiki|Manual:$wgStylePath|$wgStylePath}})
 +
| 1.16+
 +
|-
 +
| <code><nowiki>{{CURRENTVERSION}}</nowiki></code>
 +
| {{CURRENTVERSION}}
 +
| The wiki's MediaWiki version.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{CONTENTLANGUAGE}}</nowiki></code><br /><code><nowiki>{{CONTENTLANG}}</nowiki></code>
 +
| {{CONTENTLANGUAGE}}<br />{{CONTENTLANG}}
 +
| The wiki's default interface language ({{mediawiki|Manual:$wgLanguageCode|$wgLanguageCode}})
 +
| 1.7+
 +
|-
 +
! {{Hl3}} colspan="4"| '''Latest revision to current page'''
 +
|-
 +
| <code><nowiki>{{REVISIONID}}</nowiki></code>
 +
| {{REVISIONID}}
 +
| Unique revision ID
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
 +
| {{REVISIONDAY}}
 +
| Day edit was made (unpadded number)
 +
| 1.8+
 +
|-
 +
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
 +
| {{REVISIONDAY2}}
 +
| Day edit was made (zero-padded number)
 +
| 1.8+
 +
|-
 +
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
 +
| {{REVISIONMONTH}}
 +
| Month edit was made (zero-padded number as of {{mediawiki|rev:66200|1.17+}}, unpadded number in prior versions)
 +
| 1.8+
 +
|-
 +
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
 +
| {{REVISIONYEAR}}
 +
| Year edit was made
 +
| 1.8+
 +
|-
 +
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
 +
| {{REVISIONTIMESTAMP}}
 +
| Timestamp as of time of edit
 +
| 1.8+
 +
|-
 +
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
 +
| {{REVISIONUSER}}
 +
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit
 +
| {{mediawiki|rev:48149|1.15+}}
 +
|-style="background:#FED;"
 +
| <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}}
 +
| '''[expensive]''' Returns the byte size of the specified page. Use "<code><nowiki>|R</nowiki></code>" to get raw numbers.
 +
| {{mediawiki|rev:33551|1.13+}}
 +
|-
 +
| <code><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></code>
 +
| protection level
 +
| Outputs the protection level (e.g. 'autoconfirm', 'sysop') for a given action (e.g. 'edit', 'move') on the current page or an empty string if not protected.
 +
| {{mediawiki|rev:45587|1.15+}}
 +
|-
 +
! {{Hl3}} colspan="4"| '''Affects page content'''
 +
|-
 +
| <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. It can be disabled or enabled by {{mediawiki|Manual:$wgAllowDisplayTitle|$wgAllowDisplayTitle}}; disabled by default before 1.10+, enabled by default thereafter.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>}}</nowiki></code><br /><code><nowiki>{{DEFAULTSORTKEY:</nowiki>''sortkey''<nowiki>}}</nowiki></code><br /><code><nowiki>{{DEFAULTCATEGORYSORT:</nowiki>''sortkey''<nowiki>}}</nowiki></code>
 +
|
 +
| 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.
 +
| 1.10+
 +
|}
 +
 
 +
===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, <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code> &rarr; {{NUMBEROFPAGES}} and <code><nowiki>{{NUMBEROFPAGES:R}}</nowiki></code> &rarr; {{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>). Also applicable to <code><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></code> above.
 +
{| class="wikitable"
 +
|-
 +
! {{Hl2}}| Variable
 +
! {{Hl2}}| Output
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
! {{Hl3}} colspan="4"| '''Entire wiki'''
 +
|-
 +
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
 +
| {{NUMBEROFPAGES}}
 +
| Number of wiki pages.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
 +
| {{NUMBEROFARTICLES}}
 +
| Number of pages in {{mediawiki|Manual:Using custom namespaces#Content namespaces|content namespaces}}.
 +
|
 +
|-
 +
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
 +
| {{NUMBEROFFILES}}
 +
| Number of uploaded files.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
 +
| {{NUMBEROFEDITS}}
 +
| Number of page edits.
 +
| {{mediawiki|rev:21319|1.10+}}
 +
|-
 +
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
 +
| {{NUMBEROFVIEWS}}
 +
| Number of page views. Usually useless on a wiki using [[Manual:Cache|caching]].
 +
| {{mediawiki|rev:42721|1.14+}}
 +
|-
 +
| <code><nowiki>{{NUMBEROFUSERS}}</nowiki></code>
 +
| {{NUMBEROFUSERS}}
 +
| Number of registered users.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{NUMBEROFADMINS}}</nowiki></code>
 +
| {{NUMBEROFADMINS}}
 +
| Number of users in the ''sysop'' {{mediawiki|Manual:User rights|group}}.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></code>
 +
| {{NUMBEROFACTIVEUSERS}}
 +
| Number of active users, based on the criteria used in [[Special:Statistics]].
 +
| {{mediawiki|rev:47392|1.15+}}
 +
|-style="background:#FED;"
 +
| <code><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINCAT:Help}}</nowiki></code>
 +
| {{PAGESINCATEGORY:Help}}<br />{{PAGESINCAT:Help}}
 +
| '''[expensive]''' Number of pages in the given [[Help:Categories|category]].
 +
| {{mediawiki|rev:32932|1.13+}}
 +
|-
 +
| <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>
 +
| Number of users in a specific {{mediawiki|Manual:User rights|group}}.
 +
| {{mediawiki|rev:40116|1.14+}}
 +
|-
 +
| <code><nowiki>{{PAGESINNS:</nowiki>''index''<nowiki>}}</nowiki></code><br /><code><nowiki>{{PAGESINNAMESPACE:</nowiki>''index''<nowiki>}}</nowiki></code>
 +
| ''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 {{mediawiki|Manual:$wgAllowSlowParserFunctions|$wgAllowSlowParserFunctions}}.
 +
| 1.7+
 +
|}
 +
 
 +
===Page names===
 +
{| class="wikitable"
 +
|-
 +
! {{Hl2}}| Variable
 +
! {{Hl2}}| Output
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
| <code><nowiki>{{FULLPAGENAME}}</nowiki></code>
 +
| {{FULLPAGENAME}}
 +
| Namespace and page title.
 +
| 1.6+
 +
|-
 +
| <code><nowiki>{{PAGENAME}}</nowiki></code>
 +
| {{PAGENAME}}
 +
| Page title.
 +
|
 +
|-
 +
| <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
 +
| {{BASEPAGENAME}}
 +
| 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]].
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{SUBPAGENAME}}</nowiki></code>
 +
| {{SUBPAGENAME}}
 +
| The [[Help:Subpages|subpage]] title ("foo" on "Title/foo").
 +
| 1.6+
 +
|-
 +
| <code><nowiki>{{SUBJECTPAGENAME}}</nowiki></code>
 +
| {{SUBJECTPAGENAME}}
 +
| The namespace and title of the associated subject page.
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{TALKPAGENAME}}</nowiki></code>
 +
| {{TALKPAGENAME}}
 +
| The namespace and title of the associated talk page.
 +
| 1.7+
 +
|}
  
−
*<tt><nowiki>__NOEDITSECTION__</nowiki></tt> (hides the section "edit" links beside headings)
+
The <code><nowiki>{{BASEPAGENAME}}</nowiki></code> and <code><nowiki>{{SUBPAGENAME}}</nowiki></code> magic words only work in namespaces that have subpages enabled.  See {{mediawiki|Manual:$wgNamespacesWithSubpages}} for information on enabling subpages.
−
*<tt><nowiki>__NEWSECTIONLINK__</nowiki></tt> (adds a "+" link for adding a new section on a non-"Talk" page)
 
−
*<tt><nowiki>__NONEWSECTIONLINK__</nowiki></tt> (removes the "+" link on "Talk" pages)
 
  
−
*<tt><nowiki>__NOGALLERY__</nowiki></tt> (on a category page, replaces thumbnails with normal links)
+
The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters [[wikipedia:percent-encoding|percent-encoded]]):
−
*<tt><nowiki>__HIDDENCAT__</nowiki></tt> (on a category page, makes it a [[WP:HIDDENCAT|hidden category]])
+
* <code><nowiki>{{FULLPAGENAMEE}}</nowiki></code>
−
*<tt><nowiki>__INDEX__</nowiki></tt> (tells search engines to index the page)
+
* <code><nowiki>{{PAGENAMEE}}</nowiki></code>
−
*<tt><nowiki>__NOINDEX__</nowiki></tt> (tells search engines not to index the page)
+
* <code><nowiki>{{BASEPAGENAMEE}}</nowiki></code>
 +
* <code><nowiki>{{SUBPAGENAMEE}}</nowiki></code>
 +
* <code><nowiki>{{SUBJECTPAGENAMEE}}</nowiki></code>
 +
* <code><nowiki>{{TALKPAGENAMEE}}</nowiki></code>
  
−
*<tt><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></tt> (changes the [[WP:DISPLAYTITLE|displayed form]] of the page title)
+
As of {{mediawiki|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:
−
*<tt><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>}}</nowiki></tt> (sets a default category [[WP:SORTKEY|sort key]])
+
* <code><nowiki>{{PAGENAME:Template:Main Page}}</nowiki></code> &rarr; '''{{PAGENAME:Template:Main Page}}'''
  
−
==Variables==
+
{{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 {{mediawiki|bugzilla:14779|14779}}, {{mediawiki|bugzilla:16474|16474}}.}}
−
''For documentation, refer to the [[mw:Help:Magic words#Variables|Variables]] section of the MediaWiki page.''
 
−
*<tt><nowiki>{{FULLPAGENAME}}</nowiki></tt> ([[Help:Page name|page title]] including [[help:namespace|namespace]])
 
−
*<tt><nowiki>{{PAGENAME}}</nowiki></tt> (page title excluding namespace)
 
−
*<tt><nowiki>{{BASEPAGENAME}}</nowiki></tt> (page title excluding ''current'' [[Help:Subpages|subpage]] and namespace - effectively the parent page without the namespace.)
 
−
*<tt><nowiki>{{SUBPAGENAME}}</nowiki></tt> (subpage part of title)
 
−
*<tt><nowiki>{{SUBJECTPAGENAME}}</nowiki></tt> (associated non-talk page)
 
−
*<tt><nowiki>{{TALKPAGENAME}}</nowiki></tt> (associated talk page)
 
−
*<tt><nowiki>{{NAMESPACE}}</nowiki></tt> (namespace of current page)
 
−
*<tt><nowiki>{{SUBJECTSPACE}}, {{ARTICLESPACE}}</nowiki></tt> (associated non-talk namespace)
 
−
*<tt><nowiki>{{TALKSPACE}}</nowiki></tt> (associated talk namespace)
 
−
* <tt><nowiki>{{FULLPAGENAMEE}}, {{NAMESPACEE}}</nowiki></tt> etc. (equivalents encoded for use in MediaWiki URLs)
 
  
−
The above can all take a parameter, to operate on a page other than the current page.
+
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.
  
−
*<tt><nowiki>{{SITENAME}}</nowiki></tt> ({{SITENAME}})
+
===Namespaces===
−
*<tt><nowiki>{{SERVER}}</nowiki></tt> ({{SERVER}})
+
{| class="wikitable"
−
*<tt><nowiki>{{SERVERNAME}}</nowiki></tt> ({{SERVERNAME}})
+
|-
−
*<tt><nowiki>{{SCRIPTPATH}}</nowiki></tt> ({{SCRIPTPATH}})
+
! {{Hl2}}| Variable
−
*<tt><nowiki>{{CURRENTVERSION}}</nowiki></tt> (current MediaWiki version)
+
! {{Hl2}}| Output
−
*<tt><nowiki>{{REVISIONID}}</nowiki></tt> (latest revision to current page)
+
! {{Hl2}}| Description
−
*<tt><nowiki>{{REVISIONDAY}}, {{REVISIONDAY2}}, {{REVISIONMONTH}}, {{REVISIONYEAR}}, {{REVISIONTIMESTAMP}}, {{REVISIONUSER}}</nowiki></tt> (date, time, editor at last edit)
+
! {{Hl2}}| Versions
 +
|-
 +
| <code><nowiki>{{NAMESPACE}}</nowiki></code>
 +
| {{NAMESPACE}}
 +
| Name of the page's namespace
 +
|
 +
|-
 +
| <code><nowiki>{{SUBJECTSPACE}}</nowiki></code><br /><code><nowiki>{{ARTICLESPACE}}</nowiki></code>
 +
| {{SUBJECTSPACE}}<br />{{ARTICLESPACE}}
 +
| Name of the associated content namespace
 +
| 1.7+
 +
|-
 +
| <code><nowiki>{{TALKSPACE}}</nowiki></code>
 +
| {{TALKSPACE}}
 +
| Name of the associated talk namespace
 +
| 1.7+
 +
|}
  
−
*<tt><nowiki>{{CURRENTYEAR}}, {{CURRENTMONTH}}, {{CURRENTMONTHNAME}}, {{CURRENTMONTHABBREV}}, {{CURRENTDAY}}, {{CURRENTDAY2}}, {{CURRENTDOW}}, {{CURRENTDAYNAME}}, {{CURRENTTIME}}, {{CURRENTHOUR}}, {{CURRENTWEEK}}, {{CURRENTTIMESTAMP}}</nowiki></tt> (current date/time variables)
+
The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded):
−
*<tt><nowiki>{{LOCALYEAR}}</nowiki></tt> etc. (as above, based on site's local time)
+
* <code><nowiki>{{NAMESPACEE}}</nowiki></code>
 +
* <code><nowiki>{{SUBJECTSPACEE}}</nowiki></code>
 +
* <code><nowiki>{{TALKSPACEE}}</nowiki></code>
  
−
*<tt><nowiki>{{NUMBEROFPAGES}}, {{NUMBEROFARTICLES}}, {{NUMBEROFFILES}}, {{NUMBEROFEDITS}}, {{NUMBEROFVIEWS}}, {{NUMBEROFUSERS}}, {{NUMBEROFADMINS}}, {{NUMBEROFACTIVEUSERS}}</nowiki></tt> (statistics on English Wikipedia; add <tt>:R</tt> to return numbers without commas)
+
As of {{mediawiki|rev:46630|1.15+}}, these can take a page name parameter and will return the namespace of the page name parameter, instead of the current page's:
 +
* <code><nowiki>{{NAMESPACE:Template:Main Page}}</nowiki></code> &rarr; '''{{NAMESPACE:Template:Main Page}}'''
 +
* <code><nowiki>{{SUBJECTSPACE:Template:Main Page}}</nowiki></code> &rarr; '''{{SUBJECTSPACE:Template:Main Page}}'''
 +
* <code><nowiki>{{TALKSPACE:Template:Main Page}}</nowiki></code> &rarr; '''{{TALKSPACE:Template:Main Page}}'''
  
 
==Parser functions==
 
==Parser functions==
−
{{Shortcut|WP:PF}}
 
−
''These are documented at the [[mw:Help:Magic words|main documentation page]] unless otherwise stated.''
 
−
===Metadata===
 
−
*<tt><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></tt> (size of page in bytes)
 
−
*<tt><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></tt> (protection level for given action on the current page)
 
−
*<tt><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></tt> (number of pages in the given [[Help:Categories|category]])
 
−
*<tt><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></tt> (number of users in a specific [[Help:User rights|group]])
 
  
−
Add <tt>|R</tt> to return numbers without commas.
+
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 {{mediawiki|Extension:ParserFunctions|ParserFunctions extension}}. For those see [[Help:Extension:ParserFunctions]].
 +
 
 +
===URL data===
 +
{| class="wikitable"
 +
|-
 +
! {{Hl2}}| Parser function
 +
! {{Hl2}}| Input → Output
 +
! {{Hl2}}| Description
 +
! {{Hl2}}| Versions
 +
|-
 +
| <code><nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{localurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code>
 +
| <code><nowiki>{{localurl:MediaWiki}}</nowiki></code> → {{localurl:MediaWiki}}<br /><nowiki>{{localurl:MediaWiki|printable=yes}}</nowiki>  → {{localurl:MediaWiki|printable=yes}}
 +
| The relative path to the title.
 +
|
 +
|-
 +
| <code><nowiki>{{fullurl:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{fullurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code><br /><code><nowiki>{{fullurl:</nowiki>''interwiki:remote page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code>
 +
| <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}}
 +
| The absolute path to the title. This will also resolve [[Manual:Interwiki|Interwiki]] prefixes.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{filepath:</nowiki>''file name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{filepath:</nowiki>''file name''<nowiki>|nowiki}}</nowiki></code>
 +
| <code><nowiki>{{filepath:Wiki.png}}</nowiki></code> → {{filepath:Wiki.png}}<br />
 +
<code><nowiki>{{filepath:Wiki.png|nowiki}}</nowiki></code> → {{filepath:Wiki.png|nowiki}}<br />
 +
<code><nowiki>{{filepath:Example.svg|300}}</nowiki></code> → http://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Example.svg/300px-Example.svg.png<br />
 +
| The absolute URL to the full size or thumbnail ({{mediawiki|rev:80813|1.18+}}) of a media file.
 +
| {{mediawiki|rev:25854|1.12+}}<br />{{mediawiki|rev: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:x y z á é}}</nowiki></code> (or <code><nowiki>{{urlencode:x y z á é|QUERY}})</nowiki></code> → {{urlencode:x y z á é}}<br /><code><nowiki>{{urlencode:x y z á é|WIKI}}</nowiki></code> → x_y_z_%C3%A1_%C3%A9<br /><code><nowiki>{{urlencode:x y z á é|PATH}}</nowiki></code> → x%20y%20z%20%C3%A1%20%C3%A9
 +
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]].
 +
| {{mediawiki|rev:14273|1.7+}} (or {{mediawiki|rev:64726|1.17+}})<br />{{mediawiki|rev:64726|1.17+}}<br />{{mediawiki|rev:64726|1.17+}}
 +
|-
 +
| <code><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></code>
 +
| <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).
 +
| {{mediawiki|rev:16279|1.8+}}
 +
|}
 +
 
 +
===Namespaces===
 +
<code><nowiki>{{ns:}}</nowiki></code> returns the localized name for the [[Help:Namespace|namespace]] with that index. <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.
 +
{| class="wikitable"
 +
|-
 +
! {{hl3}} colspan="2" width="50%" | Content namespaces
 +
! rowspan="12" |
 +
! {{hl3}} colspan="2" width=%50%" | Talk namespaces
 +
|-
 +
! {{Hl2}}| Usage
 +
! {{Hl2}}| Output
 +
! {{Hl2}}| Usage
 +
! {{Hl2}}| Output
 +
|-
 +
| <code><nowiki>{{ns:-2}}</nowiki></code> or <code><nowiki>{{ns:Media}}</nowiki></code>
 +
| {{ns:-2}} || ||
 +
|-
 +
| <code><nowiki>{{ns:-1}}</nowiki></code> or <code><nowiki>{{ns:Special}}</nowiki></code>
 +
| {{ns:-1}} || ||
 +
|-
 +
| <code><nowiki>{{ns:0}}</nowiki></code> or <code><nowiki>{{ns:}}</nowiki></code>
 +
| {{ns:}}
 +
| <code><nowiki>{{ns:1}}</nowiki></code> or <code><nowiki>{{ns:Talk}}</nowiki></code>
 +
| {{ns:1}}
 +
|-
 +
| <code><nowiki>{{ns:2}}</nowiki></code> or <code><nowiki>{{ns:User}}</nowiki></code>
 +
| {{ns:2}}
 +
| <code><nowiki>{{ns:3}}</nowiki></code> or <code><nowiki>{{ns:User talk}}</nowiki></code>
 +
| {{ns:3}}
 +
|-
 +
| <code><nowiki>{{ns:4}}</nowiki></code> or <code><nowiki>{{ns:Project}}</nowiki></code>
 +
| {{ns:4}}
 +
| <code><nowiki>{{ns:5}}</nowiki></code> or <code><nowiki>{{ns:Project talk}}</nowiki></code>
 +
| {{ns:5}}
 +
|-
 +
| <code><nowiki>{{ns:6}}</nowiki></code> or <code><nowiki>{{ns:File}}</nowiki></code> or <code><nowiki>{{ns:Image}}</nowiki></code>
 +
| {{ns:6}}
 +
| <code><nowiki>{{ns:7}}</nowiki></code> or <code><nowiki>{{ns:File talk}}</nowiki></code> or <code><nowiki>{{ns:Image talk}}</nowiki></code>
 +
| {{ns:7}}
 +
|-
 +
| <code><nowiki>{{ns:8}}</nowiki></code> or <code><nowiki>{{ns:MediaWiki}}</nowiki></code>
 +
| {{ns:8}}
 +
| <code><nowiki>{{ns:9}}</nowiki></code> or <code><nowiki>{{ns:MediaWiki talk}}</nowiki></code>
 +
| {{ns:9}}
 +
|-
 +
| <code><nowiki>{{ns:10}}</nowiki></code> or <code><nowiki>{{ns:Template}}</nowiki></code>
 +
| {{ns:10}}
 +
| <code><nowiki>{{ns:11}}</nowiki></code> or <code><nowiki>{{ns:Template talk}}</nowiki></code>
 +
| {{ns:11}}
 +
|-
 +
| <code><nowiki>{{ns:12}}</nowiki></code> or <code><nowiki>{{ns:Help}}</nowiki></code>
 +
| {{ns:12}}
 +
| <code><nowiki>{{ns:13}}</nowiki></code> or <code><nowiki>{{ns:Help talk}}</nowiki></code>
 +
| {{ns:13}}
 +
|-
 +
| <code><nowiki>{{ns:14}}</nowiki></code> or <code><nowiki>{{ns:Category}}</nowiki></code>
 +
| {{ns:14}}
 +
| <code><nowiki>{{ns:15}}</nowiki></code> or <code><nowiki>{{ns:Category talk}}</nowiki></code>
 +
| {{ns:15}}
 +
|}
  
 
===Formatting===
 
===Formatting===
−
*<tt><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></tt> (convert to lower case)
+
<!--Well gosh, with the source of the examples hidden, who can tell what you are inputting without looking here in the source?-->
−
*<tt><nowiki>{{lcfirst:</nowiki>''string''<nowiki>}}</nowiki></tt> (convert first character to lower case)
+
{| class="wikitable"
−
*<tt><nowiki>{{uc:</nowiki>''string''<nowiki>}}</nowiki></tt> (convert to upper case)
+
! {{Hl2}}| Usage
−
*<tt><nowiki>{{ucfirst:</nowiki>''string''<nowiki>}}</nowiki></tt> (convert first character to upper case)
+
! {{Hl2}}| Input → Output
−
*<tt><nowiki>{{formatnum:</nowiki>''unformatted&nbsp;num''<nowiki>}}</nowiki></tt> (format a number with comma separators; add <tt><nowiki>|</nowiki>R</tt> to unformat a number)
+
! {{Hl2}}| Description
−
*<tt><nowiki>{{#formatdate:</nowiki>''date''|''format''<nowiki>}}</nowiki></tt> (formats a date according to user preferences; a default can be given as an optional case-sensitive second parameter for users without date preference; can convert a date from an existing format to any of <tt>dmy</tt>, <tt>mdy</tt>, <tt>ymd</tt> or <tt>ISO 8601</tt> formats, with the user's preference overriding the specified format)
+
! {{Hl2}}| Version
−
*<tt><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{padright:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt> (pad with zeros to the right or left; an alternative padding string can be given as a third parameter; the alternative padding string may be truncated if its length does not evenly divide the required number of characters)
+
|-
−
*<tt><nowiki>{{plural:</nowiki>''n''|''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></tt> (produces alternative text according to whether ''n'' is greater than 1)
+
|-
−
*<tt><nowiki>{{#time:</nowiki>''format string''|''date/time object''<nowiki>}}</nowiki></tt> (for date/time formatting; also <tt>#timel</tt> for local time. Covered at the [[mw:Help:Extension:ParserFunctions##time|extension documentation page]].)
+
| <code><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></code>
−
*<tt><nowiki>{{gender:</nowiki>''username''|''masculine''|''female''|''neutral''}}</tt> (produces alternative text according to the gender specified by the given user in his/her preferences)
+
| <code><nowiki>{{lc:DATA CENTER}}</nowiki></code> → {{lc:DATA CENTER}}
 +
| The lowercase input.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{lcfirst:</nowiki>''string''<nowiki>}}</nowiki></code>
 +
| <code><nowiki>{{lcfirst:DATA center}}</nowiki></code> → {{lcfirst:DATA center}}
 +
| The input with the <u>very first</u> character lowercase.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{uc:</nowiki>''string''<nowiki>}}</nowiki></code>
 +
| <code><nowiki>{{uc:text transform}}</nowiki></code> → {{uc:text transform}}
 +
| The uppercase input.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{ucfirst:</nowiki>''string''<nowiki>}}</nowiki></code>
 +
| <code><nowiki>{{ucfirst:text TRANSFORM}}</nowiki></code> → {{ucfirst:text TRANSFORM}}
 +
| The input with the <u>very first</u> character uppercase.
 +
| 1.5+
 +
|-
 +
| <code><nowiki>{{formatnum:</nowiki>''unformatted&nbsp;num''<nowiki>}}</nowiki></code><br /><code><nowiki>{{formatnum:</nowiki>''formatted&nbsp;num''<nowiki>|R}}</nowiki></code>
 +
| <code><nowiki>{{formatnum:987654321.654321}}</nowiki></code><br/> → {{formatnum:987654321.654321}}<br /> <code><nowiki>{{formatnum:987,654,321.654321|R}}</nowiki></code><br/> → {{formatnum:987,654,321.654321|R}}<br /> <code><nowiki>{{formatnum:00001}}</nowiki></code><br/> → {{formatnum:00001}}
 +
| The input with decimal and decimal group separators, and localized digit script, according to the wiki's default locale. The <code><nowiki>|</nowiki>R</code> parameter can be used to unformat a number, for use in mathematical situations.<br/><small>{{warning}}Leading zeroes are not removed, you can use <nowiki>{{#expr:00001}}</nowiki> instead if you have [[Extension:ParserFunctions]] installed</small>
 +
| 1.7+<br />{{mediawiki|rev:32012|1.13+}}
 +
|-
 +
|
 +
<code><nowiki>{{#dateformat:</nowiki>''date''<nowiki>}}
 +
{{#formatdate:</nowiki>''date''<nowiki>}}
 +
{{#dateformat:</nowiki>''date''{{!}}''format''<nowiki>}}
 +
{{#formatdate:</nowiki>''date''{{!}}''format''<nowiki>}}</nowiki></code>
 +
|
 +
<code><nowiki>{{#dateformat:25 deC 2009|ymd}}</nowiki></code><br/>
 +
→ {{#dateformat:25 deC 2009|ymd}} (your pref),  2009 DeC 25 (default)<br/>
 +
<code><nowiki>{{#formatdate:dec 25,2009|dmy}}</nowiki></code><br/>
 +
→ {{#formatdate:dec 25,2009|dmy}} (your pref), 25 Dec 2009 (default)<br/>
 +
<code><nowiki>{{#dateformat:2009-12-25|mdy}}</nowiki></code><br/>
 +
→ {{#dateformat:2009-12-25|mdy}} (your pref), December 25, 2009 (default)<br/>
 +
<code><nowiki>{{#formatdate:2009 dec 25|ISO 8601}}</nowiki></code><br/>
 +
→ {{#formatdate:2009 dec 25|ISO 8601}} (your pref), 2009-12-25 (default)<br/>
 +
<code><nowiki>{{#dateformat:25 decEmber|mdy}}</nowiki></code><br/>
 +
→ {{#dateformat:25 decEmber|mdy}} (your pref), DecEmber 25 (default)<br/>
 +
 
  
−
===Paths===
+
Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only.
−
*<tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>|</nowiki>''query string''<nowiki>}}</nowiki></tt> (relative path to the title)
+
| 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&nbsp;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>
−
*<tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></tt> (absolute path to the title)
+
| {{mediawiki|rev:48249|1.15+}}
−
*<tt><nowiki>{{filepath:</nowiki>''file name''<nowiki>}}</nowiki></tt> (absolute URL to a media file)
+
|-
−
*<tt><nowiki>{{urlencode:</nowiki>''string''<nowiki>}}</nowiki></tt> (input encoded for use in URLs)
+
| <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>
−
*<tt><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></tt> (input encoded for use in URL section anchors)
+
| <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 />
−
*<tt><nowiki>{{ns:</nowiki>''n''<nowiki>}}</nowiki></tt> (name for the [[Help:Namespace|namespace]] with index ''n''; use <tt><nowiki>{{nse:}}</nowiki></tt> for the equivalent encoded for MediaWiki URLs)
+
| 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 />'''{{mediawiki|bugzilla:16852|bug}} (fixed in {{mediawiki|rev:45734|r45734}}):''' multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters.
−
*<tt><nowiki>{{#rel2abs:</nowiki> ''path'' <nowiki>}}</nowiki></tt> (converts a relative file path to absolute; see the [[mw:Help:Extension:ParserFunctions|extension documentation]])
+
| 1.8+
−
*<tt><nowiki>{{#titleparts:</nowiki> ''pagename'' | ''number of segments to return'' | ''first segment to return'' <nowiki>}}</nowiki></tt> (splits title into parts; see the [[mw:Help:Extension:ParserFunctions|extension documentation]])
+
|-
 +
| <code><nowiki>{{padright:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padright:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''char''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padright:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''string''<nowiki>}}</nowiki></code>
 +
| <code><nowiki>{{padright:xyz|5}}</nowiki></code> → {{padright:xyz|5}}<br />
 +
<code><nowiki>{{padright:xyz|5|_}}</nowiki></code> → {{padright:xyz|5|_}}
 +
<code><nowiki>{{padright:xyz|5|abc}}</nowiki></code> → {{padright:xyz|5|abc}}
 +
<code><nowiki>{{padright:xyz|2}}</nowiki></code> → {{padright:xyz|2}}<br />
 +
<code><nowiki>{{padright:|1|xyz}}</nowiki></code> → {{padright:|1|xyz}}<br />
 +
| Identical to padleft, but adds padding characters to the right side.
 +
|
 +
|-
 +
| <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 [[: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. 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 [[bugzilla:28128|bug 28128]].
 +
|
 +
|-
 +
| <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 (language-dependent).  Grammar transformations are used for inflected languages like Polish.  See also {{mediawiki|Manual:$wgGrammarForms}}.
 +
| 1.7+
 +
|}
  
−
===Conditional expressions===
+
===Miscellaneous===
−
These are covered at the [[mw:Help:Extension:ParserFunctions|extension documentation page]]. Some parameters are optional.
+
{| class="wikitable plainlinks"
−
*<tt><nowiki>{{#expr:</nowiki> ''expression'' <nowiki>}}</nowiki></tt> (evaluates the given expression; see [[Help:Calculation]])
+
! {{Hl2}}| Usage
−
*<tt><nowiki>{{#if:</nowiki> ''test string'' | ''value if non-empty'' | ''value if empty'' <nowiki>}}</nowiki></tt> (selects one of two values based on whether the test string is empty)
+
! {{Hl2}}| Output
−
*<tt><nowiki>{{#ifeq:</nowiki> ''string 1'' <nowiki>|</nowiki> ''string 2'' <nowiki>|</nowiki> ''value if equal'' <nowiki>|</nowiki> ''value if unequal'' <nowiki>}}</nowiki></tt> (selects one of two values based on whether the test strings are equal – numerically if applicable)
+
! {{Hl2}}| Description
−
*<tt><nowiki>{{#iferror:</nowiki> ''test string'' <nowiki>|</nowiki> ''value if error'' <nowiki>|</nowiki> ''value if correct'' <nowiki>}}</nowiki></tt> (selects value based on whether the test string generates a parser error)
+
! {{Hl2}}| Version
−
*<tt><nowiki>{{#ifexpr:</nowiki> ''expression'' <nowiki>|</nowiki> ''value if true'' <nowiki>|</nowiki> ''value if false'' <nowiki>}}</nowiki></tt> (selects value based on evaluation of expression)
+
|-
−
*<tt><nowiki>{{#ifexist:</nowiki> ''page title'' | ''value if exists'' | ''value if doesn't exist'' <nowiki>}}</nowiki></tt> (selects value depending on whether a page title exists)
+
| <code><nowiki>{{int:</nowiki>''message name''<nowiki>}}</nowiki>
−
*<tt><nowiki>{{#switch:</nowiki> ''test'' | ''case1'' = ''value for case 1'' | ... | ''default'' <nowiki>}}</nowiki></tt> (provides alternatives based on the value of the test string)
+
| <code><nowiki>{{int:</nowiki>edit<nowiki>}}</nowiki></code> &rarr; '''{{int:edit}}''' <br /><small>''(depends on user language, try: [{{fullurl:{{FULLPAGENAME}}|uselang=fr}}#Miscellaneous fr] &bull;[{{fullurl:{{FULLPAGENAME}}|uselang=ja}}#Miscellaneous ja])''</small>
 +
| Internationalizes (translates) the given '''int'''erface (MediaWiki namespace) message into the user language. ''Note that this can damage/confuse cache consistency, see [[bugzilla:14404|bug 14404]].''
 +
|
 +
|-
 +
| <code><nowiki>{{#language:</nowiki>''language code''<nowiki>}}</nowiki></code><br /><code><nowiki>{{#language:ar}}</nowiki></code><br /><code><nowiki>{{#language:th}}</nowiki></code>
 +
| {{#language:language code}}<br />{{#language:ar}}<br />{{#language:th}}
 +
| The native name for the given language code, in accordance with [[w:ISO 639|ISO 639]].
 +
| {{mediawiki|rev:14490|1.7+}}
 +
|-
 +
| <code><nowiki>{{#special:</nowiki>''special page name''<nowiki>}}</nowiki><br /><nowiki>{{#special:userlogin}}</nowiki></code>
 +
| {{#special:special page name}}<br />{{#special:userlogin}}
 +
| The localized name for the given canonical Special: page.
 +
| {{mediawiki|rev:17321|1.9+}}
 +
|-
 +
| <code><nowiki>{{#tag:</nowiki>''tagname''<br><nowiki>|</nowiki>''content''<br><nowiki>|</nowiki>''parameter1=value1''<br /><nowiki>|</nowiki>''parameter2=value2''<br /><nowiki>}}</nowiki></code>
 +
| ''(depends on parser tag)''
 +
| Alias for XML-style parser or extension tags, but parsing wiki code. Inner content can be passed as first parameter, and attributes as subsequent ones:
  
−
For the use of these functions in tables, see [[Wikipedia:Conditional tables|Conditional tables]].
+
<code><</code>''tagname'' ''attribute1''="''value1''" ''attribute2''="''value2''"<code>></code> ''content'' <code></</code>''tagname'' <code>></code> &rarr; <code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>|</nowiki></code>''content''<code><nowiki>|</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code>
  
−
==See also==
+
'''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.
−
*[[mw:Internationalisation]]
+
No space is permitted between the {{!}} and the attribute name.
−
*[[mw:Manual:Extending_wiki_markup|Adding parser functions]]
+
| {{mediawiki|rev:29482|1.12+}}
−
*[http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/parser/CoreParserFunctions.php?view=log CoreParserFunctions.php]
+
|-
−
* [[User:Cacycle/wikEd|wikEd]], a MediaWiki editor with syntax highlighting for templates and parser functions
+
| <code><nowiki>{{gender:</nowiki>''username''<br /><nowiki>|</nowiki>''return text if user is male''<br /><nowiki>|</nowiki>''return text if user is female''<br /><nowiki>|</nowiki>''return text if user hasn't defined their gender''<nowiki>}}</nowiki></code>
 +
| ''(depends on the named user's gender)''
 +
| A switch for the gender set in [[Special:Preferences]]<br/>
 +
Note:  If 3rd parameter is omitted and user hasn't defined his/her gender, then <code>''text if user is male''</code> is returned.
 +
| {{mediawiki|rev:46247|1.15+}}
 +
|}
  
−
[[Category:Wikipedia features]]
+
{{languages}}
  
−
[[ar:مساعدة:كلمات سحرية]]
+
[[Category:Help|{{PAGENAME}}]]
−
[[cy:Wicipedia:Geiriau hud]]
+
[[Category:Time|{{PAGENAME}}]]
−
[[de:Hilfe:Variablen]]
+
[[Category:Magic words|{{PAGENAME}}]]
−
[[hi:सहायता:जादूई शब्द ]]
 
−
[[es:Ayuda:Palabras mágicas]]
 
−
[[fa:راهنما:کلمات جادویی]]
 
−
[[he:עזרה:משתנים]]
 
−
[[hr:Wikipedija:Magične riječi]]
 
−
[[it:Aiuto:Variabili]]
 
−
[[ja:Help:マジックワード]]
 
−
[[ka:დახმარება:ჯადოსნური სიტყვები]]
 
−
[[ko:위키백과:기본 틀]]
 
−
[[nl:Help:Parserfuncties]]
 
−
[[pl:Pomoc:Magiczne słowa]]
 
−
[[pt:Ajuda:Palavras mágicas]]
 
−
[[simple:Help:Magic words]]
 
−
[[zh:Help:魔術字]]
 

Latest revision as of 09:57, 17 June 2011

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:

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[edit]

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

Template:Hl2| Word Template:Hl2| Description Template:Hl2| Versions
Template:Hl3 colspan="3"| Table of contents
__NOTOC__ Hides the table of contents (TOC).
__FORCETOC__ Forces the table of content 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.
Template:Hl3 colspan="3"| Editing
__NOEDITSECTION__ Hides the section edit links beside headings.
__NEWSECTIONLINK__ Adds a link ("+" by default) beside the "edit" tab for adding a new section on a non-talk page (see Adding a section to the end). 1.7+
__NONEWSECTIONLINK__ Removes the link beside the "edit" tab on pages in talk namespaces. 1.15+
Template:Hl3 colspan="3"| 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+
Template:Hl3 colspan="3"| 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).
Template:Hl3 colspan="3"| 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 (ie, 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[edit]

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[edit]

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.

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
Template:Hl3 colspan="4"| Year
{{CURRENTYEAR}} 2024 Year
Template:Hl3 colspan="4"| Month
{{CURRENTMONTH}} 05 Month (zero-padded number)
{{CURRENTMONTHNAME}} May Month (name)
{{CURRENTMONTHNAMEGEN}} May Month (genitive form)
{{CURRENTMONTHABBREV}} May Month (abbreviation) 1.5+
Template:Hl3 colspan="4"| Day
{{CURRENTDAY}} 17 Day of the month (unpadded number)
{{CURRENTDAY2}} 17 Day of the month (zero-padded number) 1.6+
{{CURRENTDOW}} 5 Day of the week (unpadded number)
{{CURRENTDAYNAME}} Friday Day of the week (name)
Template:Hl3 colspan="4"| Time
{{CURRENTTIME}} 10:50 Time (24-hour HH:mm format)
{{CURRENTHOUR}} 10 Hour (24-hour zero-padded number)
Template:Hl3 colspan="4"| Other
{{CURRENTWEEK}} 20 Week (number)
{{CURRENTTIMESTAMP}} 20240517105041 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[edit]

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

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
Template:Hl3 colspan="4"| Site
{{SITENAME}} OPOSSEM The wiki's site name ($wgSitename).
{{SERVER}} http://wiki.opossem.org domain URL ($wgServer)
{{SERVERNAME}} wiki.opossem.org 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 (&lrm; on left-to-right wikis, &rlm; on right-to-left wikis), useful in text with multi-directional text. 1.7+
{{SCRIPTPATH}} http://wiki.opossem.org relative script path ($wgScriptPath)
{{STYLEPATH}} http://wiki.opossem.org/skins relative style path ($wgStylePath) 1.16+
{{CURRENTVERSION}} 1.28.2 The wiki's MediaWiki version. 1.7+
{{CONTENTLANGUAGE}}
{{CONTENTLANG}} 		en
en 		The wiki's default interface language ($wgLanguageCode) 1.7+
Template:Hl3 colspan="4"| Latest revision to current page
{{REVISIONID}} 512 Unique revision ID 1.5+
{{REVISIONDAY}} 17 Day edit was made (unpadded number) 1.8+
{{REVISIONDAY2}} 17 Day edit was made (zero-padded number) 1.8+
{{REVISIONMONTH}} 06 Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions) 1.8+
{{REVISIONYEAR}} 2011 Year edit was made 1.8+
{{REVISIONTIMESTAMP}} 20110617095721 Timestamp as of time of edit 1.8+
{{REVISIONUSER}} Wikiadmin The username of the user who made the most recent edit to the page, or the current user when previewing an edit 1.15+
{{PAGESIZE:page name}}
{{PAGESIZE:page name|R}} 		37,073
37073 		[expensive] Returns the byte size of the specified page. Use "<code>|R" to get raw numbers. 1.13+
{{PROTECTIONLEVEL:action}} protection level Outputs the protection level (e.g. 'autoconfirm', 'sysop') for a given action (e.g. 'edit', 'move') on the current page or an empty string if not protected. 1.15+
Template:Hl3 colspan="4"| 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. 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}} 		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. 1.10+

Statistics[edit]

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}} → 457 and {{NUMBEROFPAGES:R}} → 457). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}). Also applicable to {{PAGESIZE:page name}} above.

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
Template:Hl3 colspan="4"| Entire wiki
{{NUMBEROFPAGES}} 457 Number of wiki pages. 1.7+
{{NUMBEROFARTICLES}} 43 Number of pages in content namespaces.
{{NUMBEROFFILES}} 40 Number of uploaded files. 1.5+
{{NUMBEROFEDITS}} 2,605 Number of page edits. 1.10+
{{NUMBEROFVIEWS}} Template:NUMBEROFVIEWS Number of page views. Usually useless on a wiki using caching. 1.14+
{{NUMBEROFUSERS}} 31 Number of registered users. 1.7+
{{NUMBEROFADMINS}} 4 Number of users in the sysop group. 1.7+
{{NUMBEROFACTIVEUSERS}} 11 Number of active users, based on the criteria used in Special:Statistics. 1.15+
{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:Help}} 		58
58 		[expensive] Number of pages in the given category. 1.13+
{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}} 		4
4
({{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[edit]

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| 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 {{#titleparts:}} from ParserFunctions extension.

1.7+
{{SUBPAGENAME}} Magic words The subpage title ("foo" on "Title/foo"). 1.6+
{{SUBJECTPAGENAME}} 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 Manual:$wgNamespacesWithSubpages for information on enabling subpages.

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

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

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

Template:Warning

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

Namespaces[edit]

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
{{NAMESPACE}} Help Name of the page's namespace
{{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 page name parameter and will return the namespace of the page name parameter, instead of the current page's:

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

Parser functions[edit]

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 ParserFunctions extension. For those see Help:Extension:ParserFunctions.

URL data[edit]

Template:Hl2| Parser function Template:Hl2| Input → Output Template:Hl2| Description Template:Hl2| Versions
{{localurl:page name}}
{{localurl:page name|query_string}} 		{{localurl:MediaWiki}} → http://wiki.opossem.org/index.php?title=MediaWiki
{{localurl:MediaWiki|printable=yes}} → http://wiki.opossem.org/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}} → http://wiki.opossem.org/index.php?title=Category:Top_level

{{fullurl:Category:Top level|action=edit}} → http://wiki.opossem.org/index.php?title=Category:Top_level&action=edit

The absolute path to the title. This will also resolve Interwiki prefixes. 1.5+
{{filepath:file name}}
{{filepath:file name|nowiki}} 		{{filepath:Wiki.png}} →

{{filepath:Wiki.png|nowiki}} →
{{filepath:Example.svg|300}} → http://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Example.svg/300px-Example.svg.png

 The absolute URL 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 |WIKI to |QUERY 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. 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[edit]

{{ns:}} returns the localized name for the namespace with that index. {{nse:}} is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links.

Template:Hl3 colspan="2" width="50%" | Content namespaces Template:Hl3 colspan="2" width=%50%" | Talk namespaces
Template:Hl2| Usage Template:Hl2| Output Template:Hl2| Usage Template:Hl2| 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}} OPOSSEM {{ns:5}} or {{ns:Project talk}} OPOSSEM 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[edit]

Template:Hl2| Usage Template:Hl2| Input → Output Template:Hl2| Description Template:Hl2| Version
{{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+
{{formatnum:unformatted num}}
{{formatnum:formatted num|R}} 		{{formatnum:987654321.654321}}
→ 987,654,321.654321
{{formatnum:987,654,321.654321|R}}
→ 987654321.654321
{{formatnum:00001}}
→ 00,001 		The input with decimal and decimal group separators, and localized digit script, according to the wiki's default locale. The |R parameter can be used to unformat a number, for use in mathematical situations.
Template:WarningLeading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed 		1.7+
1.13+

{{#dateformat:date}} {{#formatdate:date}} {{#dateformat:date|format}} {{#formatdate:date|format}}

{{#dateformat:25 deC 2009|ymd}}
→ 2009 DeC 25 (your pref), 2009 DeC 25 (default)
{{#formatdate:dec 25,2009|dmy}}
→ 25 Dec 2009 (your pref), 25 Dec 2009 (default)
{{#dateformat:2009-12-25|mdy}}
→ December 25, 2009 (your pref), December 25, 2009 (default)
{{#formatdate:2009 dec 25|ISO 8601}}
→ 2009-12-25 (your pref), 2009-12-25 (default)
{{#dateformat:25 decEmber|mdy}}
→ DecEmber 25 (your pref), DecEmber 25 (default)


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: 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.
Template:WarningAlthough 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+
{{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.
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

{{padright:xyz|5|_}} → xyz__ {{padright:xyz|5|abc}} → xyzab {{padright:xyz|2}} → xyz
{{padright:|1|xyz}} → x

 Identical to padleft, but adds padding characters to the right side.
{{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. 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+

Miscellaneous[edit]

Template:Hl2| Usage Template:Hl2| Output Template:Hl2| Description Template:Hl2| Version
{{int:message name}} <code>{{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, see bug 14404.
{{#language:language code}}
{{#language:ar}}
{{#language:th}} 		language code
العربية
ไทย 		The native name for the given language code, in accordance with ISO 639. 1.7+
{{#special:special page name}}
{{#special:userlogin}} 		Special:Special page name
Special:UserLogin 		The localized name for the given canonical Special: page. 1.9+
{{#tag:tagname
|content
|parameter1=value1
|parameter2=value2
}} 		(depends on parser tag) Alias for XML-style parser or extension tags, but parsing wiki code. Inner content can be passed as first parameter, and attributes as subsequent ones:

<tagname attribute1="value1" attribute2="value2"> content </tagname > → {{#tag:tagname|content|attribute1=value1|attribute2=value2}}

Warning : You must write {{#tag:tagname||attribute1=value1|attribute2=value2}} to pass an empty content. No space is permitted between the | and the attribute name.

1.12+
{{gender:username
|return text if user is male
|return text if user is female
|return text if user hasn't defined their gender}} 		(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 text if user is male is returned.

1.15+

Template:Languages

Retrieved from "http://wiki.opossem.org/index.php?title=Help:Magic_words&oldid=512"