View source for Help:Magic words

From Starfleet Commander

← Help:Magic words

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{{NHP}} '''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}}. 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}}. Page-dependent magic words will affect or return data about the ''current'' page (by default), even if the word is added through a transcluded template or included system message. ==Behavior switches== A behavior switch controls the layout or behavior of the page and can often be used to specify desired omissions and inclusions in the content. {| class="wikitable" |- ! {{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. The date and time magic words are formatted in the wiki content language. Since {{r|94680|1.19}}, they depend on the {{drl|page content language|page content language}}. {| 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+ |} 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> :''For more thorough time formatting, you may want to install <span style="color: #C20;"><nowiki>[[Extension:ParserFunctions]]</nowiki></span> to use the <span style="color: #C20;"><nowiki>[[Help:Extension:ParserFunctions#.23time|#time parser function]]</nowiki></span>'' ===Technical metadata=== ''Note:'' Revision variables return data about the '''latest edit to the current page''', even if viewing an older version of the page. {| class="wikitable" |- ! {{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. Since {{r|94680|1.19}}, it depends on the [[page content language]]. | {{r|14442|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. | {{r|14199|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}}) | {{r|14661|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>{{REVISIONMONTH1}}</nowiki></code> | {{REVISIONMONTH1}} | Month edit was made (unpadded number) | {{mediawiki|rev:66200|1.17+}} |- | <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. 'autoconfirmed', '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. The number magic words are formatted in the wiki content language. Since {{r|94680|1.19}}, it depends on the [[page content language]]. {| 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+ |} 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. The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters [[wikipedia:percent-encoding|percent-encoded]]): * <code><nowiki>{{FULLPAGENAMEE}}</nowiki></code> * <code><nowiki>{{PAGENAMEE}}</nowiki></code> * <code><nowiki>{{BASEPAGENAMEE}}</nowiki></code> * <code><nowiki>{{SUBPAGENAMEE}}</nowiki></code> * <code><nowiki>{{SUBJECTPAGENAMEE}}</nowiki></code> * <code><nowiki>{{TALKPAGENAMEE}}</nowiki></code> 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: * <code><nowiki>{{PAGENAME:Template:Main Page}}</nowiki></code> &rarr; '''{{PAGENAME:Template:Main Page}}''' {{Warning|Page titles containing certain characters, such as single quotes (') or asterisks <code>*</code>, may produce unexpected results when handled with these magic words, e.g. <code><nowiki>{{PAGESINCATEGORY:{{PAGENAME}}}}</nowiki></code>. See bugs {{mediawiki|bugzilla:14779|14779}}, {{mediawiki|bugzilla:16474|16474}}.}} 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. ===Namespaces=== {| class="wikitable" |- ! {{Hl2}}| Variable ! {{Hl2}}| Output ! {{Hl2}}| Description ! {{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+ |} The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded): * <code><nowiki>{{NAMESPACEE}}</nowiki></code> * <code><nowiki>{{SUBJECTSPACEE}}</nowiki></code> * <code><nowiki>{{TALKSPACEE}}</nowiki></code> 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 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 current localized name for the [[Help:Namespaces|namespace]] with that index, canonical name, or local alias. Thus <code><nowiki>{{ns:6}}</nowiki></code>, <code><nowiki>{{ns:File}}</nowiki></code>, and <code><nowiki>{{ns:Image}}</nowiki></code> (an old name for the File namespace) all return "{{ns:6}}". On a wiki where the content language was French, <code><nowiki>{{ns:Fichier}}</nowiki></code> would also be valid, but <code><nowiki>{{ns:Datei}}</nowiki></code> (the localisation of "File" into German) would not. <code><nowiki>{{nse:}}</nowiki></code> is the equivalent encoded for MediaWiki URLs. It does the same, but it replaces spaces with underscores, making it usable in external links. {| 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=== <!--Well gosh, with the source of the examples hidden, who can tell what you are inputting without looking here in the source?--> {| class="wikitable" ! {{Hl2}}| Usage ! {{Hl2}}| Input → Output ! {{Hl2}}| Description ! {{Hl2}}| Version |- |- | <code><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></code> | <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/> Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only. | Formats an unlinked date based on user "Date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: <code>mdy</code>, <code>dmy</code>, <code>ymd</code>, <code>ISO&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> | {{mediawiki|rev:48249|1.15+}} |- | <code><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''char''<nowiki>}}</nowiki></code><br /><code><nowiki>{{padleft:xyz|</nowiki>''strlen''<nowiki>|</nowiki>''string''<nowiki>}}</nowiki></code> | <code><nowiki>{{padleft:xyz|5}}</nowiki></code> → {{padleft:xyz|5}}<br /> <code><nowiki>{{padleft:xyz|5|_}}</nowiki></code> → {{padleft:xyz|5|_}} <code><nowiki>{{padleft:xyz|5|abc}}</nowiki></code> → {{padleft:xyz|5|abc}} <code><nowiki>{{padleft:xyz|2}}</nowiki></code> → {{padleft:xyz|2}}<br /> <code><nowiki>{{padleft:|1|xyz}}</nowiki></code> → {{padleft:|1|xyz}} (first character of the string)<br /> | 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. | 1.8+ |- | <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+ |} ===Miscellaneous=== {| class="wikitable plainlinks" ! {{Hl2}}| Usage ! {{Hl2}}| Output ! {{Hl2}}| Description ! {{Hl2}}| Version |- | <code><nowiki>{{int:</nowiki>''message name''<nowiki>}}</nowiki> | <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:</nowiki>''language code''<nowiki>|</nowiki>''target language code''<nowiki>}}</nowiki></code><br /> <code><nowiki>{{#language:ar|en}}</nowiki></code> | {{#language:language code}}<br />{{#language:ar}}<br />{{#language:language code|target language code}}<br />Arabic | The full name of the language for the given language code: native name by default, name translated in target language if a target language code is specified. Codes are mostly in accordance with [[w:ISO 639|ISO 639]]. | {{mediawiki|rev:14490|1.7+}} 1.19+ (translation) |- | <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: <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> '''Warning''' : You must write <code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>||</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code> to pass an empty content. No space is permitted between the {{!}} and the attribute name. | {{mediawiki|rev:29482|1.12+}} |- | <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:Help|{{PAGENAME}}]]--> [[Category:Time|{{PAGENAME}}]] [[Category:Magic words|{{PAGENAME}}]]

Return to Help:Magic words.