Help:Magic words

From Dmz-portal

(Redirected from Help:Variables)
Jump to: navigation, search

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

 Dmz-portal

| MediaWiki | Manual:Magic words | Manual:Magic words }}.

There are three general types of magic words:

 Dmz-portal

| MediaWiki | 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.

Contents

Behavior switches

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.

Word Description Versions
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.
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 {{ #ifeq:
 Dmz-portal
MediaWiki Adding a section to the end Adding a section to the end

}}).

1.7+
__NONEWSECTIONLINK__ Removes the link beside the "edit" tab on pages in talk namespaces. {{ #ifeq:
 Dmz-portal
MediaWiki 1.15+ 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 {{ #ifeq:
 Dmz-portal
MediaWiki 19213 19213

}}.

1.1–1.8
__INDEX__ Tell search engines to index the page (overrides {{ #ifeq:
 Dmz-portal
MediaWiki $wgArticleRobotPolicies $wgArticleRobotPolicies

}}, but not robots.txt).

1.14+
__NOINDEX__ Tell search engines not to index the page (ie, do not list in search engines' results). {{ #ifeq:
 Dmz-portal
MediaWiki 1.14+ 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". {{ #ifeq:
 Dmz-portal
MediaWiki 1.13+ 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.

Variable Output Description Versions
Year
{{CURRENTYEAR}} 2019 Year
Month
{{CURRENTMONTH}} 01 Month (zero-padded number)
{{CURRENTMONTHNAME}} January Month (name)
{{CURRENTMONTHNAMEGEN}} January Month (genitive form)
{{CURRENTMONTHABBREV}} Jan Month (abbreviation) 1.5+
Day
{{CURRENTDAY}} 24 Day of the month (unpadded number)
{{CURRENTDAY2}} 24 Day of the month (zero-padded number) 1.6+
{{CURRENTDOW}} 4 Day of the week (unpadded number)
{{CURRENTDAYNAME}} Thursday Day of the week (name)
Time
{{CURRENTTIME}} 00:08 Time (24-hour HH:mm format)
{{CURRENTHOUR}} 00 Hour (24-hour zero-padded number)
Other
{{CURRENTWEEK}} 4 Week (number)
{{CURRENTTIMESTAMP}} 20190124000856 YYYYMMDDHHmmss timestamp 1.7+

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

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}} Dmz-portal The wiki's site name ({{ #ifeq:
 Dmz-portal
MediaWiki $wgSitename $wgSitename

}}).

{{SERVER}} https://dmz-portal.mips.com domain URL ({{ #ifeq:
 Dmz-portal
MediaWiki $wgServer $wgServer

}})

{{SERVERNAME}} dmz-portal.mips.com domain name (No longer dependent on {{ #ifeq:
 Dmz-portal
MediaWiki $wgServerName $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.  ? r? {{#if: }} {{#if:1.7+|1.7+}}

}}

{{SCRIPTPATH}} /mw relative script path ({{ #ifeq:
 Dmz-portal
MediaWiki $wgScriptPath $wgScriptPath

}})

{{STYLEPATH}} /mw/skins relative style path ({{ #ifeq:
 Dmz-portal
MediaWiki $wgStylePath $wgStylePath

}})

1.16+
{{CURRENTVERSION}} 1.16.5 The wiki's MediaWiki version.  ? r? {{#if: }} {{#if:1.7+|1.7+}}

}}

{{CONTENTLANGUAGE}}
{{CONTENTLANG}}
en
en
The wiki's default interface language ({{ #ifeq:
 Dmz-portal
MediaWiki $wgLanguageCode $wgLanguageCode

}})

 ? r? {{#if: }} {{#if:1.7+|1.7+}}

}}

Latest revision to current page
{{REVISIONID}} 48 Unique revision ID 1.5+
{{REVISIONDAY}} 30 Day edit was made (unpadded number) 1.8+
{{REVISIONDAY2}} 30 Day edit was made (zero-padded number) 1.8+
{{REVISIONMONTH}} 8 Month edit was made (zero-padded number as of {{ #ifeq:
 Dmz-portal
MediaWiki 1.17+ 1.17+

}}, unpadded number in prior versions)

1.8+
{{REVISIONMONTH1}} Template:REVISIONMONTH1 Month edit was made (unpadded number) {{ #ifeq:
 Dmz-portal
MediaWiki 1.17+ 1.17+

}}

{{REVISIONYEAR}} 2011 Year edit was made 1.8+
{{REVISIONTIMESTAMP}} 20110830230006 Timestamp as of time of edit 1.8+
{{REVISIONUSER}} Bkirby The username of the user who made the most recent edit to the page, or the current user when previewing an edit {{ #ifeq:
 Dmz-portal
MediaWiki 1.15+ 1.15+

}}

{{PAGESIZE:page name}}
{{PAGESIZE:page name|R}}
38,029
38029
[expensive] Returns the byte size of the specified page. Use "<code>|R" to get raw numbers. {{ #ifeq:
 Dmz-portal
MediaWiki 1.13+ 1.13+

}}

