Tenboro at 23:20, 7 April 2008

2008-04-07T23:20:44Z

← Older revision		Revision as of 23:20, 7 April 2008
Line 168:		Line 168:
	\| <nowiki>{{SITENAME}}</nowiki>		\| <nowiki>{{SITENAME}}</nowiki>
	\| {{SITENAME}}		\| {{SITENAME}}
	\| The wiki's site name ~~({{mediawiki\|Manual:$wgSitename\|$wgSitename}})~~.		\| The wiki's site name.
	\|-		\|-
	\| <nowiki>{{CURRENTVERSION}}</nowiki>		\| <nowiki>{{CURRENTVERSION}}</nowiki>
Line 177:		Line 177:
	\| <nowiki>{{CONTENTLANGUAGE}}</nowiki>		\| <nowiki>{{CONTENTLANGUAGE}}</nowiki>
	\| {{CONTENTLANGUAGE}}		\| {{CONTENTLANGUAGE}}
	\| The wiki's default interface language ~~({{mediawiki\|Manual:$wgLanguageCode\|$wgLanguageCode}})~~		\| The wiki's default interface language.
	\|-		\|-
	\|{{Hl3}} colspan="4"\| '''Latest revision to current page'''		\|{{Hl3}} colspan="4"\| '''Latest revision to current page'''
Line 244:		Line 244:
	\| {{NUMBEROFADMINS}}		\| {{NUMBEROFADMINS}}
	\| Number of users in in the ''sysop'' [[Help:User rights\|group]].		\| Number of users in in the ''sysop'' [[Help:User rights\|group]].
	~~\| 1.7+~~
	\|-
	~~\|{{Hl3}} colspan="4"\| '''Per namespace'''~~
	\|-
	~~\| <nowiki>{{PAGESINNS:2}}</nowiki>~~
	~~\| {{PAGESINNS:0}}~~
	\| Number of pages in the given [[Help:Namespaces\|namespace]] (replace 2 with the relevant namespace ID). Disabled by default, enable with {{mediawiki\|Manual:$AllowSlowParserFunctions\|$AllowSlowParserFunctions}}.
	~~\| 1.7+~~
	\|-
	~~\| <nowiki>{{PAGESINNAMESPACE:2}}</nowiki>~~
	~~\| {{PAGESINNAMESPACE:2}}~~
	~~\| Alias for <code><nowiki>{{PAGESINNS}}</nowiki></code>.~~
	\| 1.7+		\| 1.7+
	\|}		\|}

Tenboro: New page: '''Magic words''' are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words...

2008-04-07T23:17:18Z

New page: '''Magic words''' are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words...

New page

'''Magic words''' are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words; for a technical reference, see [[Manual:Magic words]].

==General notes==
* '''Inheritance:''' page-dependent magic words will affect or return data about the current page, regardless of whether it is in the page code or a transcluded template.

==Behaviour switches==
A behaviour switch controls the layout of the page. They are written as a magic word wrapped with double underscores.

