2,646
edits
Changes
no edit summary
{{Help contents back}}
{{Help contents back}}
----
----
This is an organised index of Magic words used in MediaWiki. Tags such as "'''[MW1.5+]'''" indicate the version that first supported the magic word. "XYZ" indicates user input, which is used in the example.
This is an organized index of Magic words used in MediaWiki.
== Table of contents ==
A "'''[[Magic (programming)|magic]] word'''" is a symbol which is recognized by the MediaWiki software and which when seen in the non-commented text of the page, triggers the software to do something other than display that symbol, or transclude a page with that name, but instead to use the symbol directly. A magic word can be:
*an upper case word, preceded and followed by two underscores, e.g. '''<nowiki>__NOTOC__</nowiki>'''
*an XML object, coded similar to HTML, preceded by "<" (and for the end tag "/") and followed by ">", as in '''<nowiki>'''...'''</nowiki>'''
*a [[help:parser function|parser function]]: similar to a template, a word preceded by the symbols "'''<nowiki>{{</nowiki>'''" and followed by "'''<nowiki>}}</nowiki>'''", and optionally parameter definitions between pipe characters, except that the part before the first pipe (or without pipes, the text between the braces) contains a colon ("''':'''"), e.g. <nowiki>{{</nowiki>'''ns:'''3}} and {{'''#ifexpr:'''<nowiki>{{{1}}}>3|large|small}}</nowiki>
*a [[help:variable|variable]]: similar to a template without parameters, a word preceded by the symbols "'''<nowiki>{{</nowiki>'''" and followed by "'''<nowiki>}}</nowiki>'''", except the word used is in all upper case, e.g. '''<nowiki>{{CURRENTDAY}}</nowiki>'''
*a template modifier
*an image modifier
If a page in the template namespace has the same name as a magic word, the magic word will be invoked instead. If you discover you absolutely have to define a template with the same name as a magic word, prefix the name of the template with "'''msg:'''" or the name of the template namespace ("'''Template:'''"). See below for further details if you need this feature.
Tags which are used on this page such as "'''[MW1.5+]'''" indicate the version that first supported the magic word. "XYZ" indicates user input, which is used in the example.
==Magic words between double underscores==
=== Table of contents ===
:''For details see [[Help:Section]]''
:''For details see [[Help:Section]]''
<br clear="left" />
=== More magic ===
=== Other ===
{| class="wikitable" border="2" cellpadding="4" cellspacing="0" width="79%"
{| class="wikitable" border="2" cellpadding="4" cellspacing="0" width="79%"
! Word
! Word
|-
|-
| <nowiki>__END__</nowiki>
| <nowiki>__END__</nowiki>
| Allows for trailing whitespace to be included in the page save.
| Allows for trailing whitespace to be included in the page save (does not seem to work anymore).
|-
|-
| <nowiki>__START__</nowiki>
| <nowiki>__START__</nowiki>
| This magic word has no effect but an ID in <tt>MagicWord.php</tt> (<code>MAG_START</code>).
| This magic word has no effect but an ID in <tt>MagicWord.php</tt> (<code>MAG_START</code>).
|}<br clear="left" />
|}<br clear="left" />
==XML-style tags==
'''nowiki''': <nowiki>'''...'''</nowiki>, disables expansion/interpretation of templates, link syntax, formatting syntax, etc.: <nowiki><nowiki>'''[[{{tc}}]]'''</nowiki></nowiki> gives <nowiki>'''[[{{tc}}]]'''</nowiki>
'''pre''': <pre>'''...'''</pre>, ditto, also for multiple lines; it is rendered with a new paragraph at the start and end: a<pre><nowiki>'''[[{{tc}}]]'''</nowiki></pre>b gives a<pre>'''[[{{tc}}]]'''</pre>b
'''math''': <math>'''...'''</math>, e.g. <nowiki><math>\alpha^2+\beta^2=1</math></nowiki> gives <math>\alpha^2+\beta^2=1</math>; see [[Help:Displaying a formula]]
'''hiero''': <hiero>'''...'''</hiero>, e.g. <nowiki><hiero>A1</hiero></nowiki> gives: <hiero>A1</hiero>
See also: [[Extending wiki markup]].
== Variables ==
== Variables ==
===Time===
===Time===
The time in [[:en:UTC|UTC]].
The time in [[:en:UTC|UTC]]. Note that if the page was displayed by the same user and has not changed (has not been edited) since the last time it was displayed, it is possible that the page may be cached (by the user's browser) and the displayed time or date may not change. Also, if a heavily used page, rather than freshly rendered by the software each time it is generated, is instead being retrieved from a caching system (such as the main page on Wikipedia) the date or time may not change from the last time the page was originally retrieved by the caching hardware or software.
{| class="wikitable sortable" border="2" cellpadding="4" cellspacing="0"
{| class="wikitable sortable" border="2" cellpadding="4" cellspacing="0"
! Word
! Word
| <nowiki>{{CURRENTMONTHABBREV}}</nowiki>
| <nowiki>{{CURRENTMONTHABBREV}}</nowiki>
| <code>{{CURRENTMONTHABBREV}}</code>
| <code>{{CURRENTMONTHABBREV}}</code>
| '''[MW1.5+]''' Same as <nowiki>{{CURRENTMONTH}}</nowiki>, but in abbreviated form as Jan .. Dec.
| '''[MW1.5+]''' Same as <nowiki>{{CURRENTMONTH}}</nowiki>, but in abbreviated form (Jan .. Dec).
|-
|-
| <nowiki>{{CURRENTMONTHNAME}}</nowiki>
| <nowiki>{{CURRENTMONTHNAME}}</nowiki>
| <code>{{CURRENTMONTHNAME}}</code>
| <code>{{CURRENTMONTHNAME}}</code>
| Same as <nowiki>{{CURRENTMONTH}}</nowiki>, but in named form January .. December.
| Same as <nowiki>{{CURRENTMONTH}}</nowiki>, but in named form (January .. December).
|-
|-
| <nowiki>{{CURRENTTIME}}</nowiki>
| <nowiki>{{CURRENTTIME}}</nowiki>
===Local time===
===Local time===
The time depending on the local timezone of the wiki. (All words '''[MW1.8+]''' )
The time depending on the local timezone of the wiki (''not'' depending on the timezone in the user's preference settings). (All words '''[MW1.8+]''' )
{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
! Word
! Word
=== Statistics ===
=== Statistics ===
Statistics variables give thousands separators unless ":R" for "raw" is added (actually, these versions are parser functions).
{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
! Word
! Word
| <code>{{CURRENTVERSION}}</code>
| <code>{{CURRENTVERSION}}</code>
| '''[MW1.7+]''' {{h:mwg|Version}} [http://mail.wikipedia.org/pipermail/mediawiki-i18n/2006-May/000026.html]
| '''[MW1.7+]''' {{h:mwg|Version}} [http://mail.wikipedia.org/pipermail/mediawiki-i18n/2006-May/000026.html]
|-
|<nowiki>{{NUMBEROFEDITS}}</nowiki><br /><nowiki>{{NUMBEROFEDITS:R}}</nowiki>
| <code>{{NUMBEROFEDITS}}</code><br /><code>{{NUMBEROFEDITS:R}}</code>
| '''[MW1.10+ (r21319)]''' Returns the total number of page edits since MediaWiki, the software that runs this site, was installed.
|-
|-
| <nowiki>{{NUMBEROFARTICLES}}</nowiki><br /><nowiki>{{NUMBEROFARTICLES:R}}</nowiki>
| <nowiki>{{NUMBEROFARTICLES}}</nowiki><br /><nowiki>{{NUMBEROFARTICLES:R}}</nowiki>
=== Page names and related info ===
=== Page names and related info ===
{| class="wikitable" border="2" cellpadding="4" cellspacing="0"
{{:H:Page_name_variables}}
==Parser functions==
==Parser functions==
:''For details see [[Help:Parser function]].''
:''For details see [[Help:Parser function]].''
Not working at the position of the page where the tag is located but on the page header, and throughout the page, respectively (see below):
*DISPLAYTITLE: allow the page header to be different from the page name.
*DEFAULTSORT: Sets a default [[Help:Categories#Sort_key|category sort key]] for the page.
=== Namespaces and URLs ===
=== Namespaces and URLs ===
| Returns the name of a given [[Help:Namespace|namespace number]].
| Returns the name of a given [[Help:Namespace|namespace number]].
|-
|-
| <nowiki>{{localurl:x y @}}</nowiki><br /><nowiki>{{localurle:x y @}}</nowiki><br /><nowiki>{{localurl:a|b=c}}</nowiki>
| <nowiki>{{localurl:x y @}}</nowiki><br /><nowiki>{{localurle:x y @}}</nowiki><br /><nowiki>{{localurl:a|b=c}}</nowiki><br /><nowiki>{{localurl:Wikipedia:Category}}</nowiki>
| <code>{{localurl:x y @}}<br />{{localurle:x y @}}<br />{{localurl:a|b=c}}</code>
| <code>{{localurl:x y @}}<br />{{localurle:x y @}}<br />{{localurl:a|b=c}}<br />{{localurl:Wikipedia:Category}}</code>
| Returns the local URL of a page (might not exist). Optional ''query'' parameter, see [[Help:Variable]].
| Returns the local URL of a page (might not exist). Optional ''query'' parameter, see [[Help:Variable]].
|- <!-- intentionally nbsp instead of sp for formatting reasons -->
|- <!-- intentionally nbsp instead of sp for formatting reasons -->
| '''[MW1.7+]''' Add [[w:Decimal_separator#Thousands_separator|decimal separators]] according to the wiki's default locale. Leading minus and plus are recognized.
| '''[MW1.7+]''' Add [[w:Decimal_separator#Thousands_separator|decimal separators]] according to the wiki's default locale. Leading minus and plus are recognized.
|-
|-
| <nowiki>{{padleft:}}</nowiki><br /><nowiki>{{padright:}}</nowiki>
|<nowiki>{{padleft:}}</nowiki><br /><br /><br /><br /><br /><nowiki>{{padright:}}</nowiki><br />
| <nowiki>{{padleft:bcd|6|a}}</nowiki> = <code>{{padleft:bcd|6|a}}</code><br /><nowiki>{{padleft:café|6|-}}</nowiki>={{padleft:café|6|-}}<br /><nowiki>{{padright:bcd|6|a}}</nowiki> = <code>{{padright:bcd|6|a}}</code>
|
| '''[MW1.8+]''' Pads a string with a character to the specified width.
<nowiki>{{padleft:7|3|0}}</nowiki> = <code>{{padleft:7|3|0}}</code><br/><br/>
<nowiki>{{padleft:0|3|0}}</nowiki> = <code>{{padleft:0|3|0}}</code> (bug)<br/><br/>
<nowiki>{{padleft:bcd|6|a}}</nowiki> = <code>{{padleft:bcd|6|a}}</code><br/>
<nowiki>{{padleft:café|8|-}}</nowiki> = <code>{{padleft:café|8|-}}</code>(<==Bug effect)<br />
<nowiki>{{padleft:cafe|8|-}}</nowiki> = <code>{{padleft:cafe|8|-}}</code><br />
<nowiki>{{padleft:bcd|6|{{!}}}}</nowiki> = <code>{{padleft:bcd|6|{{!}}}}</code><br/>
<br/>
<nowiki>{{padright:bcd|6|a}}</nowiki> = <code>{{padright:bcd|6|a}}</code><br />
<nowiki>{{padright:0|6|a}}</nowiki> = <code>{{padright:0|6|a}}</code> (bug)<br />
|valign="top"|<br />First case is, for example, applicable to years in a category... giving an ordered year to sort by pipetricks order, or any such ordering where left extended zeros allow a proper sorting.<br /><br /> '''[MW1.8+]''' Pads a string with a character to the specified width. Note that there's a little bug that interprets non-[[w:US-ASCII|US-ASCII]] characters as two, instead of one character (see the difference in''' ''café'' and ''cafe'' '''in the examples.)
It does not seem possible to use padleft and padright for padding with characters with a multi-character code, such as <code>&nbsp;</code>, which would be useful with padleft for [[Help:Sorting|sorting tables]] with Javascript.
Padding "0" does not work, it returns the same. This seems to be a bug.<ref>Function pad in includes/CoreParserFunctions.php puts, oddly, the $string itself as a condition for the padding. To be reported as bug.</ref>
|}{{-}}
|}{{-}}
== Template modifiers ==
== Template modifiers ==
|-
|-
| <nowiki>{{int:xyz}}</nowiki>
| <nowiki>{{int:xyz}}</nowiki>
| Shorthand for <nowiki>{{MediaWiki:xyz}}</nowiki>, rendered as {{int:xyz}} if [[MediaWiki:xyz]] doesn't exist. See [[Help:MediaWiki namespace]].
| Shorthand for <nowiki>{{MediaWiki:xyz}}</nowiki>, rendered as {{int:xyz}} if [[MediaWiki:xyz]] doesn't exist. See also [[Help:System message]].
|-
|-
| <nowiki>{{msg:xyz}}</nowiki>
| <nowiki>{{msg:xyz}}</nowiki>
| Try <nowiki>{{Template:xyz}}</nowiki> before [[Help:Magic words|magic word]] xyz, without this modifier it's the other way around. No additional effect if there is no template xyz.
| Even if there is a magic word named "xyz", use template:xyz unless the template doesn't exist (equivalent to <nowiki>{{template:xyz}}</nowiki>). Normally, magic words have priority when there is a conflict.
|-
|-
| <nowiki>{{msgnw:xyz}}</nowiki>
| <nowiki>{{msgnw:xyz}}</nowiki>
|-
|-
| <nowiki>{{raw:xyz}}</nowiki>
| <nowiki>{{raw:xyz}}</nowiki>
| '''[MW1.6+]''' Like <code>{{msg:}}</code> {{unclear}} [http://svn.wikimedia.org/viewvc/mediawiki?view=rev&revision=12925]
| '''[MW1.6+]''' Equivalent to <code><nowiki>{{msg:xyz}}</nowiki></code> above<ref>[http://svn.wikimedia.org/viewvc/mediawiki?view=rev&revision=12925 Wikimedia SVN revision 12925]</ref>.
|-
|-
| <nowiki>{{subst:xyz}}</nowiki>
| <nowiki>{{subst:xyz}}</nowiki>
== Image modifiers ==
== Image modifiers ==
:''For details see [[Centiare:Extended image syntax]].''
:''For details see [[w:en:Wikipedia:Extended image syntax]].''
These are [[Help:Image page|image]] modifiers used in <code><nowiki>[[Image:title.ext|modifier|...|modifier]]</nowiki></code> links. Some are mutually exclusive, and then the last specified wins.
These are [[Help:Image page|image]] modifiers used in <code><nowiki>[[Image:title.ext|modifier|...|modifier]]</nowiki></code> links. Some are mutually exclusive, and then the last specified wins.
| framed<br />frame<br />enframed
| framed<br />frame<br />enframed
| <nowiki>[[Image:Mediawiki.png|framed]]</nowiki>
| <nowiki>[[Image:Mediawiki.png|framed]]</nowiki>
| Places an image in a ''frame'' with a description. Uses original size.
| Places an image in a ''frame'' with a description. Uses original size and stubbornly ignores width parameter if given.<br>In general, far better to use thumb, as is only suitable for small images.
|-
| border
| <nowiki>[[Image:Mediawiki.png|border]]</nowiki>
| Shows a 1px border around the image.
|-
|-
| thumbnail<br />thumb
| thumbnail<br />thumb
| <nowiki>[[Image:Mediawiki.png|thumbnail]]</nowiki>
| <nowiki>[[Image:Mediawiki.png|thumbnail]]</nowiki>
| Modifies image size, sets it to dependant on user's favourite thumbnail size in their preferences.
| Modifies image size, sets it to dependant on user's favourite thumbnail size in their preferences, or on the given width parameter (see below).
|-
|-
| thumb=''xyz''
| thumb=''xyz''
| <nowiki>[[Image:Mediawiki.png|thumb=Wiki.png]]</nowiki>
| <nowiki>[[Image:Mediawiki.png|thumb=Wiki.png]]</nowiki>
| Manualthumb: instead of displaying an automatically-sized thumbnail for <var>Mediawiki.png</var>, display the image <var>Wiki.png</var>.
| Manualthumb: instead of displaying an automatically-sized thumbnail for <var>Mediawiki.png</var>, display the image <var>Wiki.png</var>.
|-
|-valign="top"
| ''width'' px
| ''width'' px<br>100x200px
| <nowiki>[[Image:Mediawiki.png|40px]]</nowiki>
| <nowiki>[[Image:Mediawiki.png|40px]]</nowiki><br><nowiki>[[Image:Mediawiki.png|100x200px]]</nowiki>
| Scales image to given ''width''  in pixels
| Scales image to given ''width''  in pixels<br>Scales image to no more than 100 pixels wide and no more than 200 high, but image scaled to retain it's true aspect ratio within the boundary specified.
|}{{-}}
|}{{-}}
=== Position ===
=== Position ===
:''For details see [[Help:Images_and_other_uploaded_files]]''
:''For details see [[Help:Images_and_other_uploaded_files]]''
The positions are mutually exclusive, the last specified wins. [[:Template:-]] can stop floating. For inline images only modifier ''px'' (see above) is supported.
The positions are mutually exclusive; the last specified wins. [[:Template:-]] can stop floating. For inline images only modifier ''px'' (see above) is supported.
{| class="wikitable" border="2" cellpadding="4" cellspacing="0" width="100%"
{| class="wikitable" border="2" cellpadding="4" cellspacing="0" width="100%"
! Word
! Word
| <nowiki>{{CONTENTLANGUAGE}}</nowiki>
| <nowiki>{{CONTENTLANGUAGE}}</nowiki>
| <code>{{CONTENTLANGUAGE}}</code>
| <code>{{CONTENTLANGUAGE}}</code>
| '''[MW1.7+]''' Default content {{h:mwg|LanguageCode}}
| '''[MW1.7+]''' code of the site's default interface language ({{h:mwg|LanguageCode}})
|-
|-
| <nowiki>{{DEFAULTSORT:xyz}}</nowiki>
| <nowiki>{{DEFAULTSORT:xyz}}</nowiki>
|
| <nowiki>{{DEFAULTSORT:xyz}}</nowiki>
| '''[MW1.10+]''' Sets a default [[Help:Categories#Sort_key|category sort key]] for the current page<ref>"[[w:Wikipedia:Wikipedia Signpost/2007-01-02/Technology report|Technology report]]", en-Wikipedia Signpost, January 2007</ref>.
| '''[MW1.10+]''' Sets a default [[Help:Categories#Sort_key|category sort key]] for the whole current page (also applying for category tags before this tag)<ref>"[[w:Wikipedia:Wikipedia Signpost/2007-01-02/Technology report|Technology report]]", en-Wikipedia Signpost, January 2007</ref>.
|-
|-
| <nowiki>#redirect</nowiki>
| <nowiki>#REDIRECT</nowiki>
| <code>#REDIRECT [[target]]</code><br />at top of source page
| <code>#REDIRECT [[target]]</code><br />at top of source page
| Creates a [[Help:Redirect|redirect]] to another page.
| Creates a [[Help:Redirect|redirect]] to another page.
"Grammar" can either be applied to predefined words only, or to arbitrary words, depending on whether the definition is just a 2D array, or involves string manipulations. See also [[:cs:Šablona:Wikivar/GRAMMAR]].
"Grammar" can either be applied to predefined words only, or to arbitrary words, depending on whether the definition is just a 2D array, or involves string manipulations. See also [[:cs:Šablona:Wikivar/GRAMMAR]].
"Plural" is a project-dependent switch function, e.g. giving the first text if ''count'' = 1, the second if ''count'' = 2,3, or 4, and else the third.
"Plural" is a site-language-dependent switch function, controlled by function convertPlural in Language.php (which distinguishes between 1 and "not 1"), for some languages overridden in Languagexx.php, e.g. for French (which distinguishes between <=1 and >1) and Russian (oddly, first option is 1, 21, 31,.., 91, 101, 121, .., second is 2, 3, 4, 22, 23, 24, 31, 32, 33, 41,.., 94, 102, 103, 104,.., 122, 123,.., and else the third).
As opposed to [[ParserFunctions]], "plural" accepts points and commas in numbers and interprets them in a site-language-specific way (depending on $separatorTransformTable in Messagesxx.php); on this site:
*<nowiki>{{plural:1.000|a|b|c}}</nowiki> gives {{plural:1.000|a|b|c}}
*<nowiki>{{plural:1,000|a|b|c}}</nowiki> gives {{plural:1,000|a|b|c}}
(on e.g. the German and the Dutch sites reversed w.r.t. the result on English sites).
"Plural" is used in various system messages, e.g. {{msg|nmembers}}, where it uses interface language instead of site language.
{{H:f|enname=Magic words}}