Help:Magic words

From HPCRL Wiki
(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 Template:Mediawiki.

There are three general types of magic words:

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.

Contents

Behaviour switches

A behaviour 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 Template:Mediawiki). 1.7+
__NONEWSECTIONLINK__ Removes the link beside the "edit" tab on pages in talk namespaces. Template:Mediawiki
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 Template:Mediawiki.
__INDEX__ Tell search engines to index the page (overrides Template:Mediawiki, but not robots.txt). 1.14+
__NOINDEX__ Tell search engines not to index the page (ie, do not list in search engines' results). Template:Mediawiki
__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". Template:Mediawiki

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 treat a variable as a template; for example, {{CURRENTDAYNAME|x}} transcludes Template:CURRENTDAYNAME.

Template:Admin tip

Date & time

The following variables return the current date and time according to the user's timezone preferences, defaulting to the UTC timezone.

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}} 2017 Year
Template:Hl3 colspan="4"| Month
{{CURRENTMONTH}} 09 Month (zero-padded number)
{{CURRENTMONTHNAME}} September Month (name)
{{CURRENTMONTHNAMEGEN}} September Month (genitive form)
{{CURRENTMONTHABBREV}} Sep Month (abbreviation) 1.5+
Template:Hl3 colspan="4"| Day
{{CURRENTDAY}} 20 Day of the month (unpadded number)
{{CURRENTDAY2}} 20 Day of the month (zero-padded number) 1.6+
{{CURRENTDOW}} 3 Day of the week (unpadded number)
{{CURRENTDAYNAME}} Wednesday Day of the week (name)
Template:Hl3 colspan="4"| Time
{{CURRENTTIME}} 11:14 Time (24-hour HH:mm format)
{{CURRENTHOUR}} 11 Hour (24-hour zero-padded number)
Template:Hl3 colspan="4"| Other
{{CURRENTWEEK}} 38 Week (number)
{{CURRENTTIMESTAMP}} 20170920111416 YYYYMMDDHHmmss timestamp 1.7+

The following variables do the same as the above, but using the site's local timezone instead of user preferences and UTC:

  • {{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

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}} HPCRL Wiki The wiki's site name (Template:Mediawiki).
{{SERVER}} http://hpcrl.cse.ohio-state.edu domain URL (Template:Mediawiki)
{{SERVERNAME}} hpcrl.cse.ohio-state.edu domain name (Template:Mediawiki)
{{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. 1.7+
{{SCRIPTPATH}} /wiki relative script path (Template:Mediawiki)
{{CURRENTVERSION}} 1.17.0 The wiki's MediaWiki version. 1.7+
{{CONTENTLANGUAGE}}
{{CONTENTLANG}}
en
en
The wiki's default interface language (Template:Mediawiki) 1.7+
Template:Hl3 colspan="4"| Latest revision to current page
{{REVISIONID}}
{{REVISIONID:pagename}}
1217
 
Unique revision ID
[expensive] ...of the specified page title
1.5+
Template:Mediawiki
{{REVISIONDAY}}
{{REVISIONDAY:pagename}}
12
 
Day edit was made (unpadded number)
[expensive] ...of the specified page title
1.8+
Template:Mediawiki
{{REVISIONDAY2}}
{{REVISIONDAY2:pagename}}
12
 
Day edit was made (zero-padded number)
[expensive] ...of the specified page title
1.8+
Template:Mediawiki
{{REVISIONMONTH}}
{{RREVISIONMONTH:pagename}}
05
 
Month edit was made (unpadded number)
[expensive] ...of the specified page title
1.8+
Template:Mediawiki
{{REVISIONYEAR}}
{{REVISIONYEAR:pagename}}
2009
 
Year edit was made
[expensive] ...of the specified page title
1.8+
Template:Mediawiki
{{REVISIONTIMESTAMP}}
{{REVISIONTIMESTAMP:pagename}}
20090512214320
 
Timestamp as of time of edit
[expensive] ...of the specified page title
1.8+
Template:Mediawiki
{{REVISIONUSER}}
{{REVISIONUSER:pagename}}
</tt>
Jim  The username of the user who made the most recent edit to the page
[expensive] ...of the specified page title
1.15+
Template:Mediawiki
{{PAGESIZE:page name}} 30,186 [expensive] Returns the byte size of the specified page. Template:Mediawiki
{{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 Template:Mediawiki; 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:{{PAGENAME}}}}[[Category:Pupiling]] at the end of articleX, articleX will be placed at letter "P" in the Category:Pupiling page. 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}} → 95 and {{NUMBEROFPAGES:R}} → 95). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}).

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
Template:Hl3 colspan="4"| Entire wiki
{{NUMBEROFPAGES}} 95 Number of wiki pages. 1.7+
{{NUMBEROFARTICLES}} 17 Number of pages in main namespace.
{{NUMBEROFFILES}} 5 Number of uploaded files. 1.5+
{{NUMBEROFEDITS}} 1,619 Number of page edits. Template:Mediawiki
{{NUMBEROFVIEWS}} 2,183,499 Number of page views. Usually useless on a wiki using caching. Template:Mediawiki
{{NUMBEROFUSERS}} 594,029 Number of registered users. 1.7+
{{NUMBEROFADMINS}} 9 Number of users in the sysop Template:Mediawiki. 1.7+
{{NUMBEROFACTIVEUSERS}} 0 Number of active users, based on the criteria used in Special:Statistics. Template:Mediawiki
{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:Help}}
54
54
[expensive] Number of pages in the given category (replace "Help" with the relevant category name). Template:Mediawiki
{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}}
14
14
({{NUMBERINGROUP:bureaucrat}} used here)
Number of users in a specific Template:Mediawiki. Template:Mediawiki
{{PAGESINNS:index}}
{{PAGESINNAMESPACE:index}}
not enabled Number of pages in the given namespace (replace 2 with the relevant namespace index). E.g. {{PAGESINNAMESPACE:14}} equals the number of categories. Disabled by default, enable with Template:Mediawiki. 1.7+