{| {{prettytable}}
|-
!{{Hl2}}| Word
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="3"| '''Table of contents'''
|-
| <nowiki>__NOTOC__</nowiki>
| Hides the table of contents (TOC).
|-
|<nowiki>__FORCETOC__</nowiki>
| Forces the table of content to appear at its normal position (above the first header).
|-
| <nowiki>__TOC__</nowiki>
| Places a table of contents at the word's current position (overriding <nowiki>__NOTOC__</nowiki>). If this is used multiple times, the table of contents will appear at the first word's position.
|-
|{{Hl3}} colspan="3"| '''Editing'''
|-
| <nowiki>__NOEDITSECTION__</nowiki>
| Hides the section edit links beside headings.
|-
| <nowiki>__NEWSECTIONLINK__</nowiki>
| Adds a link (([[MediaWiki:Addsection|"+" by default]]) beside the "edit" tab for adding a new section on a non-talk page (see [[m:Help:Section#Adding a section at the end]]).
| 1.7+
|-
|{{Hl3}} colspan="3"| '''Categories'''
|-
| <nowiki>__NOGALLERY__</nowiki>
| Used on a category page, replaces thumbnails in the category view with normal links.
| 1.7+
|-
| <nowiki>__HIDDENCAT__</nowiki>
| 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).
| 1.13+
|-
|{{Hl3}} colspan="3"| '''Language conversion'''
|-
| <nowiki>__NOCONTENTCONVERT__</nowiki> <nowiki>__NOCC__</nowiki>
| 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>__NOTITLECONVERT__</nowiki> <nowiki>__NOTC__</nowiki>
| On wikis with language variants, don't perform language conversion on the title (all other content is converted).
|-
|{{Hl3}} colspan="3"| '''Other'''
|-
| <nowiki>__END__</nowiki>
| Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace (does not seem to work anymore).
|-
| <nowiki>__START__</nowiki>
| No effect.
|}

==Variables==
The syntax of variables is similar to [[Help:Templates|templates]], but capitalized to help avoid conflicts. If a template has the same name and case as a variable, the variable will be used. Usage of the template can be forced by adding the "msg:" modifier (for example, "<code><nowiki>{{msg:CURRENTYEAR}}</nowiki></code>"). In some cases, adding parameters will force the parser to treat a variable as a template; for example, <code><nowiki>{{CURRENTDAYNAME|x}}</nowiki></code> tries to transclude "Template:CURRENTDAYNAME".

===Date & time===
The following variables return the current date and time according to the user's timezone [[Special:Preferences|preferences]], defaulting to the UTC timezone.

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

{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Year'''
|-
| <nowiki>{{CURRENTYEAR}}</nowiki>
| {{CURRENTYEAR}}
| Year
|-
|{{Hl3}} colspan="4"| '''Month'''
|-
| <nowiki>{{CURRENTMONTH}}</nowiki>
| {{CURRENTMONTH}}
| Month (zero-padded number)
|-
| <nowiki>{{CURRENTMONTHNAME}}</nowiki>
| {{CURRENTMONTHNAME}}
| Month (name)
|-
| <nowiki>{{CURRENTMONTHNAMEGEN}}</nowiki>
| {{CURRENTMONTHNAMEGEN}}
| Month ([http://en.wikipedia.org/wiki/genitive genitive form])
|-
| <nowiki>{{CURRENTMONTHABBREV}}</nowiki>
| {{CURRENTMONTHABBREV}}
| Month (abbreviation)
| 1.5+
|-
|{{Hl3}} colspan="4"| '''Day'''
|-
| <nowiki>{{CURRENTDAY}}</nowiki>
| {{CURRENTDAY}}
| Day of the month (unpadded number)
|-
| <nowiki>{{CURRENTDAY2}}</nowiki>
| {{CURRENTDAY2}}
| Day of the month (zero-padded number)
| 1.6+
|-
| <nowiki>{{CURRENTDOW}}</nowiki>
| {{CURRENTDOW}}
| Day of the week (unpadded number)
|-
| <nowiki>{{CURRENTDAYNAME}}</nowiki>
| {{CURRENTDAYNAME}}
| Day of the week (name)
|-
|{{Hl3}} colspan="4"| '''Time'''
|-
| <nowiki>{{CURRENTTIME}}</nowiki>
| {{CURRENTTIME}}
| Time (24-hour HH:mm format)
|-
| <nowiki>{{CURRENTHOUR}}</nowiki>
| {{CURRENTHOUR}}
| Hour (24-hour zero-padded number)
|-
|{{Hl3}} colspan="4"| '''Other'''
|-
| <nowiki>{{CURRENTWEEK}}</nowiki>
| {{CURRENTWEEK}}
| Week (number)
|-
| <nowiki>{{CURRENTTIMESTAMP}}</nowiki>
| {{CURRENTTIMESTAMP}}
| [[w:ISO 8601|ISO 8601]] time stamp
| 1.7+
|}

The following variables do the same as the above, but using the site's local timezone instead of user preferences and UTC:
* <nowiki>{{LOCALYEAR}}</nowiki>
* <nowiki>{{LOCALMONTH}}</nowiki>
* <nowiki>{{LOCALMONTHNAME}}</nowiki>
* <nowiki>{{LOCALMONTHABBREV}}</nowiki>
* <nowiki>{{LOCALDAY}}</nowiki>
* <nowiki>{{LOCALDAY2}}</nowiki>
* <nowiki>{{LOCALDOW}}</nowiki>
* <nowiki>{{LOCALDAYNAME}}</nowiki>
* <nowiki>{{LOCALTIME}}</nowiki>
* <nowiki>{{LOCALHOUR}}</nowiki>
* <nowiki>{{LOCALWEEK}}</nowiki>
* <nowiki>{{LOCALTIMESTAMP}}</nowiki>

===Technical metadata===
Revision variables return data about the '''latest edit to the current page''', even if viewing an older version of the page.
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Site'''
|-
| <nowiki>{{SITENAME}}</nowiki>
| {{SITENAME}}
| The wiki's site name ({{mediawiki|Manual:$wgSitename|$wgSitename}}).
|-
| <nowiki>{{CURRENTVERSION}}</nowiki>
| {{CURRENTVERSION}}
| The wiki's MediaWiki version.
| 1.7+
|-
| <nowiki>{{CONTENTLANGUAGE}}</nowiki>
| {{CONTENTLANGUAGE}}
| The wiki's default interface language ({{mediawiki|Manual:$wgLanguageCode|$wgLanguageCode}})
|-
|{{Hl3}} colspan="4"| '''Latest revision to current page'''
|-
| <nowiki>{{REVISIONID}}</nowiki>
| {{REVISIONID}}
| Unique ID
|-
| <nowiki>{{REVISIONDAY}}</nowiki>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
|-
| <nowiki>{{REVISIONDAY2}}</nowiki>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
|-
| <nowiki>{{REVISIONMONTH}}</nowiki>
| {{REVISIONMONTH}}
| Month edit was made (unpadded number)
|-
| <nowiki>{{REVISIONYEAR}}</nowiki>
| {{REVISIONYEAR}}
| Year edit was made
|-
| <nowiki>{{REVISIONTIMESTAMP}}</nowiki>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
|}

===Statistics===
Numbers returned by these variables contain number separators, but can return raw numbers with the ":R" flag (for example, <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code> = {{NUMBEROFPAGES}} and <code><nowiki>{{NUMBEROFPAGES:R}}</nowiki></code> = {{NUMBEROFPAGES:R}}).
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
|{{Hl3}} colspan="4"| '''Entire wiki'''
|-
| <nowiki>{{NUMBEROFPAGES}}</nowiki>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
| 1.7+
|-
| <nowiki>{{NUMBEROFARTICLES}}</nowiki>
| {{NUMBEROFARTICLES}}
| Number of pages in main namespace.
|-
| <nowiki>{{NUMBEROFFILES}}</nowiki>
| {{NUMBEROFFILES}}
| Number of uploaded files.
| 1.5+
|-
| <nowiki>{{NUMBEROFEDITS}}</nowiki>
| {{NUMBEROFEDITS}}
| Number of page edits.
| [[rev:21319|1.10+]]
|-
| <nowiki>{{NUMBEROFUSERS}}</nowiki>
| {{NUMBEROFUSERS}}
| Number of registered users.
| 1.7+
|-
| <nowiki>{{NUMBEROFADMINS}}</nowiki>
| {{NUMBEROFADMINS}}
| Number of users in in the ''sysop'' [[Help:User rights|group]].
| 1.7+
|-
|{{Hl3}} colspan="4"| '''Per namespace'''
|-
| <nowiki>{{PAGESINNS:2}}</nowiki>
| {{PAGESINNS:0}}
| Number of pages in the given [[Help:Namespaces|namespace]] (replace 2 with the relevant namespace ID). Disabled by default, enable with {{mediawiki|Manual:$AllowSlowParserFunctions|$AllowSlowParserFunctions}}.
| 1.7+
|-
| <nowiki>{{PAGESINNAMESPACE:2}}</nowiki>
| {{PAGESINNAMESPACE:2}}
| Alias for <code><nowiki>{{PAGESINNS}}</nowiki></code>.
| 1.7+
|}

===URL data===
====URLs====
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
| <nowiki>{{SERVER}}</nowiki>
| {{SERVER}}
| domain URL ({{mediawiki|Manual:$wgServer|$wgServer}})
|-
| <nowiki>{{SERVERNAME}}</nowiki>
| {{SERVERNAME}}
| domain name ({{mediawiki|Manual:$wgServerName|$wgServerName}})
|-
| <nowiki>{{SCRIPTPATH}}</nowiki>
| {{SCRIPTPATH}}
| relative script path ({{mediawiki|Manual:$wgScriptPath|$wgScriptPath}})
|-
| <nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki> <nowiki>{{localurl:page name|</nowiki>''query string''<nowiki>}}</nowiki>
| {{localurl:page name}} {{localurl:page name|query string}}
| relative path to title
|-
| <nowiki>{{fullurl:</nowiki>''page name''<nowiki>}}</nowiki> <nowiki>{{fullurl:page name|</nowiki>''query string''<nowiki>}}</nowiki>
| {{fullurl:page name}} {{fullurl:page name|query string}}
| absolute path to title
|}

====Page names====
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
| <nowiki>{{FULLPAGENAME}}</nowiki>
| {{FULLPAGENAME}}
| Namespace and page title.
|-
| <nowiki>{{PAGENAME}}</nowiki>
| {{PAGENAME}}
| Page title.
|-
| <nowiki>{{BASEPAGENAME}}</nowiki>
| {{BASEPAGENAME}}
| Page title excluding the current [[Help:subpage|subpage]] and namespace ("Title" on "Title/foo").
| 1.7+
|-
| <nowiki>{{SUBPAGENAME}}</nowiki>
| {{SUBPAGENAME}}
| The [[Help:subpage|subpage]] title ("foo" on "Title/foo").
| 1.6+
|-
| <nowiki>{{SUBJECTPAGENAME}}</nowiki>
| {{SUBJECTPAGENAME}}
| The namespace and title of the associated content page.
| 1.7+
|-
| <nowiki>{{TALKPAGENAME}}</nowiki>
| {{TALKPAGENAME}}
| The namespace and title of the associated talk page.
| 1.7+
|}

