Help:Magic words

From SoylentNews
Jump to navigation Jump to search

<languages/> Template:TNT <translate> Magic words are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words; for a technical reference, see Manual:Magic words.

There are three general types of magic words:

  • Behavior switches: these are uppercase words surrounded by double underscores, e.g. __FOO__.
  • Variables: these are uppercase words surrounded by double braces, e.g. {{FOO}}. As such, they look a lot like templates.

Variables and parser functions can use subst:, just like templates. 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. </translate>

<translate>

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. </translate>

<translate>

Word</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

<translate>

Table of contents</translate>

__NOTOC__ <translate>

Hides the table of contents (TOC).</translate>

__FORCETOC__ <translate>

Forces the table of contents to appear at its normal position (before the first header).</translate>

__TOC__ <translate>

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.</translate>

<translate>

Editing</translate>

__NOEDITSECTION__ <translate>

Hides the section edit links beside headings. This is especially useful, where a heading is created from within a template: the normal wiki section-edit would in this case edit the template code, which is normally counterintuitive to the user. If a template contains multiple headings, it may be necessary to add "__NOEDITSECTION__" after each heading.</translate>

__NEWSECTIONLINK__ <translate>

Adds a link beside the "edit" tab for adding a new section on a non-talk page (see Adding a section to the end).</translate>

Template:MW version
__NONEWSECTIONLINK__ <translate>

Removes the link beside the "edit" tab on pages in talk namespaces.</translate>

Template:MW version
<translate>

Categories</translate>

__NOGALLERY__ <translate>

Used on a category page, replaces thumbnails in the category view with normal links.</translate>

Template:MW version
__HIDDENCAT__ <translate>

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).</translate>

Template:MW version
<translate>

Language conversion</translate>

__NOCONTENTCONVERT__
__NOCC__
<translate>

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.</translate>

__NOTITLECONVERT__
__NOTC__
<translate>

On wikis with language variants, don't perform language conversion on the title (all other content is converted).</translate>

<translate>

Other</translate>

__START__ <translate>

No effect.</translate>

__END__ <translate>

Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in 19213.</translate>

Template:MW version
__INDEX__ <translate>

Tell search engines to index the page (overrides $wgArticleRobotPolicies, but not robots.txt). It obeys $wgExemptFromUserRobotsControl variable.</translate>

Template:MW version
__NOINDEX__ <translate>

