Help:Magic words

From Wiscopedia

Help Pages
Editing	Sourcing	Administering	Help:Images	Complex editing
Basic editing help. This is a resource for anyone but is especially aimed at new editors or editors unfamiliar with wiki formatting.	Help for sourcing. This includes basic guidelines on what kind of sources should be used and suggestions on how to cite sources.	These are instructions for administrators and editors interesting in making the nuts and bolts of Wiscopedia work.	Instructions on how to post images, what images should be used and help with image syntax.	Editing help for more advanced users. This includes template construction, categories and table construction.

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 the Mediawiki manual:Magic words.

1 General notes
2 Behaviour switches
3 Variables and parser functions

[edit] 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.

[edit] Behaviour switches

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

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.
__NEWSECTIONLINK__	Adds a link (("+" by default) beside the "edit" tab for adding a new section on a non-talk page (see Help:Section#Adding a section at the end).	1.7+
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.

[edit] Variables and parser functions

Variables return information about the current page, wiki, or date. Their syntax is similar to 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, "{{msg:CURRENTYEAR}}"). In some cases, adding parameters will force the parser to treat a variable as a template; for example, {{CURRENTDAYNAME|x}} tries to transclude "Template:CURRENTDAYNAME".

Parser functions are very similar to variables, but operate on user input instead of the current page. The first parameter is delimited by a colon (:) instead of a pipe (|). (This page does not document custom parser functions added by the mediawiki extension:ParserFunctions.)

[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}}	2009	Year
Month
{{CURRENTMONTH}}	01	Month (zero-padded number)
{{CURRENTMONTHNAME}}	January	Month (name)
{{CURRENTMONTHNAMEGEN}}	January	Month (genitive form)
{{CURRENTMONTHABBREV}}	Jan	Month (abbreviation)	1.5+
Day
{{CURRENTDAY}}	7	Day of the month (unpadded number)
{{CURRENTDAY2}}	07	Day of the month (zero-padded number)	1.6+
{{CURRENTDOW}}	3	Day of the week (unpadded number)
{{CURRENTDAYNAME}}	Wednesday	Day of the week (name)
Time
{{CURRENTTIME}}	20:56	Time (24-hour HH:mm format)
{{CURRENTHOUR}}	20	Hour (24-hour zero-padded number)
Other
{{CURRENTWEEK}}	2	Week (number)
{{CURRENTTIMESTAMP}}	20090107205655	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:

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

[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}}	Wiscopedia	The wiki's site name.
{{CURRENTVERSION}}	1.11.0	The wiki's MediaWiki version.	1.7+
{{CONTENTLANGUAGE}}	en	The wiki's default interface language
Latest revision to current page
{{REVISIONID}}	1835	Unique ID
{{REVISIONDAY}}	1	Day edit was made (unpadded number)
{{REVISIONDAY2}}	01	Day edit was made (zero-padded number)
{{REVISIONMONTH}}	8	Month edit was made (unpadded number)
{{REVISIONYEAR}}	2008	Year edit was made
{{REVISIONTIMESTAMP}}	20080801212441	Timestamp as of time of edit

[edit] Statistics

Numbers returned by these variables contain number separators, but can return raw numbers with the ":R" flag (for example, {{NUMBEROFPAGES}} = 223 and {{NUMBEROFPAGES:R}} = 223). Use "|R" for magic words that require a parameter like PAGESINCATEGORY (for example {{PAGESINCATEGORY:Help}} and {{PAGESINCATEGORY:Help|R}}).

Variable	Output	Description	Versions
Entire wiki
{{NUMBEROFPAGES}}	223	Number of wiki pages.	1.7+
{{NUMBEROFARTICLES}}	86	Number of pages in main namespace.
{{NUMBEROFFILES}}	24	Number of uploaded files.	1.5+
{{NUMBEROFEDITS}}	3,518	Number of page edits.
{{NUMBEROFUSERS}}	11	Number of registered users.	1.7+
{{NUMBEROFADMINS}}	2	Number of users in in the sysop.	1.7+

[edit] URL data

[edit] URLs

Variable	Output	Description	Versions
{{SERVER}}	http://www.wiscopedia.com	domain URL
{{SERVERNAME}}	www.wiscopedia.com	domain name
{{SCRIPTPATH}}		relative script path
{{localurl:page name}} {{localurl:page name\|query string}}	/index.php/Page_name /index.php?title=Page_name&query string	relative path to title
{{fullurl:page name}} {{fullurl:page name\|query_string}}	http://www.wiscopedia.com/index.php/Page_name http://www.wiscopedia.com/index.php?title=Page_name&query_string	absolute path to title	1.5+
{{urlencode:x y z}}	`xyz`	The input encoded for use in URLs.
{{anchorencode:x y z}}	`x_y_z`	The input encoded for use in URL section anchors (after the '#' symbol in a URL).

[edit] Page names

Variable	Output	Description	Versions
{{FULLPAGENAME}}	Help:Magic words	Namespace and page title.
{{PAGENAME}}	Magic words	Page title.
{{BASEPAGENAME}}	Magic words	Page title excluding the current subpage and namespace ("Title" on "Title/foo").	1.7+
{{SUBPAGENAME}}	Magic words	The subpage title ("foo" on "Title/foo").	1.6+
{{SUBJECTPAGENAME}}	Help:Magic words	The namespace and title of the associated content page.	1.7+
{{TALKPAGENAME}}	Help talk:Magic words	The namespace and title of the associated talk page.	1.7+

The following are URL-encoded equivalents:

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

[edit] Namespaces

Variable	Output	Description
{{NAMESPACE}}	Help	Namespace (name)
{{SUBJECTSPACE}}	Help	Name of the associated content namespace
{{TALKSPACE}}	Help talk	Name of the associated talk namespace

The following are URL-encoded equivalents:

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

{{ns:}} returns the localized namespace name for that number constant. The default values are:

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}}	Wiscopedia
{{ns:5}} or {{ns:Project_talk}}	Wiscopedia_talk
{{ns:6}} or {{ns:Image}}	Image
{{ns:7}} or {{ns:Image_talk}}	Image_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:XYZ}}	xyz	The lowercase input.	1.5+
{{lcfirst:XYZ}}	xYZ	The input with the first character lowercase.	1.5+
{{uc:xyz}}	XYZ	The uppercase input.	1.5+
{{ucfirst:xyz}}	Xyz	The input with the first character uppercase.	1.5+
{{formatnum:-987654321.654321}}	-987,654,321.654321	The input with decimal and decimal group separators, and localized digit script, according to the wiki's default locale.	1.7+
{{padleft:xyz\|5\|_}} {{padleft:xyz\|5}}	__xyz 00xyz	The input (first parameter) padded on the left side to the specified width (second parameter) using the specified character (third parameter). If a padding character isn't specified, '0' is used by default. bug: multibyte characters are interpreted as two characters, which can skew width. These also cannot be used as padding characters.	1.8+
{{padright:xyz\|5\|_}} {{padright:xyz\|5}}	xyz__ xyz00	Identical to padleft, but adds padding characters to the right side.

[edit] Miscellaneous

Usage	Output	Description	Version
{{#language:eo}}	Esperanto	The native name for the given language code.	1.7+
{{#special:userlogin}}	Special:Userlogin	The localized name for the given canonical Special: page.

Retrieved from "http://www.wiscopedia.com/index.php/Help:Magic_words"