The following are URL-encoded equivalents:
* <nowiki>{{FULLPAGENAMEE}}</nowiki>
* <nowiki>{{PAGENAMEE}}</nowiki>
* <nowiki>{{BASEPAGENAMEE}}</nowiki>
* <nowiki>{{SUBPAGENAMEE}}</nowiki>
* <nowiki>{{SUBJECTPAGENAMEE}}</nowiki>
* <nowiki>{{TALKPAGENAMEE}}</nowiki>

====Namespaces====
{| {{prettytable}}
|-
!{{Hl2}}| Variable
!{{Hl2}}| Output
!{{Hl2}}| Description
!{{Hl2}}| Versions
|-
| <nowiki>{{NAMESPACE}}</nowiki>
| {{NAMESPACE}}
| Namespace (name)
|-
| <nowiki>{{SUBJECTSPACE}}</nowiki>
| {{SUBJECTSPACE}}
| Name of the associated content namespace
|-
| <nowiki>{{TALKSPACE}}</nowiki>
| {{TALKSPACE}}
| Name of the associated talk namespace
|}

The following are URL-encoded equivalents:
* <nowiki>{{NAMESPACEE}}</nowiki>
* <nowiki>{{SUBJECTSPACEE}}</nowiki>
* <nowiki>{{TALKSPACEE}}</nowiki>