Page names

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" on "Title/foo"). 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 content page. 1.7+
{{TALKPAGENAME}} Help talk:Magic words The namespace and title of the associated talk page. 1.7+

The following are URL-encoded equivalents:

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

As of Template:Mediawiki, 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

Namespaces

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
{{NAMESPACE}} Help Namespace (name)
{{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 URL-encoded equivalents:

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

As of Template:Mediawiki, these can all take a parameter, specifying the property should be returned for a given title instead of the current page:

  • {{NAMESPACE:Template:Main Page}} -> Template

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 usually prefixed with a hash to distinguish them from possible 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 Template:Mediawiki.

URL data

Template:Hl2| Variable Template:Hl2| Output Template:Hl2| Description Template:Hl2| Versions
{{localurl:page name}}
{{localurl:page name|query string}}
/wiki/index.php/Page_name
/wiki/index.php?title=Page_name&query string
The relative path to the title.
{{fullurl:page name}}
{{fullurl:page name|query_string}}
{{fullurl:interwiki:remote page name|query_string}}
http://hpcrl.cse.ohio-state.edu/wiki/index.php/Page_name
http://hpcrl.cse.ohio-state.edu/wiki/index.php?title=Page_name&query_string
The absolute path to the title. This will also resolve Interwiki prefixes. 1.5+
{{filepath:file name}}
{{filepath:file name|nowiki}}

The absolute URL to a media file. Template:Mediawiki
{{urlencode:string}} x+y+z The input encoded for use in URLs. Template:Mediawiki
{{anchorencode:string}} x_y_z The input encoded for use in URL section anchors (after the '#' symbol in a URL). Template:Mediawiki

Namespaces

{{ns:}} returns the localized name for the namespace with that index.

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}} {{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}} HPCRL Wiki {{ns:5}} or {{ns:Project talk}} HPCRL Wiki talk
{{ns:6}} or {{ns:File}} or {{ns:Image}} File {{ns:7}} or {{ns:File talk}} or {{ns:Image talk}} File talk
{{ns:8}} or {{ns:MediaWiki}} MediaWiki {{ns:9}} or {{ns:MediaWiki talk}} MediaWiki talk
{{ns:10}} or {{ns:Template}} Template {{ns:11}} or {{ns:Template talk}} Template talk
{{ns:12}} or {{ns:Help}} Help {{ns:13}} or {{ns:Help talk}} Help talk
{{ns:14}} or {{ns:Category}} Category {{ns:15}} or {{ns:Category talk}} Category talk

Formatting

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 number}}
{{formatnum:formatted number|R}}
{{formatnum:-987654321.654321}} → -987,654,321.654321
{{formatnum:-987,654,321.654321|R}} → -987654321.654321
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. 1.7+
1.13+
{{#formatdate:date}}
{{#dateformat:date}}
{{#formatdate:date|format}}
{{#formatdate:May 10, 2001}} → May 10, 2001
{{#dateformat:May 10, 2001}} → May 10, 2001
{{#formatdate:May 10, 2001|ISO 8601}} → 2001-05-10
Formats an unlinked date based on user 'Date format' preference.
For logged-out users and those who have not set a date format in their preferences, dates can be given a default: default (site default), mdy, dmy, ymd, ISO 8601.
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).
1.15+
{{padleft:xyz|stringlength}}
{{padleft:xyz|stringlength|character}}
{{padleft:xyz|5}} → 00xyz
{{padleft:xyz|5|_}} → __xyz
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.
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|stringlength|character}}
{{padright:xyz|5}} → xyz00
{{padright:xyz|5|_}} → xyz__
Identical to padleft, but adds padding characters to the right side.
{{plural:2|is|are}} Outputs the correct given pluralization form (parameters except first) depending on the count (first parameter). Plural transformations are used for languages like Russian based on "count mod 10".
{{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 Template:Mediawiki.

1.7+

Miscellaneous

Template:Hl2| Usage Template:Hl2| Output Template:Hl2| Description Template:Hl2| Version
{{int:message name}}
<tt>{{int:edit}}
Edit
(depends on user language, try: frja)
Internationalizes (translates) the given interface (MediaWiki namespace) message into the user language. Note that this can damage/confuse cache consistency, see bug 14404.
<tt>{{#language:language code}}
{{#language:ar}}
{{#language:th}}
language code
العربية
ไทย
The native name for the given language code, in accordance with ISO 639. Template:Mediawiki
{{#special:special page name}}
{{#special:Special:UserLogin}}
No such special page
Special:UserLogin
The localized name for the given canonical Special: page. Template:Mediawiki
{{#tag:tagname}}
{{#tag:tagname
|tag content
|parameter=value
|parameter2=value
}}
(depends on parser tag) Alias for XML-style parser or extension tags, but parsing wiki code. Attribute values can be passed as parameter values ('<tagname attribute="value">' → '{{#tag:tagname|attribute=value}}'), and inner content as an unnamed parameter ('<tagname>content</tagname>' → '{{#tag:tagname|content}}'). 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 1.15+

Template:Languages

Personal tools