Help:Magic words

Latest revision as of 15:19, 9 February 2009

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

There are three general types of magic words:

Behavior switches: these are uppercase words surrounded by double underscores (eg __FOO__)
Variables: these are uppercase words surrounded by double braces (eg <tt>{{FOO}}</tt>). As such, they look a lot like templates
Parser functions: these take parameters and are either of the form <tt>{{foo:...}}</tt> or <tt>{{#foo:...}}</tt>.

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

[edit] Behaviour switches

A behaviour switch controls the layout or behaviour 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 content 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.
Categories
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 [rev:19213] .

[edit] Variables

Variables return information about the current page, wiki, or date. Their syntax is similar to templates. 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 treat a variable as a template; for example, {{CURRENTDAYNAME|x}} transcludes Template:CURRENTDAYNAME.

[edit] Date & time

The following variables return the current date and time according to the user's timezone 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.

Variable	Output	Description	Versions
Year
`{{CURRENTYEAR}}`	2024	Year
Month
`{{CURRENTMONTH}}`	11	Month (zero-padded number)
`{{CURRENTMONTHNAME}}`	November	Month (name)
`{{CURRENTMONTHNAMEGEN}}`	November	Month (genitive form)
`{{CURRENTMONTHABBREV}}`	Nov	Month (abbreviation)	1.5+
Day
`{{CURRENTDAY}}`	23	Day of the month (unpadded number)
`{{CURRENTDAY2}}`	23	Day of the month (zero-padded number)	1.6+
`{{CURRENTDOW}}`	6	Day of the week (unpadded number)
`{{CURRENTDAYNAME}}`	Saturday	Day of the week (name)
Time
`{{CURRENTTIME}}`	08:42	Time (24-hour HH:mm format)
Other
`{{CURRENTWEEK}}`	47	Week (number)

The following variables do the same as the above, but using the site's local timezone instead of user preferences and UTC:

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

[edit] Technical metadata

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}}`	CityDeepSky	The wiki's site name ([Manual:$wgSitename] ).
`{{SERVER}}`	http://citydeepsky.com	domain URL ([Manual:$wgServer] )
`{{SERVERNAME}}`	citydeepsky.com	domain name ([Manual:$wgServerName] )
`{{SCRIPTPATH}}`	/wiki	relative script path ([Manual:$wgScriptPath] )
Latest revision to current page
`{{REVISIONID}}`	2507	Unique ID	1.5+

[edit] Statistics

Numbers returned by these variables normally contain separators (commas or spaces, depending on the local language). |- !bgcolor="#A7C1F2" | Variable !bgcolor="#A7C1F2" | Output !bgcolor="#A7C1F2" | Description !bgcolor="#A7C1F2" | Versions |- |bgcolor="#8DA7D6" color="black" colspan="4"| Entire wiki |- | {{NUMBEROFARTICLES}} | 256 | Number of pages in main namespace. | |- | {{NUMBEROFFILES}} | 289 | Number of uploaded files. | 1.5+ |}

[edit] Page names

Variable	Output	Description	Versions
`{{FULLPAGENAME}}`	Help:Magic words	Namespace and page title.	1.6+
`{{PAGENAME}}`	Magic words	Page title.
`{{SUBPAGENAME}}`	Magic words	The subpage title ("foo" on "Title/foo").	1.6+

The following are URL-encoded equivalents:

{{FULLPAGENAMEE}}
{{PAGENAMEE}}
{{SUBPAGENAMEE}}

[edit] Namespaces

Variable	Output	Description	Versions
`{{NAMESPACE}}`	Help	Namespace (name)

The following are URL-encoded equivalents:

{{NAMESPACEE}}

[edit] Parser functions

Parser functions are very similar to variables, but operate on user input instead of the current page.

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 [Extension:ParserFunctions] .

[edit] URL data

Variable	Output	Description	Versions
`{{localurl:page name}}` `{{localurl:page name\|query string}}`	/wiki/index.php/Page_name /wiki/index.php?title=Page_name&query string	relative path to title
`{{fullurl:page name}}` `{{fullurl:page name\|query_string}}`	http://citydeepsky.com/wiki/index.php/Page_name http://citydeepsky.com/wiki/index.php?title=Page_name&query_string	absolute path to title	1.5+

[edit] Namespaces

{{ns:}} returns the localized name for the namespace with that index.

Usage	Output	Usage	Output
`{{ns:-2}}` or `{{ns:Media}}`	Media	`{{ns:-1}}` or `{{ns:Special}}`	Special
`{{ns:0}}`		`{{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}}`	CityDeepSky	`{{ns:5}}` or `{{ns:Project_talk}}`	CityDeepSky 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

[edit] Formatting

Usage	Output	Description	Version
`{{lc:string}}`	xyz	The lowercase input.	1.5+
`{{lcfirst:string}}`	xYZ	The input with the first character lowercase.	1.5+
`{{uc:string}}`	XYZ	The uppercase input.	1.5+
`{{ucfirst:string}}`	Xyz	The input with the first character uppercase.	1.5+
`{{plural:2\|is\|are}}`	are	Outputs the correct given pluralization form (parameters except first) depending on the count (first parameter). Plural transformations are used for languages like Russian based on "count mod 10".

Help:Magic words

Latest revision as of 15:19, 9 February 2009

Contents

[edit] Behaviour switches

[edit] Variables

[edit] Date & time

[edit] Technical metadata

[edit] Statistics

[edit] Page names

[edit] Namespaces

[edit] Parser functions

[edit] URL data

[edit] Namespaces

[edit] Formatting

Views

Personal tools

Navigation

Objects

Astronomical Reference

Help

Search

Tools

@@ Line 36: / Line 36: @@
 | 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 {{mediawiki|m:Help:Section#Adding a section at the end|Adding a section to 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'''
@@ Line 70: / Line 58: @@
 | Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in {{mediawiki|rev:19213|19213}}.
 |
-|-
-|  <nowiki>__INDEX__</nowiki>
-| Tell search engines to index the page (overrides {{mediawiki|Manual:$wgArticleRobotPolicies|$wgArticleRobotPolicies}}, but not robots.txt).
-| 1.13+
-|-
-|  <nowiki>__NOINDEX__</nowiki>
-| Tell search engines not to index the page (ie, do not list in search engines' results).
-| {{mediawiki|rev:37973|1.13+}}
-|-
-|  <nowiki>__STATICREDIRECT__</nowiki>
-| 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+}}
 |}
@@ Line 156: / Line 132: @@
 | {{CURRENTTIME}}
 | Time (24-hour HH:mm format)
-|
-|-
-| <tt><nowiki>{{CURRENTHOUR}}</nowiki></tt>
-| {{CURRENTHOUR}}
-| Hour (24-hour zero-padded number)
 |
 |-
@@ Line 169: / Line 140: @@
 | Week (number)
 |
-|-
-| <tt><nowiki>{{CURRENTTIMESTAMP}}</nowiki></tt>
-| {{CURRENTTIMESTAMP}}
-| [[wikipedia:ISO 8601|ISO 8601]] time stamp
-| 1.7+
 |}
@@ Line 187: / Line 153: @@
 * <tt><nowiki>{{LOCALDAYNAME}}</nowiki></tt>
 * <tt><nowiki>{{LOCALTIME}}</nowiki></tt>
-* <tt><nowiki>{{LOCALHOUR}}</nowiki></tt>
 * <tt><nowiki>{{LOCALWEEK}}</nowiki></tt>
-* <tt><nowiki>{{LOCALTIMESTAMP}}</nowiki></tt>
 ===Technical metadata===
@@ Line 216: / Line 180: @@
 | domain name ({{mediawiki|Manual:$wgServerName|$wgServerName}})
 |
-|-
-| <tt><nowiki>{{DIRMARK}}</nowiki></tt><br /><tt><nowiki>{{DIRECTIONMARK}}</nowiki></tt>
-| {{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.
-| 1.7+
 |-
 | <tt><nowiki>{{SCRIPTPATH}}</nowiki></tt>
@@ Line 226: / Line 185: @@
 | relative script path ({{mediawiki|Manual:$wgScriptPath|$wgScriptPath}})
 |
-|-
-| <tt><nowiki>{{CURRENTVERSION}}</nowiki></tt>
-| {{CURRENTVERSION}}
-| The wiki's MediaWiki version.
-| 1.7+
-|-
-| <tt><nowiki>{{CONTENTLANGUAGE}}</nowiki></tt>
-| {{CONTENTLANGUAGE}}
-| The wiki's default interface language ({{mediawiki|Manual:$wgLanguageCode|$wgLanguageCode}})
-| 1.7+
 |-
 |{{Hl3}} colspan="4"| '''Latest revision to current page'''
@@ Line 243: / Line 192: @@
 | Unique ID
 | 1.5+
-|-
-| <tt><nowiki>{{REVISIONDAY}}</nowiki></tt>
-| {{REVISIONDAY}}
-| Day edit was made (unpadded number)
-| 1.8+
-|-
-| <tt><nowiki>{{REVISIONDAY2}}</nowiki></tt>
-| {{REVISIONDAY2}}
-| Day edit was made (zero-padded number)
-| 1.8+
-|-
-| <tt><nowiki>{{REVISIONMONTH}}</nowiki></tt>
-| {{REVISIONMONTH}}
-| Month edit was made (unpadded number)
-| 1.8+
-|-
-| <tt><nowiki>{{REVISIONYEAR}}</nowiki></tt>
-| {{REVISIONYEAR}}
-| Year edit was made
-| 1.8+
-|-
-| <tt><nowiki>{{REVISIONTIMESTAMP}}</nowiki></tt>
-| {{REVISIONTIMESTAMP}}
-| Timestamp as of time of edit
-| 1.8+
-|-
-| <tt><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></tt>
-| {{PAGESIZE:Help:Magic_words}}
-| Returns the byte size of the specified page.
-| {{mediawiki|rev:33551|1.13+}}
-|-
-| <tt><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></tt>
-| protection level
-| Outputs the protection level (e.g. 'autoconfirm', 'sysop') for a given action (e.g. 'edit', 'move') on the current page or an empty string if not protected.
-| [[rev:45587|1.15+]]
-|-
-|{{Hl3}} colspan="4"| '''Affects page content'''
-|-
-| <tt><nowiki>{{DISPLAYTITLE:</nowiki>''title''<nowiki>}}</nowiki></tt>
-| Format the current page's title header. The value must be equivalent to the default title: only capitalization changes and replacing spaces with underscores. It can be disabled or enabled by {{mediawiki|Manual:$wgAllowDisplayTitle|$wgAllowDisplayTitle}}; disabled by default before 1.10+, enabled by default thereafter.
-| 1.7+
-|-
-| <tt><nowiki>{{DEFAULTSORT:</nowiki>''sortkey''<nowiki>}}</nowiki></tt>
-| Used on a categorized page, sets a default [[Help:Categories|category sort key]].
-| 1.10+
 |}
 ===Statistics===
-Numbers returned by these variables normally contain separators (commas or spaces, depending on the local language), but can return raw numbers with the ":R" flag (for example, <code><tt><nowiki>{{NUMBEROFPAGES}}</nowiki></tt></code> &rarr; {{NUMBEROFPAGES}} and <code><tt><nowiki>{{NUMBEROFPAGES:R}}</nowiki></tt></code> &rarr; {{NUMBEROFPAGES:R}}). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example <code><tt><nowiki>{{PAGESINCATEGORY:Help}}</nowiki></tt></code> and <code><tt><nowiki>{{PAGESINCATEGORY:Help|R}}</nowiki></tt></code>).
+Numbers returned by these variables normally contain separators (commas or spaces, depending on the local language).
-{| {{prettytable}}
 |-
 !{{Hl2}}| Variable
@@ Line 300: / Line 203: @@
 |-
 |{{Hl3}} colspan="4"| '''Entire wiki'''
-|-
-| <tt><nowiki>{{NUMBEROFPAGES}}</nowiki></tt>
-| {{NUMBEROFPAGES}}
-| Number of wiki pages.
-| 1.7+
 |-
 | <tt><nowiki>{{NUMBEROFARTICLES}}</nowiki></tt>
@@ Line 315: / Line 213: @@
 | Number of uploaded files.
 | 1.5+
-|-
-| <tt><nowiki>{{NUMBEROFEDITS}}</nowiki></tt>
-| {{NUMBEROFEDITS}}
-| Number of page edits.
-| {{mediawiki|rev:21319|1.10+}}
-|-
-| <tt><nowiki>{{NUMBEROFUSERS}}</nowiki></tt>
-| {{NUMBEROFUSERS}}
-| Number of registered users.
-| 1.7+
-|-
-| <tt><nowiki>{{NUMBEROFADMINS}}</nowiki></tt>
-| {{NUMBEROFADMINS}}
-| Number of users in the ''sysop'' {{mediawiki|Manual:User rights|group}}.
-| 1.7+
-|-
-| <tt><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></tt><br /><tt><nowiki>{{PAGESINCAT:Help}}</nowiki></tt>
-| {{PAGESINCATEGORY:Help}}<br />{{PAGESINCAT:Help}}
-| Number of pages in the given [[Help:Categories|category]] (replace "Help" with the relevant category name).
-| {{mediawiki|rev:32932|1.13+}}
-|-
-| <tt><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></tt>
-| {{NUMBERINGROUP:bureaucrat}} <br /><nowiki>({{NUMBERINGROUP:bureaucrat}} used here)</nowiki>
-| Number of users in a specific {{mediawiki|Manual:User rights|group}}.
-| {{mediawiki|rev:40116|1.14+}}
-|-
-| <tt><nowiki>{{PAGESINNS:</nowiki>''index''<nowiki>}}</nowiki></tt><br /><tt><nowiki>{{PAGESINNAMESPACE:</nowiki>''index''<nowiki>}}</nowiki></tt>
-| ''not enabled''
-| Number of pages in the given [[Help:Namespaces|namespace]] (replace 2 with the relevant [[Manual:Namespace|namespace index]]). E.g. <tt><nowiki>{{PAGESINNAMESPACE:</nowiki>''14''<nowiki>}}</nowiki></tt> equals the number of categories. <!-- {{NUMBEROFCATEGORIES}} --> Disabled by default, enable with {{mediawiki|Manual:$wgAllowSlowParserFunctions|$wgAllowSlowParserFunctions}}.
-| 1.7+
 |}
@@ Line 364: / Line 232: @@
 | Page title.
 |
-|-
-| <tt><nowiki>{{BASEPAGENAME}}</nowiki></tt>
-| {{BASEPAGENAME}}
-| Page title excluding the current [[Help:Subpages|subpage]] and namespace ("Title" on "Title/foo").
-| 1.7+
 |-
 | <tt><nowiki>{{SUBPAGENAME}}</nowiki></tt>
@@ Line 374: / Line 237: @@
 | The [[Help:Subpages|subpage]] title ("foo" on "Title/foo").
 | 1.6+
-|-
-| <tt><nowiki>{{SUBJECTPAGENAME}}</nowiki></tt>
-| {{SUBJECTPAGENAME}}
-| The namespace and title of the associated content page.
-| 1.7+
-|-
-| <tt><nowiki>{{TALKPAGENAME}}</nowiki></tt>
-| {{TALKPAGENAME}}
-| The namespace and title of the associated talk page.
-| 1.7+
 |}
@@ Line 389: / Line 242: @@
 * <tt><nowiki>{{FULLPAGENAMEE}}</nowiki></tt>
 * <tt><nowiki>{{PAGENAMEE}}</nowiki></tt>
-* <tt><nowiki>{{BASEPAGENAMEE}}</nowiki></tt>
 * <tt><nowiki>{{SUBPAGENAMEE}}</nowiki></tt>
-* <tt><nowiki>{{SUBJECTPAGENAMEE}}</nowiki></tt>
-* <tt><nowiki>{{TALKPAGENAMEE}}</nowiki></tt>
 ====Namespaces====
@@ Line 528: / Line 379: @@
 [[Category:Help|{{PAGENAME}}]]
-[[Category:Time|{{PAGENAME}}]]
-[[Category:Magic words|{{PAGENAME}}]]