Tell search engines not to index the page (i.e. do not list in search engines' results). It obeys $wgExemptFromUserRobotsControl variable.</translate>

Template:MW version
__STATICREDIRECT__ <translate>

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".</translate>

Template:MW version
__DISAMBIG__ <translate>

Marks a page as a disambiguation page and places it in Special:DisambiguationPages, and places inward links in Special:DisambiguationPageLinks. See Extension:Disambiguator.</translate>

<translate>

requires Disambiguator extension</translate>

<translate>

Variables

Variables return information about the current page, wiki, or date. Their syntax is similar to templates. Variables marked as "[expensive]" are tracked by the software, and the number that can be included on a page is limited.

If a template name conflicts with a variable, the variable will be used (so to transclude the template Template:PAGENAME you would need to write {{Template:PAGENAME}}). In some cases, adding parameters will force the parser to invoke a template; for example, {{CURRENTDAYNAME|x}} transcludes Template:CURRENTDAYNAME, not the variable.

Date and time

The following variables return the current date and time in UTC.

Due to MediaWiki and browser caching, these variables frequently show when the page was cached rather than the current time.

The date and time magic words are formatted in the wiki content language. Since Template:R, they depend on the page content language. </translate>

<translate>

Variable</translate>

<translate>

Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

<translate>

Year</translate>

{{CURRENTYEAR}} 2024 <translate>

Year</translate>

<translate>

Month</translate>

{{CURRENTMONTH}} 12 <translate>

Month (zero-padded number)</translate>

{{CURRENTMONTHNAME}} December <translate>

Month (name)</translate>

{{CURRENTMONTHNAMEGEN}} December <translate>

Month (genitive form)</translate>

{{CURRENTMONTHABBREV}} Dec <translate>

Month (abbreviation)</translate>

Template:MW version
<translate>

Day</translate>

{{CURRENTDAY}} 23 <translate>

Day of the month (unpadded number)</translate>

{{CURRENTDAY2}} 23 <translate>

Day of the month (zero-padded number)</translate>

Template:MW version
{{CURRENTDOW}} 1 <translate>

Day of the week (unpadded number), 0 (for Sunday) through 6 (for Saturday)</translate>

{{CURRENTDAYNAME}} Monday <translate>

Day of the week (name)</translate>

<translate>

Time</translate>

{{CURRENTTIME}} 04:10 <translate>

Time (24-hour HH:mm format)</translate>

{{CURRENTHOUR}} 04 <translate>

Hour (24-hour zero-padded number)</translate>

<translate>

Other</translate>

{{CURRENTWEEK}} 52 <translate>

Week (number)</translate>

{{CURRENTTIMESTAMP}} 20241223041053 <translate>

YYYYMMDDHHmmss timestamp</translate>

Template:MW version

<translate> The following variables do the same as the preceding ones, but using the site's server config or $wgLocaltimezone. </translate>

  • {{LOCALYEAR}}
  • {{LOCALMONTH}}
  • {{LOCALMONTHNAME}}
  • {{LOCALMONTHNAMEGEN}}
  • {{LOCALMONTHABBREV}}
  • {{LOCALDAY}}
  • {{LOCALDAY2}}
  • {{LOCALDOW}}
  • {{LOCALDAYNAME}}
  • {{LOCALTIME}}
  • {{LOCALHOUR}}
  • {{LOCALWEEK}}
  • {{LOCALTIMESTAMP}}

<translate> 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. </translate>

<translate>

Variable</translate>

<translate>

Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

<translate>

Site</translate>

{{SITENAME}} SoylentNews <translate>

The wiki's site name ($wgSitename).</translate>

{{SERVER}} //wiki.soylentnews.org <translate>

Domain URL ($wgServer).</translate>

{{SERVERNAME}} wiki.soylentnews.org <translate>

Subdomain and domain name (no longer dependent on $wgServerName as of version 1.17).</translate>

{{DIRMARK}}
{{DIRECTIONMARK}}

<translate>

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. Since Template:R, it depends on the page content language.</translate>

Template:MW version
{{SCRIPTPATH}} <translate>

Relative script path ($wgScriptPath).</translate>

{{STYLEPATH}} /skins <translate>

Relative style path ($wgStylePath).</translate>

Template:MW version
{{CURRENTVERSION}} 1.41.4 <translate>

The wiki's MediaWiki version.</translate>

Template:MW version
{{CONTENTLANGUAGE}}
{{CONTENTLANG}}
en
en
<translate>

The wiki's default interface language ($wgLanguageCode).</translate>

Template:MW version
<translate>

Page</translate>

{{PAGEID}} 526 <translate>

Returns the page identifier.</translate>

[[gerrit:9858|Template:MW version]]
gerrit:9858
{{PROTECTIONLEVEL: action }} <translate>

Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the current page. Returns an empty string if not protected.</translate>

Template:MW version
<translate>

Latest revision to current page</translate>

{{REVISIONID}} 3710 <translate>

Unique revision ID.</translate>

Template:MW version
{{REVISIONDAY}} 8 <translate>

Day edit was made (unpadded number).</translate>

Template:MW version
{{REVISIONDAY2}} 08 <translate>

Day edit was made (zero-padded number).</translate>

Template:MW version
{{REVISIONMONTH}} 02 <translate>

Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions).</translate>

Template:MW version
{{REVISIONMONTH1}} 2 <translate>

Month edit was made (unpadded number).</translate>

Template:MW version
{{REVISIONYEAR}} 2014 <translate>

Year edit was made.</translate>

Template:MW version
{{REVISIONTIMESTAMP}} 20140208211657 <translate>

Timestamp as of time of edit.</translate>

