Help:Magic Words: Difference between revisions

VisualWikitext
mNo edit summary
(Updating from http://www.mediawiki.org/wiki/Help:Magic_words)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{help}}
{{help|[[magic]]|MW}}


'''Magic Words''' are phrases recognised by MediaWiki which perform special functions, such as showing a Table of Contents, or the name of the current page.
'''Magic Words''' are strings of text recognised by MediaWiki which perform special functions, such as outputting the name of the current page, showing or hiding the Table of Contents, or adjusting some text for use in a URL.


:''Read more at: http://meta.wikimedia.org/wiki/Help:Magic_words''
:''Read more at: http://meta.wikimedia.org/wiki/Help:Magic_words''


==Forces==
There are three general types of magic words:
These Magic Words force something to show, or be hidden
*'''[[#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}}.


{|class="wikitable"
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.
!Magic Word
 
!Description
==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 contents 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. 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.
|
|-
| <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+}}
|-
|-
|<nowiki>__TOC__</nowiki>
! {{Hl3}} colspan="3"| '''Categories'''
|Shows the Table of Contents here, if its required
|-
|-
|<nowiki>__NOTOC__</nowiki>
| <code><nowiki>__NOGALLERY__</nowiki></code>
|Stops the Table of Contents from showing
| Used on a category page, replaces thumbnails in the category view with normal links.
| 1.7+
|-
|-
|<nowiki>__TOC__</nowiki>
| <code><nowiki>__HIDDENCAT__</nowiki></code>
|Forces the Table of Contents to show here, even if not required
| 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+
|-
|-
|[[Template:toc|<nowiki>{{toc}}</nowiki>]]
! {{Hl3}} colspan="3"| '''Language conversion'''
|Floats the Table of Contents to the right
|-
|-
|[[Template:tocleft|<nowiki>{{tocleft}}</nowiki>]]
| <code><nowiki>__NOCONTENTCONVERT__</nowiki></code> <br /> <code><nowiki>__NOCC__</nowiki></code>
|Floats the Table of Contents to the left
| 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.
|
|-
|-
|<nowiki>__NOEDITSECTION__</nowiki>
| <code><nowiki>__NOTITLECONVERT__</nowiki></code> <br /> <code><nowiki>__NOTC__</nowiki></code>
|Stops the [edit] links from showing on this page
| On wikis with language variants, don't perform language conversion on the title (all other content is converted).
|
|-
|-
|<nowiki>__NEWSECTIONLINK__</nowiki>
! {{Hl3}} colspan="3"| '''Other'''
|Makes a + button appear next to the edit tab, eg for adding a new section to a talk page
|-
|-
|<nowiki>__NOGALLERY__</nowiki>
| <code><nowiki>__START__</nowiki></code>
|In a category page, make images show up in a list rather than in a thumbnail gallery
| No effect.
|
|-
|-
|<nowiki>__HIDDENCAT__</nowiki>
| <code><nowiki>__END__</nowiki></code>
|In a category page, stops that category from showing up in the horizontal box on the bottom of pages within that category
| 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.


==Variables==
Due to MediaWiki and browser caching, these variables frequently show when the page was ''cached'' rather than the current time.
These Magic Words echo out the contents of a variable, such as the date, or article name.


The date and time magic words are formatted in the wiki content language. Since {{r|94680|1.19}}, they depend on the [[page content language]].


===Date/Time===
{| class="wikitable"
{|class="wikitable"
|-
!Magic Word
! {{Hl2}}| Variable
!Example
! {{Hl2}}| Output
!Description
! {{Hl2}}| Description
! {{Hl2}}| Versions
|-
! {{Hl3}} colspan="4"| '''Year'''
|-
| <code><nowiki>{{CURRENTYEAR}}</nowiki></code>
| {{CURRENTYEAR}}
| Year
|
|-
! {{Hl3}} colspan="4"| '''Month'''
|-
|-
|<nowiki>{{CURRENTDAY}}</nowiki>
| <code><nowiki>{{CURRENTMONTH}}</nowiki></code>  
|{{CURRENTDAY}}
| {{CURRENTMONTH}}
|The day of the month (eg 1)
| Month (zero-padded number)
|
|-
|-
|<nowiki>{{CURRENTDAY2}}</nowiki>
| <code><nowiki>{{CURRENTMONTHNAME}}</nowiki></code>
|{{CURRENTDAY2}}
| {{CURRENTMONTHNAME}}
|The day of the month, with a leading zero (eg 01)
| Month (name)
|
|-
|-
|<nowiki>{{CURRENTDAYNAME}}</nowiki>
| <code><nowiki>{{CURRENTMONTHNAMEGEN}}</nowiki></code>
|{{CURRENTDAYNAME}}
| {{CURRENTMONTHNAMEGEN}}
|The full name of the current day
| Month ([[wikipedia:genitive|genitive form]])
|
|-
|-
|<nowiki>{{CURRENTDOW}}</nowiki>
| <code><nowiki>{{CURRENTMONTHABBREV}}</nowiki></code>
|{{CURRENTDOW}}
| {{CURRENTMONTHABBREV}}
|The numeric representation of the day of the week
| Month (abbreviation)
| 1.5+
|-
|-
|<nowiki>{{CURRENTMONTH}}</nowiki>
! {{Hl3}} colspan="4"| '''Day'''
|{{CURRENTMONTH}}
|The number of the current month, with a leading zero (eg 01)
|-
|-
|<nowiki>{{CURRENTMONTHNAME}}</nowiki>
| <code><nowiki>{{CURRENTDAY}}</nowiki></code>
|{{CURRENTMONTHNAME}}
| {{CURRENTDAY}}
|The full name of the current month
| Day of the month (unpadded number)
|
|-
|-
|<nowiki>{{CURRENTMONTHABBREV}}</nowiki>
| <code><nowiki>{{CURRENTDAY2}}</nowiki></code>
|{{CURRENTMONTHABBREV}}
| {{CURRENTDAY2}}
|The abbreviated name of the current month
| Day of the month (zero-padded number)
| 1.6+
|-
|-
|<nowiki>{{CURRENTTIME}}</nowiki>
| <code><nowiki>{{CURRENTDOW}}</nowiki></code>
|{{CURRENTTIME}}
| {{CURRENTDOW}}
|The current time in 24h format
| Day of the week (unpadded number), 0 (for Sunday) through 6 (for Saturday)
|
|-
|-
|<nowiki>{{CURRENTHOUR}}</nowiki>
| <code><nowiki>{{CURRENTDAYNAME}}</nowiki></code>
|{{CURRENTHOUR}}
| {{CURRENTDAYNAME}}
|The current hour in 24h format, with a leading zero
| Day of the week (name)
|
|-
|-
|<nowiki>{{CURRENTWEEK}}</nowiki>
! {{Hl3}} colspan="4"| '''Time'''
|{{CURRENTWEEK}}
|The current week of the year, with no leading zero
|-
|-
|<nowiki>{{CURRENTYEAR}}</nowiki>
| <code><nowiki>{{CURRENTTIME}}</nowiki></code>
|{{CURRENTYEAR}}
| {{CURRENTTIME}}
|The current year
| Time (24-hour HH:mm format)
|
|-
|-
|<nowiki>{{CURRENTTIMESTAMP}}</nowiki>
| <code><nowiki>{{CURRENTHOUR}}</nowiki></code>
|{{CURRENTTIMESTAMP}}
| {{CURRENTHOUR}}
|The current [[wp:ISO 8601|ISO 8601]] time stamp.
| Hour (24-hour zero-padded number)
|
|-
|-
|<nowiki>{{LOCALTIME}}</nowiki>
! {{Hl3}} colspan="4"| '''Other'''
|{{LOCALTIME}}
|-
|For most of the above date/time varibles, replacing CURRENT with LOCAL will show the current date/time of the Wiki's default settings, rather than that in the User's preferences.  
| <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>


===Wiki Statistics===
:''For more thorough time formatting, you may want to install [[Extension:ParserFunctions]] to use the [[Help:Extension:ParserFunctions#.23time|#time parser function]]''
These variables echo out statistics from this wiki. Numeric values are shown with thousand separators (eg 1,000,000). Adding <code>:R</code> onto the end of some of these (eg <code><nowiki>{{NUMBEROFEDITS:R}}</nowiki></code>) will show the number in its raw format, without thousand separators (eg 1000000) which can be used in calculations.
 
{|class="wikitable"
===Technical metadata===
!Magic Word
''Note:'' Revision variables return data about the '''latest edit to the current page''', even if viewing an older version of the page.
!Example
{| class="wikitable"
!Description
|-
! {{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+}}
|-
|-
|<nowiki>{{CURRENTVERSION}}</nowiki>
| <code><nowiki>{{SCRIPTPATH}}</nowiki></code>
|{{CURRENTVERSION}}
| {{SCRIPTPATH}}
|Current version of MediaWiki used on this wiki
| relative script path ({{mediawiki|Manual:$wgScriptPath|$wgScriptPath}})
|
|-
|-
|<nowiki>{{NUMBEROFEDITS}}</nowiki>
| <code><nowiki>{{STYLEPATH}}</nowiki></code>
|{{NUMBEROFEDITS}}
| {{STYLEPATH}}
|The total number of edits on this wiki
| relative style path ({{mediawiki|Manual:$wgStylePath|$wgStylePath}})
| 1.16+
|-
|-
|<nowiki>{{NUMBEROFPAGES}}</nowiki>
| <code><nowiki>{{CURRENTVERSION}}</nowiki></code>
|{{NUMBEROFPAGES}}
| {{CURRENTVERSION}}
|The total number of pages on this wiki, including everything
| The wiki's MediaWiki version.
| {{r|14199|1.7+}}
|-
|-
|<nowiki>{{NUMBEROFARTICLES}}</nowiki>
| <code><nowiki>{{CONTENTLANGUAGE}}</nowiki></code><br /><code><nowiki>{{CONTENTLANG}}</nowiki></code>
|{{NUMBEROFARTICLES}}
| {{CONTENTLANGUAGE}}<br />{{CONTENTLANG}}
|The total number of articles on this wiki, including only legitimate articles
| The wiki's default interface language ({{mediawiki|Manual:$wgLanguageCode|$wgLanguageCode}})
| {{r|14661|1.7+}}
|-
|-
|<nowiki>{{NUMBEROFFILES}}</nowiki>
! {{Hl3}} colspan="4"| '''Latest revision to current page'''
|{{NUMBEROFFILES}}
|The total number of files (images) uploaded to this wiki
|-
|-
|<nowiki>{{NUMBEROFUSERS}}</nowiki>
| <code><nowiki>{{REVISIONID}}</nowiki></code>
|{{NUMBEROFUSERS}}
| {{REVISIONID}}
|The total number of Users in the entireity of Wikia
| Unique revision ID
| 1.5+
|-
|-
|<nowiki>{{NUMBEROFADMINS}}</nowiki>
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
|{{NUMBEROFADMINS}}
| {{REVISIONDAY}}
|The total number of users on this wiki in the [[Administrator]] group
| Day edit was made (unpadded number)
| 1.8+
|-
|-
|<nowiki>{{PAGESINNS:1}}</nowiki>
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
|{{PAGESINNS:4}}
| {{REVISIONDAY2}}
|Shows the number of pages in a given namespace. The alternative format <nowiki>{{PAGESINNAMESPACE:ns}}</nowiki> may also work.
| Day edit was made (zero-padded number)
|}
| 1.8+
For the number of pages within a category, see other information (below)
 
 
===Page Names===
Adding an E onto the end of most of these page names will show the same function, but using underscores instead of spaces so it can be used in a web link (URL).
{|class="wikitable"
!Magic Word
!Example
!Description
|-
|-
|<nowiki>{{FULLPAGENAME}}</nowiki>
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
|{{FULLPAGENAME}}
| {{REVISIONMONTH}}
|The full name of the current page. AKA combines <nowiki>{{NAMESPACE}} and {{PAGENAME}}</nowiki>
| Month edit was made (zero-padded number as of {{mediawiki|rev:66200|1.17+}}, unpadded number in prior versions)
| 1.8+
|-
|-
|<nowiki>{{PAGENAME}}</nowiki>
| <code><nowiki>{{REVISIONMONTH1}}</nowiki></code>
|{{PAGENAME}}
| {{REVISIONMONTH1}}
|The name of the page, not including the namespace
| Month edit was made (unpadded number)
| {{mediawiki|rev:66200|1.17+}}
|-
|-
|<nowiki>{{PAGENAMEE}}</nowiki>
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
|{{PAGENAMEE}}
| {{REVISIONYEAR}}
|The above, but using underscores to be URL-friendly
| Year edit was made
| 1.8+
|-
|-
|<nowiki>{{BASEPAGENAME}}</nowiki>
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
|{{BASEPAGENAME}}
| {{REVISIONTIMESTAMP}}
|For subpages, shows the page above it. AKA removes everything after the last slash (/).
| Timestamp as of time of edit
| 1.8+
|-
|-
|<nowiki>{{NAMESPACE}}</nowiki>
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
|{{NAMESPACE}}
| {{REVISIONUSER}}
|The name of the current namespace
| 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+}}
|-
|-
|<nowiki>{{TALKSPACE}}</nowiki>
| <code><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></code>
|{{TALKSPACE}}
| <!-- Leave this empty. -->
|The name of the next odd-numbered namespace. Usually the appropriate talk namespace.
| 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+}}
|-
|-
|<nowiki>{{SUBJECTSPACE}}</nowiki><br><nowiki>{{ARTICLESPACE}}</nowiki>
! {{Hl3}} colspan="4"| '''Affects page content'''
|{{SUBJECTSPACE}}
|The name of the previous even-numbered namespace. For talk pages, this will show the namespace of the main article.
|-
|-
|<nowiki>{{TALKPAGENAME}}</nowiki>
| <code><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></code>
|{{TALKPAGENAME}}
|
|The full link to the relevant talk page. AKA combines <nowiki>{{TALKSPACE}} and {{PAGENAME}}</nowiki>
| 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 {{manual|$wgRestrictDisplayTitle}}). It can be disabled or enabled by {{mediawiki|Manual:$wgAllowDisplayTitle|$wgAllowDisplayTitle}}; disabled by default before 1.10+, enabled by default thereafter.
| 1.7+
|-
|-
|<nowiki>{{SUBJECTPAGENAME}}</nowiki><br><nowiki>{{ARTICLEPAGENAME}}</nowiki>
| <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><br/><code><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>|noerror}}</nowiki></code><br/><code><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>|noreplace}}</nowiki></code>
|{{SUBJECTPAGENAME}}
|
|The full link to the relevant main article. AKA combines <nowiki>{{SUBJECTSPACE}} and {{PAGENAME}}</nowiki>
| 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. It can take a second argument of ''noerror'' or ''noreplace'' to suppress error messages when multiple defaultsortkey's are used on one page or to make it do nothing if multiple defaultsortkey's are used.
| 1.10+<br/>{{mediawiki|rev:96767|1.19+}} (for noerror and noreplace)
|}
|}


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


===Other Page Information===
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"
 
!Magic Word
{| class="wikitable"
!Example
|-
!Description
! {{Hl2}}| Variable
! {{Hl2}}| Output
! {{Hl2}}| Description
! {{Hl2}}| Versions
|-
! {{Hl3}} colspan="4"| '''Entire wiki'''
|-
|-
|<nowiki>{{REVISIONID}}</nowiki>
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
|{{REVISIONID}}
| {{NUMBEROFPAGES}}
|The Unique ID of the current page
| Number of wiki pages.
| 1.7+
|-
|-
|<nowiki>{{REVISIONDAY}}</nowiki>
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
|{{REVISIONDAY}}
| {{NUMBEROFARTICLES}}
|The day on which the page was last modified. <nowiki>{{REVISIONDAY2}}</nowiki> shows a leading zero.
| Number of pages in {{mediawiki|Manual:Using custom namespaces#Content namespaces|content namespaces}}.
|
|-
|-
|<nowiki>{{REVISIONMONTH}}</nowiki>
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
|{{REVISIONMONTH}}
| {{NUMBEROFFILES}}
|The month on which the page was last modified
| Number of uploaded files.
| 1.5+
|-
|-
|<nowiki>{{REVISIONYEAR}}</nowiki>
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
|{{REVISIONYEAR}}
| {{NUMBEROFEDITS}}
|The year on which the page was last modified
| Number of page edits.
| {{mediawiki|rev:21319|1.10+}}
|-
|-
|<nowiki>{{REVISIONTIMESTAMP}}</nowiki>
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
|{{REVISIONTIMESTAMP}}
| {{NUMBEROFVIEWS}}
|The timestamp of when the page was last modified
| Number of page views. Usually useless on a wiki using [[Manual:Cache|caching]].
| {{mediawiki|rev:42721|1.14+}}
|-
|-
|<nowiki>{{PAGESINCATEGORY:Cleanup}}</nowiki>
| <code><nowiki>{{NUMBEROFUSERS}}</nowiki></code>
|{{PAGESINCATEGORY:Cleanup}}
| {{NUMBEROFUSERS}}
|The number of pages within a given category. <nowiki>{{PAGESINCAT:category}}</nowiki> also works
| Number of registered users.
| 1.7+
|-
|-
|<nowiki>{{PAGESIZE:page}}</nowiki>
| <code><nowiki>{{NUMBEROFADMINS}}</nowiki></code>
|{{PAGESIZE:Main Page}}
| {{NUMBEROFADMINS}}
|The byte size of a given page
| 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===
===Namespaces and URLs===
{| class="wikitable"
{|class="wikitable"
!Magic Word
!Example
!Description
|-
|-
|<nowiki>{{SITENAME}}</nowiki>
! {{Hl2}}| Variable
|{{SITENAME}}
! {{Hl2}}| Output
|The full site name
! {{Hl2}}| Description
! {{Hl2}}| Versions
|-
|-
|<nowiki>{{SERVER}}</nowiki>
| <code><nowiki>{{FULLPAGENAME}}</nowiki></code>
|{{SERVER}}
| {{FULLPAGENAME}}
|The URL of the wiki
| Namespace and page title.
| 1.6+
|-
|-
|<nowiki>{{SERVERNAME}}</nowiki>
| <code><nowiki>{{PAGENAME}}</nowiki></code>
|{{SERVERNAME}}
| {{PAGENAME}}
|The domain name of the wiki
| Page title.
|
|-
|-
|<nowiki>{{SCRIPTPATH}}</nowiki>
| <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
|{{SCRIPTPATH}}
| {{BASEPAGENAME}}
|The path (after the server name) to the wiki pages
| 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+
|-
|-
|<nowiki>{{ns:1}}</nowiki>
| <code><nowiki>{{SUBPAGENAME}}</nowiki></code>
|{{ns:1}}
| {{SUBPAGENAME}}
|The name of a namespace number
| The [[Help:Subpages|subpage]] title ("foo" on "Title/foo").
| 1.6+
|-
|-
|<nowiki>{{#special:}}</nowiki>
| <code><nowiki>{{SUBJECTPAGENAME}}</nowiki></code><br/><code><nowiki>{{ARTICLEPAGENAME}}</nowiki></code>
|{{#special:}}
| {{SUBJECTPAGENAME}}<br/>{{ARTICLEPAGENAME}}
|Links to a special page
| The namespace and title of the associated subject page.
| 1.7+
|-
|-
|<nowiki>{{localurl:Main Page}}</nowiki>
| <code><nowiki>{{TALKPAGENAME}}</nowiki></code>
|{{localurl:Main Page}}
| {{TALKPAGENAME}}
|The local URL of a page name
| 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.
 
====URL encoded page names====
 
The following are equivalents encoded for use in MediaWiki URLs (i.e. spaces replaced with underscores and some characters [[wikipedia:Numeric character reference|HTML escaped using numeric character encoding]]):
* <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>{{ARTICLEPAGENAMEE}}</nowiki></code>
* <code><nowiki>{{TALKPAGENAMEE}}</nowiki></code>
 
For example, if page name is "L'Aquila", the following code will produce the string "Numeric char encoding":
<pre><nowiki>{{#switch:{{PAGENAME}}
|L'Aquila = No translation
|L = not ok
|L&amp;apos;Aquila = Entity Escaping
|L&amp;#39;Aquila = Numeric char encoding
}}</nowiki></pre>
 
(See [[Bugzilla:35628|this bug]] for more information.)
 
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"
|-
|-
|<nowiki>{{localurl:Main Page|action=purge}}</nowiki>
! {{Hl2}}| Variable
|{{localurl:Main Page|action=purge}}
! {{Hl2}}| Output
|The local URL of a page name, with parameters
! {{Hl2}}| Description
! {{Hl2}}| Versions
|-
|-
|<nowiki>{{localurl:Wikipedia:Category}}</nowiki>
| <code><nowiki>{{NAMESPACE}}</nowiki></code>
|{{localurl:Wikipedia:Category}}
| {{NAMESPACE}}
|The local URL to an external page will show up as a full URL
| Name of the page's namespace
|
|-
|-
|<nowiki>{{SERVER}}{{localurl:Main Page}}</nowiki>
| <code><nowiki>{{NAMESPACENUMBER}}</nowiki></code>
|{{SERVER}}{{localurl:Main Page}}
| {{NAMESPACENUMBER}}
|The full URL to a page is created by using the server URL then adding the full page name in localurl, which turns spaces to underscores
| ID of the page's namespace
| [[gerrit:4056|1.20+]]
|-
|-
|<nowiki>{{SERVER}}{{localurl:{{TALKPAGENAME}}}}</nowiki>
| <code><nowiki>{{SUBJECTSPACE}}</nowiki></code><br /><code><nowiki>{{ARTICLESPACE}}</nowiki></code>
|{{SERVER}}{{localurl:{{TALKPAGENAME}}}}
| {{SUBJECTSPACE}}<br />{{ARTICLESPACE}}
|The full URL to a talk page can be ouput in the same way as a page name
| Name of the associated content namespace
| 1.7+
|-
|-
|<nowiki>{{SERVER}}{{localurl:{{TALKPAGENAME}}|action=edit}}</nowiki>
| <code><nowiki>{{TALKSPACE}}</nowiki></code>
|{{SERVER}}{{localurl:{{TALKPAGENAME}}|action=edit}}
| {{TALKSPACE}}
|The full URL to Edit a talk page can be given using localurl and the edit parameter
| 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 full-page-name parameter and will return the requested namespace associated with that page, instead of with the current page:
* <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}}'''
Parameter must not be a namespace name:
* <code><nowiki>{{SUBJECTSPACE:Help talk}}</nowiki></code> &rarr; '''{{SUBJECTSPACE:Help talk}}'''


==Formatting==
==Parser functions==


{|class="wikitable"
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.
!Magic Word
 
!Example
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]].
!Description
 