<code><nowiki>{{ns:}}</nowiki></code> returns the localized namespace name for that number of constant. The default values are:

{| {{prettytable}}
|-
!{{Hl2}}| Usage
!{{Hl2}}| Output
|-
| <nowiki>{{ns:-2}} or {{ns:Media}}</nowiki>
| {{ns:-2}}
|-
| <nowiki>{{ns:-1}} or {{ns:Special}}</nowiki>
| {{ns:-1}}
|-
| <nowiki>{{ns:0}}</nowiki>
| {{ns:0}}
|-
| <nowiki>{{ns:1}} or {{ns:Talk}}</nowiki>
| {{ns:1}}
|-
| <nowiki>{{ns:2}} or {{ns:User}}</nowiki>
| {{ns:2}}
|-
| <nowiki>{{ns:3}} or {{ns:User_talk}}</nowiki>
| {{ns:3}}
|-
| <nowiki>{{ns:4}} or {{ns:Project}}</nowiki>
| {{ns:4}}
|-
| <nowiki>{{ns:5}} or {{ns:Project_talk}}</nowiki>
| {{ns:5}}
|-
| <nowiki>{{ns:6}} or {{ns:Image}}</nowiki>
| {{ns:6}}
|-
| <nowiki>{{ns:7}} or {{ns:Image_talk}}</nowiki>
| {{ns:7}}
|-
| <nowiki>{{ns:8}} or {{ns:MediaWiki}}</nowiki>
| {{ns:8}}
|-
| <nowiki>{{ns:9}} or {{ns:MediaWiki_talk}}</nowiki>
| {{ns:9}}
|-
| <nowiki>{{ns:10}} or {{ns:Template}}</nowiki>
| {{ns:10}}
|-
| <nowiki>{{ns:11}} or {{ns:Template_talk}}</nowiki>
| {{ns:11}}
|-
| <nowiki>{{ns:12}} or {{ns:Help}}</nowiki>
| {{ns:12}}
|-
| <nowiki>{{ns:13}} or {{ns:Help_talk}}</nowiki>
| {{ns:13}}
|-
| <nowiki>{{ns:14}} or {{ns:Category}}</nowiki>
| {{ns:14}}
|-
| <nowiki>{{ns:15}} or {{ns:Category_talk}}</nowiki>
| {{ns:15}}
|}

[[Category:Help|Variables]]

Help:Magic words - Revision history

Tenboro at 23:20, 7 April 2008

Tenboro: New page: '''Magic words''' are strings of text that MediaWiki associates with a return value or function, such as time, site details, or page names. This page is about usage of standard magic words...