Template:MW version
{{REVISIONUSER}}
{{URLENCODE:{{REVISIONUSER}}|WIKI}}
FunPika
FunPika
<translate>

The username of the user who made the most recent edit to the page, or the current user when previewing an edit.</translate>

Template:MW version
{{REVISIONSIZE}} 66958 <translate>

The size (bytes of wikitext) of the current revision of this page</translate>

Template:MW version
gerrit:82650
<translate>

Affects page content</translate>

{{DISPLAYTITLE:title}} <translate>

Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores are allowed (this can be changed with $wgRestrictDisplayTitle). It can be disabled or enabled by $wgAllowDisplayTitle; disabled by default before 1.10+, enabled by default thereafter.</translate>

Template:MW version
{{DEFAULTSORT:sortkey}}
{{DEFAULTSORTKEY:sortkey}}
{{DEFAULTCATEGORYSORT:sortkey}}
{{DEFAULTSORT:sortkey|noerror}}
{{DEFAULTSORT:sortkey|noreplace}}
<translate>

Used for categorizing pages, sets a default category sort key. For example if you put {{DEFAULTSORT:Smith, John}} at the end of John Smith, the page would be sorted under "S" by default in categories. It can take a second argument of noerror or noreplace to suppress error messages when multiple defaultsortkeys are used on one page or to make this defaultsort do nothing if a defaultsort was already specified earlier in the page.</translate>

Template:MW version
Template:MW version
(<translate>

for noerror and noreplace</translate>)

<translate>

Statistics

Numbers returned by these variables normally contain separators (commas, dots or spaces, depending on the local language), but can return raw numbers with the ":R" flag (for example, {{NUMBEROFPAGES}} → 10,515 and {{NUMBEROFPAGES:R}} → 10515).

Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}, or {{PAGESINCATEGORY:Help|subcats}} and {{PAGESINCATEGORY:Help|subcats|R}}). Also applicable to {{PAGESIZE:page name}} hereinbefore.

The number magic words are formatted in the wiki content language. Since Template:R, it depends on the page content language. </translate>

<translate>

Variable</translate>

<translate>

Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

{{NUMBEROFPAGES}} 10,515 <translate>

Number of wiki pages.</translate>

Template:MW version
{{NUMBEROFARTICLES}} 124 <translate>

Number of pages in content namespaces.</translate>

{{NUMBEROFFILES}} 41 <translate>

Number of uploaded files.</translate>

Template:MW version
{{NUMBEROFEDITS}} 32,909 <translate>

Number of wiki edits.</translate>

Template:MW version
{{NUMBEROFVIEWS}} Template:NUMBEROFVIEWS <translate>

Number of page views. Usually useless on a wiki using caching.</translate>

Template:MW version
{{NUMBEROFUSERS}} 19,026 <translate>

Number of registered users.</translate>

Template:MW version
{{NUMBEROFADMINS}} 14 <translate>

Number of users in the sysop group.</translate>

Template:MW version
{{NUMBEROFACTIVEUSERS}} 10 <translate>

Number of active users, based on the criteria used in Special:Statistics.</translate>

Template:MW version
{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:categoryname}}
17
17
<translate>

[Expensive] Number of pages (including subcategories and files) in the given category.</translate>

Template:MW version
{{PAGESINCATEGORY:categoryname|all}}
{{PAGESINCATEGORY:categoryname|pages}}
{{PAGESINCATEGORY:categoryname|subcats}}
{{PAGESINCATEGORY:categoryname|files}}
17
17
0
0
<translate>

[Expensive] Respectively, the number of

  • all pages
  • ordinary pages (excluding subcategories and files)
  • subcategories or
  • files

in the given category.</translate>

Template:MW version
gerrit:12790
{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}}
8
8
({{NUMBERINGROUP:bureaucrat}} used here)
<translate>

Number of users in a specific group.</translate>

Template:MW version
{{PAGESINNS:index}}
{{PAGESINNAMESPACE:index}}
<translate>

Not enabled</translate>

<translate>

[Expensive] 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. </translate>

Template:MW version

<translate>

Page names

</translate>

<translate>

Variable</translate>

<translate>

Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

{{FULLPAGENAME}} Help:Magic words <translate>

Namespace and full page title (including all subpage levels).</translate>

Template:MW version
{{PAGENAME}} Magic words <translate>

Full page title (including all subpage levels) without the namespace.</translate>

{{BASEPAGENAME}} Magic words <translate>

Page title of the page in the immediately superior subpage level without the namespace ("Title/foo" on "Help:Title/foo/bar").

For more complex splitting, use {{#titleparts:}} from the ParserFunctions extension.</translate>

Template:MW version
{{SUBPAGENAME}} Magic words <translate>

The subpage title ("bar" on "Help:Title/foo/bar").</translate>

Template:MW version
{{SUBJECTPAGENAME}}
{{ARTICLEPAGENAME}}
Help:Magic words
Help:Magic words
<translate>

Full page name of the associated subject (e.g. article or file). Useful on talk pages.</translate>

Template:MW version
{{TALKPAGENAME}} Help talk:Magic words <translate>

Full page name of the associated talk page.</translate>

Template:MW version

<translate> The {{BASEPAGENAME}} and {{SUBPAGENAME}} magic words only work in namespaces that have subpages enabled. See $wgNamespacesWithSubpages for information on enabling subpages.

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

  • {{PAGENAME:Template:Main Page}}Main Page

Template:Warning

For example, if page name is "L'Aquila", the following code will produce the string "Numeric char encoding":

{{#switch:{{PAGENAME}}
| L'Aquila = No translation
| L = Not OK
| L&apos;Aquila = Entity escaping
| L&#39;Aquila = Numeric char encoding
}}

URL encoded page names

The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters HTML escaped using numeric character encoding): </translate>

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

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

Namespaces

</translate>

<translate>

Variable</translate>

<translate>

Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

{{NAMESPACE}} Help <translate>

Name of the page's namespace</translate>

{{NAMESPACENUMBER}} 12 <translate>

ID of the page's namespace</translate>

Template:MW version
gerrit:4056
{{SUBJECTSPACE}}
{{ARTICLESPACE}}
Help
Help
<translate>

Name of the associated content namespace</translate>

Template:MW version
{{TALKSPACE}} Help talk <translate>

Name of the associated talk namespace</translate>

Template:MW version

<translate> The following are equivalents encoded for use in MediaWiki URLs (spaces replaced with underscores and some characters percent-encoded): </translate>

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

<translate> As of 1.15+, these can take a full-page-name parameter and will return the requested namespace associated with that page, instead of with the current page: </translate>

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

<translate> Parameter must not be a namespace name: </translate>

  • {{SUBJECTSPACE:Help talk}}  (Empty)

<translate>

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

Technical metadata of another page

</translate>

<translate>

Parser function</translate>

<translate>

Output
(for page MediaWiki)</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

{{PAGEID: page name }} 0 <translate>

[Expensive] Returns the page identifier of the specified page*.</translate>

Template:MW version
gerrit:76534
{{PAGESIZE: page name }}
{{PAGESIZE: page name |R}}
0
0
<translate>

[Expensive] Returns the byte size of the specified page. Use "|R" to get raw (unformatted) numbers.</translate>

Template:MW version
{{PROTECTIONLEVEL: action | page name }} <translate>

[Expensive] Outputs the protection level (e.g. "autoconfirmed", "sysop") for a given action (e.g. "edit", "move") on the specified page. Returns an empty string if not protected.</translate>

Template:MW version
{{REVISIONID: page name }} <translate>

[Expensive] Unique revision ID of the last revision on the specified page*.</translate>

Template:MW version
gerrit:76534
{{REVISIONDAY: page name }} 0 <translate>

[Expensive] Day of edit from the last revision of the specified page* (unpadded number).</translate>

Template:MW version
gerrit:76534
{{REVISIONDAY2: page name }} <translate>

[Expensive] Day of edit from the last revision of the specified page* (zero-padded number).</translate>

Template:MW version
gerrit:76534
{{REVISIONMONTH: page name }} <translate>

[Expensive] Month of edit from the last revision of the specified page* (zero-padded number as of 1.17+, unpadded number in prior versions).</translate>

Template:MW version
gerrit:76534
{{REVISIONMONTH1: page name }} 0 <translate>

[Expensive] Month of edit from the last revision of the specified page* (unpadded number).</translate>

Template:MW version
gerrit:76534
{{REVISIONYEAR: page name }} <translate>

[Expensive] Year of edit from the last revision of the specified page*.</translate>

Template:MW version
gerrit:76534
{{REVISIONTIMESTAMP: page name }} <translate>

[Expensive] Timestamp as of time of edit on the specified page*.</translate>

Template:MW version
gerrit:76534
{{REVISIONUSER: page name }} <translate>

[Expensive] The username from the last revision on the specified page*.</translate>

Template:MW version
gerrit:76534
<translate>
  • When the given param is equal to the current title of the parser, the parser function will yield the previous versions on preview and on substitution, that includes empty strings when used on page creation, but using the values from the current version for page view, including viewing old revisions. In this case it is a non-expensive parser function.</translate>

<translate>

URL data

</translate>

<translate>

Parser function</translate>

<translate>

Input → Output</translate>

<translate>

Description</translate>

<translate>

Versions</translate>

{{localurl:page name}}
{{localurl:page name|query_string}}
{{localurl:MediaWiki}} → /wiki/MediaWiki
{{localurl:MediaWiki|printable=yes}} → /index.php?title=MediaWiki&printable=yes
<translate>

The relative path to the title. </translate>

{{fullurl:page name}}
{{fullurl:page name|query_string}}
{{fullurl:interwiki:remote page name|query_string}}
{{fullurl:Category:Top level}} → //wiki.soylentnews.org/wiki/Category:Top_level

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

<translate>

A protocol-relative path to the title. This will also resolve interwiki prefixes. Note: Unbracketed (plain) protocol-relative links are not automagically linked.</translate>

Template:MW version
{{canonicalurl:page name}}
{{canonicalurl:page name|query_string}}
{{canonicalurl:interwiki:remote page name|query_string}}
{{canonicalurl:Category:Top level}}https://wiki.soylentnews.org/wiki/Category:Top_level

{{canonicalurl:Category:Top level|action=edit}}https://wiki.soylentnews.org/index.php?title=Category:Top_level&action=edit

<translate>

The absolute path to the title, using the canonical URL. This will also resolve interwiki prefixes.</translate>

Template:MW version
{{filepath:file name}}
{{filepath:file name|nowiki}}
{{filepath:file name|thumbnail_size}}
{{filepath:Wiki.png}}

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

<translate>

A protocol-relative path to the full size or thumbnail (1.18+) of a media file.</translate>

Template:MW version
Template:MW version
{{urlencode:string}} (or {{urlencode:string|QUERY}})
{{urlencode:string|WIKI}}
{{urlencode:string|PATH}}
{{urlencode:x:y/z á é}} (or {{urlencode:x:y/z á é|QUERY}}) → x%3Ay%2Fz+%C3%A1+%C3%A9
{{urlencode:x:y/z á é|WIKI}} → x:y/z_%C3%A1_%C3%A9
{{urlencode:x:y/z á é|PATH}} → x%3Ay%2Fz%20%C3%A1%20%C3%A9

<translate> Note that the default changed from |WIKI to |QUERY in 1.17; this may break templates that rely on this function.</translate>

<translate>

The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete Extension:StringFunctions.</translate>

Template:MW version (or Template:MW version
Template:MW version
Template:MW version)
{{anchorencode:string}} {{anchorencode:x y z á é}} → x_y_z_á_é <translate>

The input encoded for use in URL section anchors (after the “#” symbol in a URL).</translate>

Template:MW version

<translate>

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 is French, {{ns:Fichier}} is also valid, but {{ns:Datei}} (the localisation of "File" in German) is 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. </translate>

<translate>

Content namespaces</translate>

<translate>

Talk namespaces</translate>

<translate>

Usage</translate>

<translate>

Output</translate>

<translate>

Usage</translate>

<translate>

Output</translate>

{{ns:-2}} / {{ns:Media}} Media
{{ns:-1}} / {{ns:Special}} Special
{{ns:0}} / {{ns:}} {{ns:1}} / {{ns:Talk}} Talk
{{ns:2}} / {{ns:User}} User {{ns:3}} / {{ns:User talk}} User talk
{{ns:4}} / {{ns:Project}} SoylentNews
Varies between wikis
{{ns:5}} / {{ns:Project talk}} SoylentNews talk
{{ns:6}} / {{ns:File}} or {{ns:Image}} File {{ns:7}} / {{ns:File talk}} or {{ns:Image talk}} File talk
{{ns:8}} / {{ns:MediaWiki}} MediaWiki {{ns:9}} / {{ns:MediaWiki talk}} MediaWiki talk
{{ns:10}} / {{ns:Template}} Template {{ns:11}} / {{ns:Template talk}} Template talk
{{ns:12}} / {{ns:Help}} Help {{ns:13}} / {{ns:Help talk}} Help talk
{{ns:14}} / {{ns:Category}} Category {{ns:15}} / {{ns:Category talk}} Category talk

<translate> Don't confuse localised namespaces with custom namespaces.

Formatting

</translate>


<translate>

Usage</translate>

<translate>

Input → Output</translate>

<translate>

Description</translate>

<translate>

Version</translate>

{{formatnum:unformatted number}}

{{formatnum:formatnum-formatted number|R}}
{{formatnum:unformatted number|NOSEP}}

  • <translate>

Simple:</translate>

    • {{formatnum:987654321.654321}}
      → 987,654,321.654321
    • {{formatnum:987,654,321.654321|R}}
      → 987654321.654321
  • <translate>

Advanced:</translate>

    • {{formatnum:{{formatnum:987654321.654321}}|R}}
      → 987654321.654321 <translate>

(on any locale)</translate>

    • {{formatnum:00001}}
      → 00,001
    • <translate>

Examples with हिन्दी locale:</translate>

      • {{formatnum:987654321.654321}}
        → 98,76,54,321.654321
      • {{formatnum:987654321.654321 |NOSEP}}
        → 987654321.654321
      • {{formatnum:98,76,54,321.654321 |NOSEP|R}}
        → 98,76,54,321.654321

<translate> Unsupported:</translate>
{{formatnum:{{formatnum:987.654.321}}}}
→ 987 654 321 <translate> (e.g. with Italian locale)</translate>


<translate> Examples of wrong input (unreliable output), with or without |R:</translate>
{{formatnum:987,654.321|R}} <translate> (the least broken)</translate>
{{formatnum:987.654,321|R}}
{{formatnum:987 654,321|R}}
{{formatnum:987&nbsp;654,321|R}}

<translate>

Takes an unformatted number (arab, no group separators and . as decimal separator) and outputs it in the localized digit script and formatted with decimal and decimal group separators, according to the wiki's default locale.
The |R parameter can be used to reverse the behavior, for use in mathematical situations: it's reliable and should be used only to deformat numbers who are known to be formatted exactly as formatnum formats them with the wiki's locale. </translate>
Template:TNT <translate> Leading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed.</translate>

Template:TNT <translate> If you don't input numbers in the exact format required, don't expect any reliable output, especially on non-English wikis.</translate>

Template:TNT <translate> The NOSEP ("no separators") parameter means that no group / decimal separators are changed; formatnum will only transform the digits themselves in languages which don't use the Hindu–Arabic numeral system. NOSEP can also prevent non-standard digit groupings you wouldn't expect.</translate>


<translate> If you really need to format (according the wiki's locale) a number in unknown input format, you could try and use formatnum two times (but not if it can have a decimal group, or its separator will be eaten or the number won't be formatted). </translate>

Template:MW version
Template:MW version

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

{{#dateformat:25 deC 2009|ymd}}
2009 December 25 <translate> (your pref), 2009 DeC 25 (default)</translate>
{{#formatdate:dec 25,2009|dmy}}
25 December 2009 <translate> (your pref), 25 Dec 2009 (default)</translate>
{{#dateformat:2009-12-25|mdy}}
December 25, 2009 <translate> (your pref), December 25, 2009 (default)</translate>
{{#formatdate:2009 dec 25|ISO 8601}}
2009-12-25 <translate> (your pref), 2009-12-25 (default)</translate>
{{#dateformat:25 decEmber|mdy}}
December 25 <translate> (your pref), DecEmber 25 (default)</translate>
<translate> Note: In the example hereinbefore, "your pref" refers to your date preference on the current MediaWiki wiki only. </translate>

<translate>

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. </translate>

Template:TNT<translate> 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).</translate>

Template:MW version
{{lc:string}} {{lc:DATA CENTER}} → data center <translate>

The lowercase input.</translate>

Template:MW version
{{lcfirst:string}} {{lcfirst:DATA center}} → dATA center <translate>

The input with the very first character lowercase.</translate>

Template:MW version
{{uc:string}} {{uc:text transform}} → TEXT TRANSFORM <translate>

The uppercase input.</translate>

Template:MW version
{{ucfirst:string}} {{ucfirst:text TRANSFORM}} → Text TRANSFORM <translate>

The input with the very first character uppercase.</translate>

Template:MW version
{{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 <translate>

(first character of the string)</translate>

<translate>

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.

Only the first character of the third parameter is used in versions up to 1.12, but by version 1.15 all the characters are used.

Bug (fixed in r45734): multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters.</translate>

Template:MW version
{{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

<translate>

Identical to padleft, but adds padding characters to the right side.</translate>

Template:MW version

<translate> See also: Extension:StringFunctions.

Localisation

Here are the magic words which are used as main localisation tools. Other magic words will often depend on the wiki's locale and configuration or on the chosen language: see in particular #Date and time, #Formatting, #Miscellaneous. More magic words are added by the Translate extension.

The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on PLURAL, GRAMMAR, GENDER. </translate>

<translate>

Usage</translate>

<translate>

Input → Output</translate>

<translate>

Description</translate>

<translate>

Version</translate>

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

(For Polish)</translate>
{{plural:2|milion|miliony|milionów}} → miliony
{{plural:5|milion|miliony|milionów}} → milionów

<translate>

Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. Its functioning is language-dependent. Plural transformations are used for languages like Russian based on "count mod 10". You should not expect this to handle fractions (like 44.5) — see bug 28128.</translate>

{{grammar:N|noun}} <translate>

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 $wgGrammarForms.</translate>

Template:MW version
{{gender:username
|return text if user is male
|return text if user is female
|return text if user hasn't defined their gender}}
<translate>

(Depends on the named user's gender)</translate>

<translate>

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.</translate>

Template:MW version
{{int:message name}} {{int:edit}}Edit
<translate>

(Depends on user language; try: fr • ja)</translate>

<translate>

Internationalizes (translates) the given interface (MediaWiki namespace) message into the user language. For msgnw and other transclusion magic words, see Help:Magic words#Template modifiers. Note that this can damage / confuse cache consistency in MediaWiki 1.17 and earlier, see bug 14404.</translate>

{{int:editsectionhint|MediaWiki}} {{int:editsectionhint|MediaWiki}}Edit section: MediaWiki <translate>

You may also use parameters with translations.
Parameters are designated in messages with: $1, $2, $3, etc.
For example, here is the message for editsectionhint: Edit section: $1
In this example, MediaWiki replaces $1.</translate>

<translate>

Miscellaneous

</translate>

[[Category:HelpTemplate:Langcat|Magic words]] [[Category:TimeTemplate:Langcat|Magic words]] [[Category:Magic wordsTemplate:Langcat|Magic words]]