|-
===URL data===
|<nowiki>{{lc:AbC dEf}}</nowiki>
{| class="wikitable"
|{{lc:AbC dEf}}
|Turns a string to lower case
|-
|<nowiki>{{uc:AbC dEf}}</nowiki>
|{{uc:AbC dEf}}
|Turns a string to upper case
|-
|-
|<nowiki>{{lcfirst:TESTing}}</nowiki>
! {{Hl2}}| Parser function
|{{lcfirst:Testing}}
! {{Hl2}}| Input → Output
|Makes the first character of a string into lower case
! {{Hl2}}| Description
! {{Hl2}}| Versions
|-
|-
|<nowiki>{{ucfirst:testing}}</nowiki>
| <code><nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{localurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code>
|{{ucfirst:testing}}
| <code><nowiki>{{localurl:MediaWiki}}</nowiki></code> → {{localurl:MediaWiki}}<br /><code><nowiki>{{localurl:MediaWiki|printable=yes}}</nowiki></code>  → {{localurl:MediaWiki|printable=yes}}
|Makes the first character of a string into upper case
| The relative path to the title.
|
|-
|-
|<nowiki>{{formatnum:-218744561.35123}}</nowiki>
| <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>
| {{formatnum:-218744561.35123}}
| <code><nowiki>{{fullurl:Category:Top level}}</nowiki></code> → {{fullurl:Category:Top level}}<br />
|Formats a number string, adds thousand separator as appropriate. Recognises positive/negative.
<code><nowiki>{{fullurl:Category:Top level|action=edit}}</nowiki></code> → {{fullurl:Category:Top level|action=edit}}
| A protocol-relative path to the title. This will also resolve [[Manual:Interwiki|Interwiki]] prefixes. '''Note''': Unbracketed (plain) protocol-relative links are not automagically linked.
| 1.5+
|-
|-
|<nowiki>{{padleft:7|3}}</nowiki>
| <code><nowiki>{{canonicalurl:</nowiki>''page name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{canonicalurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code><br /><code><nowiki>{{canonicalurl:</nowiki>''interwiki:remote page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></code>
|{{padleft:7|3}}
| <code><nowiki>{{canonicalurl:Category:Top level}}</nowiki></code> → {{canonicalurl:Category:Top level}}<br />
|Pads a number/string (first variable) to the specified length of digits (second variable) to the left using a zero
<code><nowiki>{{canonicalurl:Category:Top level|action=edit}}</nowiki></code> → {{canonicalurl:Category:Top level|action=edit}}
| The absolute path to the title, using the canonical url. This will also resolve [[Manual:Interwiki|Interwiki]] prefixes.
| 1.18+
|-
|-
|<nowiki>{{padleft:7|3|X}}</nowiki>
| <code><nowiki>{{filepath:</nowiki>''file name''<nowiki>}}</nowiki></code><br /><code><nowiki>{{filepath:</nowiki>''file name''<nowiki>|nowiki}}</nowiki></code><br /><code><nowiki>{{filepath:</nowiki>''file name''<nowiki>|</nowiki>''thumbnail_size''<nowiki>}}</nowiki></code>
|{{padleft:7|3|X}}
| <code><nowiki>{{filepath:Wiki.png}}</nowiki></code> → {{filepath:Wiki.png}}<br />
|Pads a number/string to the specified length of digits to the left using a specified character (third variable)
<code><nowiki>{{filepath:Wiki.png|nowiki}}</nowiki></code> → {{filepath:Wiki.png|nowiki}}<br />
<code><nowiki>{{filepath:Example.svg|300}}</nowiki></code> → {{filepath:Example.svg|300}}<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+}}
|-
|-
|<nowiki>{{padright:C|3|S}}</nowiki>
| <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>
|{{padright:C|3|S}}
| <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
|Pads a number/string (as above) to the right
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+}}
|-
|-
|<nowiki>{{#language:de}}</nowiki>
| <code><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></code>
|{{#language:de}}
| <code><nowiki>{{anchorencode:x y z á é}}</nowiki></code> → {{anchorencode:x y z á é}}
|Shows the native name of a language ID code
| 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:Namespace|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.


==Image Modifiers==
<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"
{|class="wikitable"
|-
!Magic Word
! {{hl3}} colspan="2" width="50%" | Content namespaces
!Usage
! rowspan="12" |
!Example
! {{hl3}} colspan="2" width=%50%" | Talk namespaces
!Description
|-
! {{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}}
|-
|-
|framed<br>frame<br>enframed
| <code><nowiki>{{ns:2}}</nowiki></code> or <code><nowiki>{{ns:User}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|framed|Caption]]</nowiki>
| {{ns:2}}
|[[Image:Blank.jpg|framed|Caption]]
| <code><nowiki>{{ns:3}}</nowiki></code> or <code><nowiki>{{ns:User talk}}</nowiki></code>
|Places an image in a frame with a description. Uses original size and stubbornly ignores width parameter if given.
| {{ns:3}}
In general, far better to use thumb, as is only suitable for small images.
|-
|-
|thumb<br>thumbnail
| <code><nowiki>{{ns:4}}</nowiki></code> or <code><nowiki>{{ns:Project}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|thumb|Caption]]</nowiki>
| {{ns:4}}
|[[Image:Blank.jpg|thumb|Caption]]
| <code><nowiki>{{ns:5}}</nowiki></code> or <code><nowiki>{{ns:Project talk}}</nowiki></code>
|Modifies image size, sets it dependent on user's favorite thumbnail size in one's preferences, or on the given width parameter (see below).
| {{ns:5}}
|-
|-
|thumb=image.jpg
| <code><nowiki>{{ns:6}}</nowiki></code> or <code><nowiki>{{ns:File}}</nowiki></code> or <code><nowiki>{{ns:Image}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|thumb=clock.svg|Caption]]</nowiki>
| {{ns:6}}
|[[Image:Blank.jpg|thumb=clock.svg|Caption]]
| <code><nowiki>{{ns:7}}</nowiki></code> or <code><nowiki>{{ns:File talk}}</nowiki></code> or <code><nowiki>{{ns:Image talk}}</nowiki></code>
|Shows a thumbnail image of choice
| {{ns:7}}
|-
|-
|border
| <code><nowiki>{{ns:8}}</nowiki></code> or <code><nowiki>{{ns:MediaWiki}}</nowiki></code>
|<nowiki>[[Image:Clock.svg|border]]</nowiki>
| {{ns:8}}
|[[Image:Clock.svg|border]]
| <code><nowiki>{{ns:9}}</nowiki></code> or <code><nowiki>{{ns:MediaWiki talk}}</nowiki></code>
|Shows a 1px border around the image
| {{ns:9}}
|-
|-
|40px
| <code><nowiki>{{ns:10}}</nowiki></code> or <code><nowiki>{{ns:Template}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|40px]]</nowiki>
| {{ns:10}}
|[[Image:Blank.jpg|40px]]
| <code><nowiki>{{ns:11}}</nowiki></code> or <code><nowiki>{{ns:Template talk}}</nowiki></code>
|Resizes an image to specified dimensions. If one dimension is specified, it sets the width and maintains the aspect ratio.
| {{ns:11}}
|-
|-
|50x100px
| <code><nowiki>{{ns:12}}</nowiki></code> or <code><nowiki>{{ns:Help}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|50x100px]]</nowiki>
| {{ns:12}}
|[[Image:Blank.jpg|50x100px]]
| <code><nowiki>{{ns:13}}</nowiki></code> or <code><nowiki>{{ns:Help talk}}</nowiki></code>
|If two dimensions are specified (width x height), it uses them as maximums . EG it scales image to no more than 50 pixels wide and no more than 100 high, but image scaled to retain its true aspect ratio within the boundary specified.
| {{ns:13}}
|-
|-
|thumb|40px|Caption
| <code><nowiki>{{ns:14}}</nowiki></code> or <code><nowiki>{{ns:Category}}</nowiki></code>
|<nowiki>[[Image:Blank.jpg|thumb|80px|Caption]]</nowiki>
| {{ns:14}}
|[[Image:Blank.jpg|thumb|80px|Caption]]
| <code><nowiki>{{ns:15}}</nowiki></code> or <code><nowiki>{{ns:Category talk}}</nowiki></code>
|Shows a thumbnail of the image, resizes the thumbnail, adds a caption
| {{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>{{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:{{formatnum:987.654.321}}}}</nowiki></code><br/> → 987 654 321 (e.g. with Italian locale)<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. It doesn't always work if you try to unformat a number in non-English format on a wiki with non-English locale; if you need to format (according the wiki's locale) a number in unknown input format, try and use <code>formatnum</code> two times (but not if it can have a decimal group, or its separator will be eaten or the number won't be formatted).<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/>




===Image Position===
Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only.
{|class="wikitable"
| 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>
!Magic Word
| {{mediawiki|rev:48249|1.15+}}
!Usage
!Example
!Description
|-
|-
|right
| <code><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></code>
|Text1 Text1 Text1
| <code><nowiki>{{lc:DATA CENTER}}</nowiki></code> → {{lc:DATA CENTER}}
<nowiki>[[Image:Blank.jpg|right]]</nowiki>
| The lowercase input.
Text2 Text2 Text2<br>
| 1.5+
Text3 Text3 Text3
|Text1 Text1 Text1
[[Image:Blank.jpg|right]]
Text2 Text2 Text2<br>
Text3 Text3 Text3
|Floats an image (or thumbnail) right. Text will wrap to the left of it.
|-
|-
|left
| <code><nowiki>{{lcfirst:</nowiki>''string''<nowiki>}}</nowiki></code>
|Text1 Text1 Text1
| <code><nowiki>{{lcfirst:DATA center}}</nowiki></code> → {{lcfirst:DATA center}}
<nowiki>[[Image:Blank.jpg|left]]</nowiki>
| The input with the <u>very first</u> character lowercase.
Text2 Text2 Text2<br>
| 1.5+
Text3 Text3 Text3
|Text1 Text1 Text1
[[Image:Blank.jpg|left]]
Text2 Text2 Text2<br>
Text3 Text3 Text3
|Floats an image (or thumbnail) left. Text will wrap to the right of it.
|-
|-
|none
| <code><nowiki>{{uc:</nowiki>''string''<nowiki>}}</nowiki></code>
|Text1 Text1 Text1
| <code><nowiki>{{uc:text transform}}</nowiki></code> → {{uc:text transform}}
<nowiki>[[Image:Blank.jpg|none]]</nowiki>
| The uppercase input.
Text2 Text2 Text2<br>
| 1.5+
Text3 Text3 Text3
|Text1 Text1 Text1
[[Image:Blank.jpg|none]]
Text2 Text2 Text2<br>
Text3 Text3 Text3
|Explicitly states that the image will not float
|-
|-
|center<br>centre
| <code><nowiki>{{ucfirst:</nowiki>''string''<nowiki>}}</nowiki></code>
|Text1 Text1 Text1
| <code><nowiki>{{ucfirst:text TRANSFORM}}</nowiki></code> → {{ucfirst:text TRANSFORM}}
<nowiki>[[Image:Blank.jpg|center]]</nowiki>
| The input with the <u>very first</u> character uppercase.
Text2 Text2 Text2<br>
| 1.5+
Text3 Text3 Text3
|-
|Text1 Text1 Text1
| <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>
[[Image:Blank.jpg|center]]
| <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 />
Text2 Text2 Text2<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.
Text3 Text3 Text3
| 1.8+
|Centers an image, still acts like ''none''. Works with either British or American spelling.
|-
| <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.
|
|}
|}


'''See also:''' [[Extension:StringFunctions]]


==Template Modifiers==
===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]].


{|class="wikitable"
The usage of these magic words can be very complex, and the documentation is currently incomplete; there's some more info on [[translatewiki:FAQ#PLURAL|Plural]], [[translatewiki:Grammar|Grammar]], [[translatewiki:Gender|Gender]].
!Magic Word
 
!Example
{| class="wikitable"
!Description
! {{Hl2}}| Usage
! {{Hl2}}| Input → Output
! {{Hl2}}| Description
! {{Hl2}}| Version
|-
|-
|<nowiki>{{:xyz}}</nowiki>
|{{:xyz}}
|A leading colon is the prefix for the name namespace (IE an empty namespace). This will transclude the specified page, not the page within the template: namespace. This example will include [[Xyz]] not [[Template:Xyz]].
|-
|-
|<nowiki>{{int:xyz}}</nowiki><br><nowiki>{{int:currentevents}}</nowiki>
|{{int:xyz}}<br>{{int:currentevents}}
|Includes a page from the MediaWiki namespace. Same as <nowiki>{{mediaWiki:xyz}}</nowiki>, but also doesn't show up under ''Templates used on this page''. Rendered as <xyz> if MediaWiki:xyz doesn't exist.
|-
|-
|<nowiki>{{msg:CURRENTYEAR}}</nowiki>
| <code><nowiki>{{plural:2|</nowiki>''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></code>
|{{msg:CURRENTYEAR}}
| <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
|Transcludes the template xyz, even if a Magic Word with the same name exists. Usually Magic Words take priority.
| Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. Its functioning is [[m:Help:Magic_words#Language-dependent_word_conversions|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 [[bugzilla:28128|bug 28128]].
|
|-
|-
|<nowiki>{{msgnw:Col-end}}</nowiki><br><nowiki>{{raw:Col-end}}</nowiki>
| <code><nowiki>{{grammar:N|</nowiki>''noun''<nowiki>}}</nowiki></code>
|{{msgnw:Col-end}}
|  
|Includes the wikitext (markup, raw code) of a page. Does not render the page.  
| Outputs the correct inflected form of the given word described by the inflection code after the colon ([[m:Help:Magic_words#Language-dependent_word_conversions|language-dependent]]).  Grammar transformations are used for inflected languages like Polish.  See also {{mediawiki|Manual:$wgGrammarForms}}.
| 1.7+
|-
|-
|<nowiki>{{subst:xyz}}</nowiki>
| <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)''
|The content of the mentioned page is copied into this page. The include tag is replaced by the markup of the target page. The template will appear to show as normal, but changes to the template will not affect this page.
| 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+}}
|-
| <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 in MediaWiki 1.17 and earlier, see [[bugzilla:14404|bug 14404]].''
|
|-
| <code><nowiki>{{int:editsectionhint|MediaWiki}}</nowiki>
| <code><nowiki>{{int:editsectionhint|MediaWiki}}</nowiki></code> &rarr; '''{{int:editsectionhint|MediaWiki}}'''
| You may also use parameters with translations.<br />Parameters are designated in messages with: $1, $2, $3, etc.<br />For example, here is the message for ''editsectionhint'': Edit section: $1<br />In this example, MediaWiki replaces $1.
|
|}
|}


===Miscellaneous===


==Other==
{| class="wikitable plainlinks"
{|class="wikitable"
! {{Hl2}}| Usage
!Magic Word
! {{Hl2}}| Output
!Example
! {{Hl2}}| Description
!Description
! {{Hl2}}| Version
|-
|-
|<nowiki>{{DISPLAYTITLE:xyz}}</nowiki>
| <code><nowiki>{{#language:</nowiki>''language code''<nowiki>}}</nowiki></code><br />
| --
<code><nowiki>{{#language:ar}}</nowiki></code><br />
|Changes a page's title, as displayed at in the header at the top of the page
<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+}}
{{r|91875|1.18+}} (translation)
|-
|-
|<nowiki>{{CONTENTLANGUAGE}}</nowiki>
| <code><nowiki>{{#special:</nowiki>''special page name''<nowiki>}}</nowiki><br /><nowiki>{{#special:userlogin}}</nowiki></code>
|{{CONTENTLANGUAGE}}
| {{#special:special page name}}<br />{{#special:userlogin}}
|The ID Code of the site's default interface language
| The localized name for the given canonical Special: page.
| {{mediawiki|rev:17321|1.9+}}
|-
|-
|<nowiki>#REDIRECT [[Page]]</nowiki>
| <code><nowiki>{{#speciale:</nowiki>''special page name''<nowiki>}}</nowiki><br /><nowiki>{{#speciale:userlogin}}</nowiki></code>
| --
| {{#speciale:special page name}}<br />{{#speciale:userlogin}}
|Automatically redirects this page to another. Cannot be used to redirect across wikis. Cannot redirect more than once at a time. Redirects can be ignored with <code>&redirect=no</code> on the URL.
| The localized and url-encoded name for the given canonical Special: page.
| {{mediawiki|gerrit:4340|1.20+}}
|-
|-
|<nowiki>[[Category:category_name|sort_key]]</nowiki>
| <code><nowiki>{{#tag:</nowiki>''tagname''<br><nowiki>|</nowiki>''content''<br><nowiki>|</nowiki>''attribute1=value1''<br /><nowiki>|</nowiki>''attribute2=value2''<br /><nowiki>}}</nowiki></code>
| <nowiki>[[Category:Characters|Johnson, Carl]]</nowiki><br><br><nowiki>[[Category:Grand Theft Auto IV|Missions]]</nowiki>
| ''(depends on parser tag)''
|When a page is listed on a category page, it will be sorted and listed in alphabetical order. That can be overridden by adding a sort key, which sorts this example for [[Carl Johnson]] under J rather than under C, which is useful for Surnames. <br>This can also be used to eliminate repetition in titles, such as changing [[Missions in GTA IV]] to be listed as "Missions".
| Alias for XML-style Mediawiki parser tags or extension tags. It allows execution of wiki code and [[Extension:ParserFunctions|parser functions]] within tags before the tag is processed. It also prevents parsing of tags in conditional paths that aren't executed (like in <code>#if</code> statements). Content between tags is passed as the first parameter, and any attributes for the tags can be passed as subsequent parameters. This example:
 
<code>&lt;tagname ''attribute1''="''value1''" ''attribute2''="''value2''"&gt;</code>''Your content goes here''<code>&lt;/tagname&gt;</code>
 
...can be rewritten like this:
 
<code><nowiki>{{#tag:</nowiki></code>''tagname''<code><nowiki>|</nowiki></code>''Your content goes here''<code><nowiki>|</nowiki></code>''attribute1''=''value1''<code><nowiki>|</nowiki></code>''attribute2''=''value2''<code><nowiki>}}</nowiki></code>
 
Example for the [[Extension:Cite|Cite extension]]'s <code>&lt;ref&gt;</code> tags:
 
<code><nowiki>{{#tag:ref|Citation text goes here, and you can include parser functions like {{#expr: ... }} and magic words like {{PAGENAME}}.|name="multiple"}}</nowiki></code>
 
<small>{{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 in the area reserved for content between the pipe characters {{!}}{{!}} before ''attribute1''.</small>
| {{mediawiki|rev:29482|1.12+}}
|}
|}
[[Category:Help|{{PAGENAME}}]]

Latest revision as of 15:47, 18 April 2012

 This page documents Help for users on Grand Theft Wiki.


Magic Words are strings of text recognised by MediaWiki which perform special functions, such as outputting the name of the current page, showing or hiding the Table of Contents, or adjusting some text for use in a URL.

Read more at: http://meta.wikimedia.org/wiki/Help:Magic_words

There are three general types of magic words:

Page-dependent magic words will affect or return data about the current page (by default), even if the word is added through a transcluded template or included system message.

Behavior switches

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.

Word Description Versions
Table of contents
__NOTOC__ Hides the table of contents (TOC).
__FORCETOC__ Forces the table of contents 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. 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 "" after each heading.
__NEWSECTIONLINK__ Adds a link ("+" by default) beside the "edit" tab for adding a new section on a non-talk page (see Adding a section to the end). 1.7+
__NONEWSECTIONLINK__ Removes the link beside the "edit" tab on pages in talk namespaces. 1.15+
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 19213. 1.1–1.8
__INDEX__ Tell search engines to index the page (overrides $wgArticleRobotPolicies, but not robots.txt). 1.14+
__NOINDEX__ Tell search engines not to index the page (ie, do not list in search engines' results). 1.14+
__STATICREDIRECT__ On redirect pages, don't allow MediaWiki to automatically update the link when someone moves a page and checks "Update any redirects that point to the original title". 1.13+

Variables

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.

Variable Output Description Versions
Year
{{CURRENTYEAR}} 2024 Year
Month
{{CURRENTMONTH}} 04 Month (zero-padded number)
{{CURRENTMONTHNAME}} April Month (name)
{{CURRENTMONTHNAMEGEN}} April Month (genitive form)
{{CURRENTMONTHABBREV}} Apr Month (abbreviation) 1.5+
Day
{{CURRENTDAY}} 19 Day of the month (unpadded number)
{{CURRENTDAY2}} 19 Day of the month (zero-padded number) 1.6+
{{CURRENTDOW}} 5 Day of the week (unpadded number), 0 (for Sunday) through 6 (for Saturday)
{{CURRENTDAYNAME}} Friday Day of the week (name)
Time
{{CURRENTTIME}} 02:35 Time (24-hour HH:mm format)
{{CURRENTHOUR}} 02 Hour (24-hour zero-padded number)
Other
{{CURRENTWEEK}} 16 Week (number)
{{CURRENTTIMESTAMP}} 20240419023534 YYYYMMDDHHmmss timestamp 1.7+

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

  • {{LOCALYEAR}}
  • {{LOCALMONTH}}
  • {{LOCALMONTHNAME}}
  • {{LOCALMONTHNAMEGEN}}
  • {{LOCALMONTHABBREV}}
  • {{LOCALDAY}}
  • {{LOCALDAY2}}
  • {{LOCALDOW}}
  • {{LOCALDAYNAME}}
  • {{LOCALTIME}}
  • {{LOCALHOUR}}
  • {{LOCALWEEK}}
  • {{LOCALTIMESTAMP}}
For more thorough time formatting, you may want to install Extension:ParserFunctions to use the #time parser function

Technical metadata

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}} Grand Theft Wiki The wiki's site name ($wgSitename).
{{SERVER}} //www.grandtheftwiki.com domain URL ($wgServer)
{{SERVERNAME}} www.grandtheftwiki.com domain name (No longer dependent on $wgServerName as of version 1.17)
{{DIRMARK}}
{{DIRECTIONMARK}} 		‎
‎ 		Outputs a unicode-directional mark that matches the wiki's default language's direction (&lrm; on left-to-right wikis, &rlm; on right-to-left wikis), useful in text with multi-directional text. Since Template:R, it depends on the page content language. Template:R
{{SCRIPTPATH}} relative script path ($wgScriptPath)
{{STYLEPATH}} /skins relative style path ($wgStylePath) 1.16+
{{CURRENTVERSION}} 1.40.0 The wiki's MediaWiki version. Template:R
{{CONTENTLANGUAGE}}
{{CONTENTLANG}} 		en-gb
en-gb 		The wiki's default interface language ($wgLanguageCode) Template:R
Latest revision to current page
{{REVISIONID}} 353875 Unique revision ID 1.5+
{{REVISIONDAY}} 18 Day edit was made (unpadded number) 1.8+
{{REVISIONDAY2}} 18 Day edit was made (zero-padded number) 1.8+
{{REVISIONMONTH}} 04 Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions) 1.8+
{{REVISIONMONTH1}} 4 Month edit was made (unpadded number) 1.17+
{{REVISIONYEAR}} 2012 Year edit was made 1.8+
{{REVISIONTIMESTAMP}} 20120418154727 Timestamp as of time of edit 1.8+
{{REVISIONUSER}} Gboyers The username of the user who made the most recent edit to the page, or the current user when previewing an edit 1.15+
{{PAGESIZE:page name}}
{{PAGESIZE:page name|R}} 		0
0 		[expensive] Returns the byte size of the specified page. Use "|R" to get raw numbers. 1.13+
{{PROTECTIONLEVEL:action}} 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. 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 are allowed (this can be changed with Template:Manual). It can be disabled or enabled by $wgAllowDisplayTitle; disabled by default before 1.10+, enabled by default thereafter. 1.7+
{{DEFAULTSORT:sortkey}}
{{DEFAULTSORTKEY:sortkey}}
{{DEFAULTCATEGORYSORT:sortkey}}
{{DEFAULTSORT:sortkey|noerror}}
{{DEFAULTSORT:sortkey|noreplace}} 		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 defaultsortkey's are used on one page or to make it do nothing if multiple defaultsortkey's are used. 1.10+
1.19+ (for noerror and noreplace)

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}} → 56,419 and {{NUMBEROFPAGES:R}} → 56419). 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.

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

Variable Output Description Versions
Entire wiki
{{NUMBEROFPAGES}} 56,419 Number of wiki pages. 1.7+
{{NUMBEROFARTICLES}} 10,039 Number of pages in content namespaces.
{{NUMBEROFFILES}} 14,841 Number of uploaded files. 1.5+
{{NUMBEROFEDITS}} 390,490 Number of page edits. 1.10+
{{NUMBEROFVIEWS}} Template:NUMBEROFVIEWS Number of page views. Usually useless on a wiki using caching. 1.14+
{{NUMBEROFUSERS}} 41,881 Number of registered users. 1.7+
{{NUMBEROFADMINS}} 12 Number of users in the sysop group. 1.7+
{{NUMBEROFACTIVEUSERS}} 3 Number of active users, based on the criteria used in Special:Statistics. 1.15+
{{PAGESINCATEGORY:categoryname}}
{{PAGESINCAT:Help}} 		33
33 		[expensive] Number of pages in the given category. 1.13+
{{NUMBERINGROUP:groupname}}
{{NUMINGROUP:groupname}} 		1
1
({{NUMBERINGROUP:bureaucrat}} used here) 		Number of users in a specific group. 1.14+
{{PAGESINNS:index}}
{{PAGESINNAMESPACE:index}} 		not enabled Number of pages in the given namespace (replace index with the relevant namespace index). For instance, {{PAGESINNAMESPACE:14}} will output the number of category pages. {{PAGESINNS:0}} differs from {{NUMBEROFARTICLES}} in that the former includes redirects and disambiguation pages. Disabled by default, enable with $wgAllowSlowParserFunctions. 1.7+

Page names

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}}
{{ARTICLEPAGENAME}} 		Help:Magic Words
Help:Magic Words 		The namespace and title of the associated subject page. 1.7+
{{TALKPAGENAME}} Help talk:Magic Words The namespace and title of the associated talk page. 1.7+

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

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

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

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
}}

(See this bug for more information.)

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
Warning Warning: 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 14779, 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
{{NAMESPACENUMBER}} 12 ID of the page's namespace 1.20+
{{SUBJECTSPACE}}
{{ARTICLESPACE}} 		Help
Help 		Name of the associated content namespace 1.7+
{{TALKSPACE}} Help talk Name of the associated talk namespace 1.7+

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

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

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

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

Parameter must not be a namespace name:

  • {{SUBJECTSPACE:Help talk}} → '

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.

URL data

Parser function Input → Output Description Versions
{{localurl:page name}}
{{localurl:page name|query_string}} 		{{localurl:MediaWiki}} → /MediaWiki
{{localurl:MediaWiki|printable=yes}} → /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}} → //www.grandtheftwiki.com/Category:Top_level

{{fullurl:Category:Top level|action=edit}} → //www.grandtheftwiki.com/index.php?title=Category:Top_level&action=edit

A protocol-relative path to the title. This will also resolve Interwiki prefixes. Note: Unbracketed (plain) protocol-relative links are not automagically linked. 1.5+
{{canonicalurl:page name}}
{{canonicalurl:page name|query_string}}
{{canonicalurl:interwiki:remote page name|query_string}} 		{{canonicalurl:Category:Top level}} → https://www.grandtheftwiki.com/Category:Top_level

{{canonicalurl:Category:Top level|action=edit}} → https://www.grandtheftwiki.com/index.php?title=Category:Top_level&action=edit

The absolute path to the title, using the canonical url. This will also resolve Interwiki prefixes. 1.18+
{{filepath:file name}}
{{filepath:file name|nowiki}}
{{filepath:file name|thumbnail_size}} 		{{filepath:Wiki.png}} → https://gtwfilesie.grandtheftwiki.com/Wiki.png

{{filepath:Wiki.png|nowiki}} → https://gtwfilesie.grandtheftwiki.com/Wiki.png
{{filepath:Example.svg|300}} →

The absolute URL to the full size or thumbnail (1.18+) of a media file. 1.12+
1.18+
{{urlencode:string}} (or {{urlencode:string|QUERY}})
{{urlencode:string|WIKI}}
{{urlencode:string|PATH}} 		{{urlencode:x y z á é}} (or {{urlencode:x y z á é|QUERY}}) → x+y+z+%C3%A1+%C3%A9
{{urlencode:x y z á é|WIKI}} → x_y_z_%C3%A1_%C3%A9
{{urlencode:x y z á é|PATH}} → x%20y%20z%20%C3%A1%20%C3%A9

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

The input encoded for use in URLs. Note that there is no urldecode function like there is in the obsolete Extension:StringFunctions. 1.7+ (or 1.17+)
1.17+
1.17+
{{anchorencode:string}} {{anchorencode:x y z á é}} → x_y_z_á_é The input encoded for use in URL section anchors (after the '#' symbol in a URL). 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}} Grand Theft Wiki {{ns:5}} or {{ns:Project talk}} Grand Theft 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

Usage Input → Output Description Version
{{formatnum:unformatted num}}
{{formatnum:formatted num|R}} 		{{formatnum:987654321.654321}}
→ 987,654,321.654321

{{formatnum:987,654,321.654321|R}}
→ 987654321.654321
{{formatnum:{{formatnum:987.654.321}}}}
→ 987 654 321 (e.g. with Italian locale)
{{formatnum:00001}}
→ 00,001

The input with decimal and decimal group separators, and localized digit script, according to the wiki's default locale. The |R parameter can be used to unformat a number, for use in mathematical situations. It doesn't always work if you try to unformat a number in non-English format on a wiki with non-English locale; if you need to format (according the wiki's locale) a number in unknown input format, 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).
Warning Warning: Leading zeroes are not removed, you can use {{#expr:00001}} instead if you have Extension:ParserFunctions installed 		1.7+
1.13+

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

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


Note: In the example above, "your pref" refers to your date preference on the current MediaWiki wiki only.

Formats an unlinked date based on user "Date format" preference, and adds metadata tagging it as a formatted date. For logged-out users and those who have not set a date format in their preferences, dates can be given a default: mdy, dmy, ymd, ISO 8601 (all case sensitive). If only the month and day are given, only mdy and dmy are valid. If a format is not specified or is invalid, the input format is used as a default. If the supplied date is not recognized as a valid date (specifically, if it contains any metadata such as from a nested use of these or similar templates), it is rendered unchanged, and no (additional) metadata is generated.
Warning 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). 		1.15+
{{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+
{{padleft:xyz|stringlength}}
{{padleft:xyz|strlen|char}}
{{padleft:xyz|strlen|string}} 		{{padleft:xyz|5}} → 00xyz
{{padleft:xyz|5|_}} → __xyz {{padleft:xyz|5|abc}} → abxyz {{padleft:xyz|2}} → xyz
{{padleft:|1|xyz}} → x (first character of the string)
 Inserts a string of padding characters (character chosen in third parameter; default '0') of a specified length (second parameter) next to a chosen base character or variable (first parameter). The final digits or characters in the base replace the final characters in the padding; i.e. {{padleft:44|3|0}} produces 044. The padding string may be truncated if its length does not evenly divide the required number of characters.
bug (fixed in r45734): multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters. 		1.8+
{{padright:xyz|stringlength}}
{{padright:xyz|strlen|char}}
{{padright:xyz|strlen|string}} 		{{padright:xyz|5}} → xyz00

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

 Identical to padleft, but adds padding characters to the right side.

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.

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.

Usage Input → Output Description Version
{{plural:2|is|are}} {{plural:0|is|are}} → are
{{plural:1*1|is|are}} → is
{{plural:21 mod 10|is|are}} → are
{{plural:{{#expr:21 mod 10}}|is|are}} → is
{{plural:1|is|are}} → is
{{plural:2|is|are}} → are
(for Polish):
{{plural:2|milion|miliony|milionów}} → miliony 		Outputs the singular form (second parameter) if the first parameter is an expression equalling one; the plural form (third parameter) otherwise. 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.
{{grammar:N|noun}} Outputs the correct inflected form of the given word described by the inflection code after the colon (language-dependent). Grammar transformations are used for inflected languages like Polish. See also Manual:$wgGrammarForms. 1.7+
{{gender:username
|return text if user is male
|return text if user is female
|return text if user hasn't defined their gender}} 		(depends on the named user's gender) A switch for the gender set in Special:Preferences.

Note: If 3rd parameter is omitted and user hasn't defined his/her gender, then text if user is male is returned.

1.15+
{{int:message name}} {{int:edit}} → Edit
(depends on user language, try: fr •ja) 		Internationalizes (translates) the given interface (MediaWiki namespace) message into the user language. Note that this can damage/confuse cache consistency in MediaWiki 1.17 and earlier, see bug 14404.
{{int:editsectionhint|MediaWiki}} {{int:editsectionhint|MediaWiki}} → Edit section: MediaWiki 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.

Miscellaneous

Usage Output Description Version
{{#language:language code}}

{{#language:ar}}
{{#language:language code|target language code}}
{{#language:ar|en}}

language code
العربية
language code
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 ISO 639. 1.7+

Template:R (translation)

{{#special:special page name}}
{{#special:userlogin}} 		Special:Special page name
Special:UserLogin 		The localized name for the given canonical Special: page. 1.9+
{{#speciale:special page name}}
{{#speciale:userlogin}} 		Special:Special_page_name
Special:UserLogin 		The localized and url-encoded name for the given canonical Special: page. 1.20+
{{#tag:tagname
|content
|attribute1=value1
|attribute2=value2
}} 		(depends on parser tag) Alias for XML-style Mediawiki parser tags or extension tags. It allows execution of wiki code and parser functions within tags before the tag is processed. It also prevents parsing of tags in conditional paths that aren't executed (like in #if statements). Content between tags is passed as the first parameter, and any attributes for the tags can be passed as subsequent parameters. This example:

<tagname attribute1="value1" attribute2="value2">Your content goes here</tagname>

...can be rewritten like this:

{{#tag:tagname|Your content goes here|attribute1=value1|attribute2=value2}}

Example for the Cite extension's <ref> tags:

{{#tag:ref|Citation text goes here, and you can include parser functions like {{#expr: ... }} and magic words like {{PAGENAME}}.|name="multiple"}}

Warning Warning: You must write {{#tag:tagname||attribute1=value1|attribute2=value2}} to pass an empty content. No space is permitted in the area reserved for content between the pipe characters || before attribute1.

1.12+
Retrieved from ‘https://www.grandtheftwiki.com/index.php?title=Help:Magic_Words&oldid=353875’