{{PROTECTIONLEVEL:action}} protection level 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. {{ #ifeq:
 Dmz-portal
MediaWiki 1.15+ 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. It can be disabled or enabled by {{ #ifeq:
 Dmz-portal
MediaWiki $wgAllowDisplayTitle $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

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}} → 223 and {{NUMBEROFPAGES:R}} → 223). 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.

Variable Output Description Versions
Entire wiki
{{NUMBEROFPAGES}} 223 Number of wiki pages. 1.7+
{{NUMBEROFARTICLES}} 23 Number of pages in {{ #ifeq:
 Dmz-portal
MediaWiki content namespaces content namespaces

}}.

{{NUMBEROFFILES}} 52 Number of uploaded files. 1.5+
{{NUMBEROFEDITS}} 1,089 Number of page edits. {{ #ifeq:
 Dmz-portal
MediaWiki 1.10+ 1.10+

}}

{{NUMBEROFVIEWS}} 255,645 Number of page views. Usually useless on a wiki using caching. {{ #ifeq:
 Dmz-portal
MediaWiki 1.14+ 1.14+

}}

{{NUMBEROFUSERS}} 50 Number of registered users. 1.7+
{{NUMBEROFADMINS}} 2 Number of users in the sysop {{ #ifeq:
 Dmz-portal
MediaWiki group group

}}.

1.7+
{{NUMBEROFACTIVEUSERS}} 5 Number of active users, based on the criteria used in Special:Statistics. {{ #ifeq:
 Dmz-portal
MediaWiki 1.15+ 1.15+

}}

{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:Help}}
45
45
[expensive] Number of pages in the given category. {{ #ifeq:
 Dmz-portal
MediaWiki 1.13+ 1.13+

}}

{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}}
2
2
({{NUMBERINGROUP:bureaucrat}} used here)
Number of users in a specific {{ #ifeq:
 Dmz-portal
MediaWiki group group

}}.

{{ #ifeq:
 Dmz-portal
MediaWiki 1.14+ 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 {{ #ifeq:
 Dmz-portal
MediaWiki $wgAllowSlowParserFunctions $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 {{#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 {{ #ifeq:

 Dmz-portal

| MediaWiki | Manual:$wgNamespacesWithSubpages | 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):

As of {{ #ifeq:

 Dmz-portal

| MediaWiki | 1.15+ | 1.15+ }}, these can all take a parameter, allowing specification of the page to be operated on, instead of just the current page:

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

 Dmz-portal

| MediaWiki | 14779 | 14779 }}, {{ #ifeq:

 Dmz-portal

| MediaWiki | 16474 | 16474

}}.|
}}
Error creating thumbnail: Unable to create destination directory
Warning: {{#if: Page titles containing certain characters, such as single quotes (') or asterisks *, may produce unexpected results when handled with these magic words, e.g. {{PAGESINCATEGORY:{{PAGENAME}}}}. See bugs {{ #ifeq:
 Dmz-portal

| MediaWiki | 14779 | 14779 }}, {{ #ifeq:

 Dmz-portal

| MediaWiki | 16474 | 16474

}}.|
Page titles containing certain characters, such as single quotes (') or asterisks *, may produce unexpected results when handled with these magic words, e.g. {{PAGESINCATEGORY:{{PAGENAME}}}}. See bugs {{ #ifeq:
 Dmz-portal

| MediaWiki | 14779 | 14779 }}, {{ #ifeq:

 Dmz-portal

| MediaWiki | 16474 | 16474

}}.
}}

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
{{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):

As of {{ #ifeq:

 Dmz-portal

| MediaWiki | 1.15+ | 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:

Parser functions

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

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

 Dmz-portal

| MediaWiki | ParserFunctions extension | 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}} → /wiki/MediaWiki
{{localurl:MediaWiki|printable=yes}} → /mw/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://dmz-portal.mips.com/wiki/Category:Top_level

{{fullurl:Category:Top level|action=edit}}https://dmz-portal.mips.com/mw/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}}https://dmz-portal.mips.com/mw/images/b/bc/Wiki.png

{{filepath:Wiki.png|nowiki}} → https://dmz-portal.mips.com/mw/images/b/bc/Wiki.png
{{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 ({{ #ifeq:
 Dmz-portal
MediaWiki 1.18+ 1.18+

}}) of a media file.

{{ #ifeq:
 Dmz-portal
MediaWiki 1.12+ 1.12+

}}
{{ #ifeq:

 Dmz-portal
MediaWiki 1.18+ 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. {{ #ifeq:
 Dmz-portal
MediaWiki 1.7+ 1.7+

}} (or {{ #ifeq:

 Dmz-portal
MediaWiki 1.17+ 1.17+

}})
{{ #ifeq:

 Dmz-portal
MediaWiki 1.17+ 1.17+

}}
{{ #ifeq:

 Dmz-portal
MediaWiki 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). {{ #ifeq:
 Dmz-portal
MediaWiki 1.8+ 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}} Dmz-portal {{ns:5}} or {{ns:Project talk}} Dmz-portal 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
{{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
}}
Error creating thumbnail: Unable to create destination directory
Warning: {{#if: |
}}Leading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed
1.7+
{{ #ifeq:
 Dmz-portal
MediaWiki 1.13+ 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.

}}
Error creating thumbnail: Unable to create destination directory
Warning: {{#if: |
}}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).
{{ #ifeq:
 Dmz-portal
MediaWiki 1.15+ 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.
{{ #ifeq:
 Dmz-portal
MediaWiki bug bug

}} (fixed in {{ #ifeq:

 Dmz-portal
MediaWiki r45734 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}} → are
{{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 {{ #ifeq:
 Dmz-portal
MediaWiki Manual:$wgGrammarForms Manual:$wgGrammarForms

}}.

1.7+

Miscellaneous

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox