This book of the law ... thou mayest observe to do according to all that is written therein: for then thou shalt make thy way prosperous, and then thou shalt have good success. - Joshua 1:8
Establishing the Bible as a primary Textbook for the foundation of facts on all subject matter.

Help:Magic words

From OpenWordBase

(Redirected from Help:Variables)
Jump to: navigation, search
PD
 Important note: When you edit this page, you agree to release your contribution into the public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages.

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.

Contents

[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 m: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
__END__ Explicitly marks the end of the article, to prevent MediaWiki from removing trailing whitespace. Removed in 19213.
__START__ No effect.
[edit]

Variables

The syntax of variables 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".

[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}} 2012 Year
Month
{{CURRENTMONTH}} 02 Month (zero-padded number)
{{CURRENTMONTHNAME}} February Month (name)
{{CURRENTMONTHNAMEGEN}} February Month (genitive form)
{{CURRENTMONTHABBREV}} Feb 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}} 2 Day of the week (unpadded number)
{{CURRENTDAYNAME}} Tuesday Day of the week (name)
Time
{{CURRENTTIME}} 04:40 Time (24-hour HH:mm format)
{{CURRENTHOUR}} Template:CURRENTHOUR Hour (24-hour zero-padded number)
Other
{{CURRENTWEEK}} 6 Week (number)
{{CURRENTTIMESTAMP}} Template:CURRENTTIMESTAMP 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}} OpenWordBase The wiki's site name (Template:Urlencode:Manual:$wgSitename $wgSitename).
{{CURRENTVERSION}} Template:CURRENTVERSION The wiki's MediaWiki version. 1.7+
{{CONTENTLANGUAGE}} Template:CONTENTLANGUAGE The wiki's default interface language (Template:Urlencode:Manual:$wgLanguageCode $wgLanguageCode)
Latest revision to current page
{{REVISIONID}} 1876 Unique ID
{{REVISIONDAY}} Template:REVISIONDAY Day edit was made (unpadded number)
{{REVISIONDAY2}} Template:REVISIONDAY2 Day edit was made (zero-padded number)
{{REVISIONMONTH}} Template:REVISIONMONTH Month edit was made (unpadded number)
{{REVISIONYEAR}} Template:REVISIONYEAR Year edit was made
{{REVISIONTIMESTAMP}} Template:REVISIONTIMESTAMP 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}} = Template:NUMBEROFPAGES and {{NUMBEROFPAGES:R}} = Template:NUMBEROFPAGES:R). 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}} Template:NUMBEROFPAGES Number of wiki pages. 1.7+
{{NUMBEROFARTICLES}} 116 Number of pages in main namespace.
{{NUMBEROFFILES}} 20 Number of uploaded files. 1.5+
{{NUMBEROFEDITS}} Template:NUMBEROFEDITS Number of page edits. 1.10+
{{NUMBEROFUSERS}} Template:NUMBEROFUSERS Number of registered users. 1.7+
{{NUMBEROFADMINS}} Template:NUMBEROFADMINS Number of users in in the sysop group. 1.7+
Per namespace
{{PAGESINNS:2}} Template:PAGESINNS:2 Number of pages in the given namespace (replace 2 with the relevant namespace ID). Disabled by default, enable with Template:Urlencode:Manual:$wgAllowSlowParserFunctions $wgAllowSlowParserFunctions. 1.7+
{{PAGESINNAMESPACE:2}} Template:PAGESINNAMESPACE:2 Alias for {{PAGESINNS}}. 1.7+
Other
{{PAGESINCATEGORY:Help}} Template:PAGESINCATEGORY:Help Number of pages in the given category (replace "Help" with the relevant category name). 1.13+
{{PAGESINCAT:Help}} Template:PAGESINCAT:Help Alias for {{PAGESINCATEGORY}}. 1.13+
{{PAGESIZE:Help:Magic_words}} Template:PAGESIZE:Help:Magic words Returns the byte size of the specified page. 1.13+
[edit]

URL data

[edit]

URLs

Variable Output Description Versions
{{SERVER}} http://www.openwordbase.com domain URL (Template:Urlencode:Manual:$wgServer $wgServer)
{{SERVERNAME}} www.openwordbase.com domain name (Template:Urlencode:Manual:$wgServerName $wgServerName)
{{SCRIPTPATH}} /wiki relative script path (Template:Urlencode:Manual:$wgScriptPath $wgScriptPath)
{{localurl:page name}}
{{localurl:page name|query string}} 		/owb/Page_name
/wiki/index.php?title=Page_name&query string 		relative path to title
{{fullurl:page name}}
{{fullurl:page name|query_string}} 		http://www.openwordbase.com/owb/Page_name
http://www.openwordbase.com/wiki/index.php?title=Page_name&query_string 		absolute path to title
{{filepath:file name}}
{{filepath:file name|nowiki}} 		Template:Filepath:Wiki.png
Template:Filepath:Wiki.png 		absolute path to image or media file (nowiki parameter currenty buggy) r25854
[edit]

Page names

Variable Output Description Versions
{{FULLPAGENAME}} Help:Magic words Namespace and page title.
{{PAGENAME}} Magic words Page title.
{{BASEPAGENAME}} Template:BASEPAGENAME 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}} Template:SUBJECTPAGENAME The namespace and title of the associated content page. 1.7+
{{TALKPAGENAME}} Template:TALKPAGENAME 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 Versions
{{NAMESPACE}} Help Namespace (name)
{{SUBJECTSPACE}} Template:SUBJECTSPACE Name of the associated content namespace
{{TALKSPACE}} Template:TALKSPACE Name of the associated talk namespace

The following are URL-encoded equivalents:

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

{{ns:}} returns the localized namespace name for that number of 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}} OpenWordBase
{{ns:5}} or {{ns:Project_talk}} OpenWordBase_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
Retrieved from "http://www.openwordbase.com/owb/Help:Magic_words"
Personal tools