Help:Magic words

From FamilySearch Wiki

(Difference between revisions)
(further formatting (add tables))
m (Corrected link)
Line 1: Line 1:
'''Magic words''' (which include '''parser functions''', '''variables''' and '''behavior switches''') are features of [[FamilySearch Wiki:wikitext|wikitext]] that enable various instructions to be given to the [[Help:MediaWiki|MediaWiki]] software (for example, to suppress or position the table of contents), or else serve to produce variable output, as is often required in [[FamilySearch Wiki:Templates|templates]].
+
'''Magic words''' (which include '''parser functions''', '''variables''' and '''behavior switches''') are features of [[FamilySearch Wiki:Wikitext|wikitext]] that enable various instructions to be given to the [http://wikimediafoundation.org/wiki/MediaWiki MediaWiki] software (for example, to suppress or position the table of contents), or else serve to produce variable output, as is often required in [[FamilySearch Wiki:Templates|templates]].  
  
A quick reference for magic words can be found on this page. For more complete and updated documentation, refer to following pages on the MediaWiki site:
+
A quick reference for magic words can be found on this page. For more complete and updated documentation, refer to following pages on the MediaWiki site:  
*'''{{mw|Help:Magic words}}''' for all standard magic words, including the "standard" parser functions
+
 
 +
*'''{{mw|Help:Magic words}}''' for all standard magic words, including the "standard" parser functions  
 
*'''{{mw|Help:Extension:ParserFunctions}}''' for some additional parser functions, including conditional expressions
 
*'''{{mw|Help:Extension:ParserFunctions}}''' for some additional parser functions, including conditional expressions
  
==General information==
+
== General information ==
There are three types of magic words:
+
 
*'''Behavior switches:''' uppercase words surrounded by double underscores, e.g. <tt><nowiki>__NOTOC__</nowiki></tt>, or keywords using parser function syntax
+
There are three types of magic words:  
*'''Variables:''' uppercase words surrounded by double braces, e.g. <tt><nowiki>{{PAGENAME}}</nowiki></tt> (thus resembling [[Help:Templates|templates]])
+
 
 +
*'''Behavior switches:''' uppercase words surrounded by double underscores, e.g. <tt><nowiki>__NOTOC__</nowiki></tt>, or keywords using parser function syntax  
 +
*'''Variables:''' uppercase words surrounded by double braces, e.g. <tt><nowiki>{{PAGENAME}}</nowiki></tt> (thus resembling [[Help:Templates|templates]])  
 
*'''Parser functions:''' keywords (some beginning #) in double braces with parameters after a colon, e.g. <tt><nowiki>{{#expr:2+2}}</nowiki></tt>
 
*'''Parser functions:''' keywords (some beginning #) in double braces with parameters after a colon, e.g. <tt><nowiki>{{#expr:2+2}}</nowiki></tt>
  
Some magic words are case-insensitive, but not all. Whitespace is stripped from the start and end of keywords and parameters, as in template syntax.
+
Some magic words are case-insensitive, but not all. Whitespace is stripped from the start and end of keywords and parameters, as in template syntax.  
  
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.
+
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.  
  
It is possible to [[Help:Substitution|substitute]] parser functions and variables in the same way that templates are substituted (using the <tt>subst:</tt> keyword). This causes their current value (as evaluated at the time of substitution) to be written into the wikitext.
+
It is possible to [[Help:Substitution|substitute]] parser functions and variables in the same way that templates are substituted (using the <tt>subst:</tt> keyword). This causes their current value (as evaluated at the time of substitution) to be written into the wikitext.  
  
 
== Behavior switches  ==
 
== Behavior switches  ==
Line 21: Line 24:
 
''For documentation, refer to the {{mw|Help:Magic words#Behavior switches|Behavior Switches}} section of the MediaWiki page.''  
 
''For documentation, refer to the {{mw|Help:Magic words#Behavior switches|Behavior Switches}} section of the MediaWiki page.''  
  
{|border="2" width="100%" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
+
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;" rules="all"
 
|-
 
|-
 
! bgcolor="#a7c1f2" | Word  
 
! bgcolor="#a7c1f2" | Word  
Line 67: Line 70:
 
''For documentation, refer to the {{mw|Help:Magic words#Variables|Variables}} section of the MediaWiki page.''  
 
''For documentation, refer to the {{mw|Help:Magic words#Variables|Variables}} section of the MediaWiki page.''  
  
{| width="100%" rules="all" cellspacing="4" cellpadding="3" border="2" style="margin: 1em 1em 1em 0pt; border: 1px solid rgb(170, 170, 170); border-collapse: collapse; empty-cells: show;"
+
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin: 1em 1em 1em 0pt; border: 1px solid rgb(170, 170, 170); border-collapse: collapse; empty-cells: show;" rules="all"
 
|-
 
|-
 
! bgcolor="#a7c1f2" | Variable  
 
! bgcolor="#a7c1f2" | Variable  
Line 116: Line 119:
 
The above can all take a parameter, to operate on a page other than the current page.  
 
The above can all take a parameter, to operate on a page other than the current page.  
  
{| width="100%" rules="all" cellspacing="4" cellpadding="3" border="2" style="margin: 1em 1em 1em 0pt; border: 1px solid rgb(170, 170, 170); border-collapse: collapse; empty-cells: show;"
+
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin: 1em 1em 1em 0pt; border: 1px solid rgb(170, 170, 170); border-collapse: collapse; empty-cells: show;" rules="all"
 
|-
 
|-
 
! bgcolor="#a7c1f2" | Variable  
 
! bgcolor="#a7c1f2" | Variable  
Line 127: Line 130:
 
|-
 
|-
 
| <nowiki>{{SERVER}}</nowiki>  
 
| <nowiki>{{SERVER}}</nowiki>  
| {{SERVER}}
+
| {{SERVER}}  
 
| Server
 
| Server
 
|-
 
|-
Line 163: Line 166:
 
|}
 
|}
  
==Parser functions==
+
== Parser functions ==
''These are documented at the {{mw|Help:Magic words|main documentation page}} unless otherwise stated.''
+
 
===Metadata===
+
''These are documented at the {{mw|Help:Magic words|main documentation page}} unless otherwise stated.''  
{|border="2" width="100%" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
+
 
 +
=== Metadata ===
 +
 
 +
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;" rules="all"
 
|-
 
|-
! bgcolor="#a7c1f2" | Parser function
+
! bgcolor="#a7c1f2" | Parser function  
 
! bgcolor="#a7c1f2" | Description
 
! bgcolor="#a7c1f2" | Description
 
|-
 
|-
|<tt><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></tt>
+
| <tt><nowiki>{{PAGESIZE:</nowiki>''page name''<nowiki>}}</nowiki></tt>  
|(size of page in bytes)
+
| (size of page in bytes)
 
|-
 
|-
|<tt><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{PROTECTIONLEVEL:</nowiki>''action''<nowiki>}}</nowiki></tt>  
|(protection level for given action on the current page)
+
| (protection level for given action on the current page)
 
|-
 
|-
|<tt><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{PAGESINCATEGORY:</nowiki>''categoryname''<nowiki>}}</nowiki></tt>  
|(number of pages in the given [[Help:Categories|category]])
+
| (number of pages in the given [[Help:Categories|category]])
 
|-
 
|-
|<tt><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{NUMBERINGROUP:</nowiki>''groupname''<nowiki>}}</nowiki></tt>  
|(number of users in a specific [[Help:User rights|group]])
+
| (number of users in a specific [[Help:User rights|group]])
 
|}
 
|}
Add <tt>|R</tt> to return numbers without commas.
 
  
===Formatting===
+
Add <tt>|R</tt> to return numbers without commas.
{|border="2" width="100%" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
+
 
 +
=== Formatting ===
 +
 
 +
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;" rules="all"
 
|-
 
|-
! bgcolor="#a7c1f2" | Parser function
+
! bgcolor="#a7c1f2" | Parser function  
 
! bgcolor="#a7c1f2" | Description
 
! bgcolor="#a7c1f2" | Description
 
|-
 
|-
|<tt><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{lc:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(convert to lower case)
+
| (convert to lower case)
 
|-
 
|-
|<tt><nowiki>{{lcfirst:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{lcfirst:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(convert first character to lower case)
+
| (convert first character to lower case)
 
|-
 
|-
|<tt><nowiki>{{uc:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{uc:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(convert to upper case)
+
| (convert to upper case)
 
|-
 
|-
|<tt><nowiki>{{ucfirst:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{ucfirst:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(convert first character to upper case)
+
| (convert first character to upper case)
 
|-
 
|-
|<tt><nowiki>{{formatnum:</nowiki>''unformatted&nbsp;num''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{formatnum:</nowiki>''unformatted&nbsp;num''<nowiki>}}</nowiki></tt>  
|(format a number with comma separators; add <tt><nowiki>|</nowiki>R</tt> to unformat a number)
+
| (format a number with comma separators; add <tt><nowiki>|</nowiki>R</tt> to unformat a number)
 
|-
 
|-
|<tt><nowiki>{{#formatdate:</nowiki>''date''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#formatdate:</nowiki>''date''<nowiki>}}</nowiki></tt>  
|(formats a date according to user preferences; a default can be given as a second parameter for users without date preference); however, please note that the community voted against the concept of date-autoformatting in the {{wpd|User:Ryan_Postlethwaite/Draft_RfC#Autoformatting|March 2009 RfC}}, and that there is considerable opposition to the use of this parser function.
+
| (formats a date according to user preferences; a default can be given as a second parameter for users without date preference); however, please note that the community voted against the concept of date-autoformatting in the {{wpd|User:Ryan_Postlethwaite/Draft_RfC#Autoformatting|March 2009 RfC}}, and that there is considerable opposition to the use of this parser function.
 
|-
 
|-
|<tt><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{padright:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{padleft:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{padright:xyz|</nowiki>''stringlength''<nowiki>}}</nowiki></tt>  
|(pad with zeros to the right or left; an alternative padding string can be given as a third parameter)
+
| (pad with zeros to the right or left; an alternative padding string can be given as a third parameter)
 
|-
 
|-
|<tt><nowiki>{{plural:</nowiki>''n''<nowiki>|</nowiki>''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{plural:</nowiki>''n''<nowiki>|</nowiki>''is''<nowiki>|</nowiki>''are''<nowiki>}}</nowiki></tt>  
|(produces alternative text according to whether ''n'' is greater than 1)
+
| (produces alternative text according to whether ''n'' is greater than 1)
 
|-
 
|-
|<tt><nowiki>{{#time: format string | date/time object }}</nowiki></tt>  
+
| <tt><nowiki>{{#time: format string | date/time object }}</nowiki></tt>  
|(for date/time formatting; also <tt>#timel</tt> for local time. Covered at the {{mw|Help:Extension:ParserFunctions|extension documentation page}}.)
+
| (for date/time formatting; also <tt>#timel</tt> for local time. Covered at the {{mw|Help:Extension:ParserFunctions|extension documentation page}}.)
 
|}
 
|}
===Paths===
+
 
{|border="2" width="100%" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
+
=== Paths ===
 +
 
 +
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;" rules="all"
 
|-
 
|-
! bgcolor="#a7c1f2" | Parser function
+
! bgcolor="#a7c1f2" | Parser function  
 
! bgcolor="#a7c1f2" | Description
 
! bgcolor="#a7c1f2" | Description
 
|-
 
|-
|<tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>|</nowiki>''query string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{localurl:</nowiki>''page name''<nowiki>|</nowiki>''query string''<nowiki>}}</nowiki></tt>  
|(relative path to the title)
+
| (relative path to the title)
 
|-
 
|-
|<tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>}}</nowiki></tt>, <tt><nowiki>{{fullurl:</nowiki>''page name''<nowiki>|</nowiki>''query_string''<nowiki>}}</nowiki></tt>  
|(absolute path to the title)
+
| (absolute path to the title)
 
|-
 
|-
|<tt><nowiki>{{filepath:</nowiki>''file name''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{filepath:</nowiki>''file name''<nowiki>}}</nowiki></tt>  
|(absolute URL to a media file)
+
| (absolute URL to a media file)
 
|-
 
|-
|<tt><nowiki>{{urlencode:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{urlencode:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(input encoded for use in URLs)
+
| (input encoded for use in URLs)
 
|-
 
|-
|<tt><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{anchorencode:</nowiki>''string''<nowiki>}}</nowiki></tt>  
|(input encoded for use in URL section anchors)
+
| (input encoded for use in URL section anchors)
 
|-
 
|-
|<tt><nowiki>{{ns:</nowiki>''n''<nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{ns:</nowiki>''n''<nowiki>}}</nowiki></tt>  
|(name for the [[Help:Namespace|namespace]] with index ''n''; use <tt><nowiki>{{nse:}}</nowiki></tt> for URL-encoded equivalent)
+
| (name for the [[Help:Namespace|namespace]] with index ''n''; use <tt><nowiki>{{nse:}}</nowiki></tt> for URL-encoded equivalent)
 
|-
 
|-
|<tt><nowiki>{{#rel2abs:</nowiki> ''path'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#rel2abs:</nowiki> ''path'' <nowiki>}}</nowiki></tt>  
|(converts a relative file path to absolute; see the {{mw|Help:Extension:ParserFunctions|extension documentation}})
+
| (converts a relative file path to absolute; see the {{mw|Help:Extension:ParserFunctions|extension documentation}})
 
|-
 
|-
|<tt><nowiki>{{#titleparts:</nowiki> ''pagename'' <nowiki>|</nowiki> ''number of segments to return'' <nowiki>|</nowiki> ''first segment to return'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#titleparts:</nowiki> ''pagename'' <nowiki>|</nowiki> ''number of segments to return'' <nowiki>|</nowiki> ''first segment to return'' <nowiki>}}</nowiki></tt>  
|(splits title into parts; see the {{mw|Help:Extension:ParserFunctions|extension documentation}})
+
| (splits title into parts; see the {{mw|Help:Extension:ParserFunctions|extension documentation}})
 
|}
 
|}
===Conditional expressions===
+
 
These are covered at the {{mw|Help:Extension:ParserFunctions|extension documentation page}}. Some parameters are optional.
+
=== Conditional expressions ===
{|border="2" width="100%" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
+
 
 +
These are covered at the {{mw|Help:Extension:ParserFunctions|extension documentation page}}. Some parameters are optional.  
 +
 
 +
{| width="100%" cellspacing="4" cellpadding="3" border="2" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;" rules="all"
 
|-
 
|-
! bgcolor="#a7c1f2" | Parser function
+
! bgcolor="#a7c1f2" | Parser function  
 
! bgcolor="#a7c1f2" | Description
 
! bgcolor="#a7c1f2" | Description
 
|-
 
|-
|<tt><nowiki>{{#expr:</nowiki> ''expression'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#expr:</nowiki> ''expression'' <nowiki>}}</nowiki></tt>  
|(evaluates the given expression; see [[Help:Calculation]])
+
| (evaluates the given expression; see [[Help:Calculation]])
 
|-
 
|-
|<tt><nowiki>{{#if:</nowiki> ''test string'' <nowiki>|</nowiki> ''value if non-empty'' <nowiki>|</nowiki> ''value if empty'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#if:</nowiki> ''test string'' <nowiki>|</nowiki> ''value if non-empty'' <nowiki>|</nowiki> ''value if empty'' <nowiki>}}</nowiki></tt>  
|(selects one of two values based on whether the test string is empty)
+
| (selects one of two values based on whether the test string is empty)
 
|-
 
|-
|<tt><nowiki>{{#ifeq:</nowiki> ''string 1'' <nowiki>|</nowiki> ''string 2'' <nowiki>|</nowiki> ''value if equal'' <nowiki>|</nowiki> ''value if unequal'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#ifeq:</nowiki> ''string 1'' <nowiki>|</nowiki> ''string 2'' <nowiki>|</nowiki> ''value if equal'' <nowiki>|</nowiki> ''value if unequal'' <nowiki>}}</nowiki></tt>  
|(selects one of two values based on whether the test strings are equal – numerically if applicable)
+
| (selects one of two values based on whether the test strings are equal – numerically if applicable)
 
|-
 
|-
|<tt><nowiki>{{#iferror:</nowiki> ''test string'' <nowiki>|</nowiki> ''value if error'' <nowiki>|</nowiki> ''value if correct'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#iferror:</nowiki> ''test string'' <nowiki>|</nowiki> ''value if error'' <nowiki>|</nowiki> ''value if correct'' <nowiki>}}</nowiki></tt>  
|(selects value based on whether the test string generates a parser error)
+
| (selects value based on whether the test string generates a parser error)
 
|-
 
|-
|<tt><nowiki>{{#ifexpr:</nowiki> ''expression'' <nowiki>|</nowiki> ''value if true'' <nowiki>|</nowiki> ''value if false'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#ifexpr:</nowiki> ''expression'' <nowiki>|</nowiki> ''value if true'' <nowiki>|</nowiki> ''value if false'' <nowiki>}}</nowiki></tt>  
|(selects value based on evaluation of expression)
+
| (selects value based on evaluation of expression)
 
|-
 
|-
|<tt><nowiki>{{#ifexist:</nowiki> ''page title'' <nowiki>|</nowiki> ''value if exists'' <nowiki>|</nowiki> ''value if doesn't exist'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#ifexist:</nowiki> ''page title'' <nowiki>|</nowiki> ''value if exists'' <nowiki>|</nowiki> ''value if doesn't exist'' <nowiki>}}</nowiki></tt>  
|(selects value depending on whether a page title exists)
+
| (selects value depending on whether a page title exists)
 
|-
 
|-
|<tt><nowiki>{{#switch:</nowiki> ''test'' <nowiki>|</nowiki> ''case1'' = ''value for case 1'' <nowiki>|</nowiki> ... <nowiki>|</nowiki> ''default'' <nowiki>}}</nowiki></tt>  
+
| <tt><nowiki>{{#switch:</nowiki> ''test'' <nowiki>|</nowiki> ''case1'' = ''value for case 1'' <nowiki>|</nowiki> ... <nowiki>|</nowiki> ''default'' <nowiki>}}</nowiki></tt>  
|(provides alternatives based on the value of the test string)
+
| (provides alternatives based on the value of the test string)
 
|}
 
|}
For the use of these functions in tables, see [[Wikipedia:Conditional tables|Conditional tables]].
 
  
==See also==
+
For the use of these functions in tables, see [[wikipedia:Conditional%20tables|Conditional tables]].
*{{mw|Internationalisation}}
+
 
*{{mw|Manual:Extending_wiki_markup|Adding parser functions}}
+
== See also ==
*[http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/CoreParserFunctions.php?view=log CoreParserFunctions.php]
+
 
* {{wpd|User:Cacycle/wikEd|wikEd}}, a MediaWiki editor with syntax highlighting for templates and parser functions
+
*{{mw|Internationalisation}}  
 +
*{{mw|Manual:Extending_wiki_markup|Adding parser functions}}  
 +
*[http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/CoreParserFunctions.php?view=log CoreParserFunctions.php]  
 +
*{{wpd|User:Cacycle/wikEd|wikEd}}, a MediaWiki editor with syntax highlighting for templates and parser functions
  
 
[[Category:Help|{{PAGENAME}}]]
 
[[Category:Help|{{PAGENAME}}]]

Revision as of 18:05, 11 April 2011

Magic words (which include parser functions, variables and behavior switches) are features of wikitext that enable various instructions to be given to the MediaWiki software (for example, to suppress or position the table of contents), or else serve to produce variable output, as is often required in templates.

A quick reference for magic words can be found on this page. For more complete and updated documentation, refer to following pages on the MediaWiki site:

Contents

General information

There are three types of magic words:

  • Behavior switches: uppercase words surrounded by double underscores, e.g. __NOTOC__, or keywords using parser function syntax
  • Variables: uppercase words surrounded by double braces, e.g. {{PAGENAME}} (thus resembling templates)
  • Parser functions: keywords (some beginning #) in double braces with parameters after a colon, e.g. {{#expr:2+2}}

Some magic words are case-insensitive, but not all. Whitespace is stripped from the start and end of keywords and parameters, as in template syntax.

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.

It is possible to substitute parser functions and variables in the same way that templates are substituted (using the subst: keyword). This causes their current value (as evaluated at the time of substitution) to be written into the wikitext.

Behavior switches

For documentation, refer to the mw:Behavior Switches section of the MediaWiki page.

Word Description
__NOTOC__ (can appear anywhere in the wikitext; suppresses the table of contents)
__FORCETOC__ (can appear anywhere in the wikitext; makes a table of contents appear in its normal position above the first header)
__TOC__ (places a table of contents at the word's position)
__NOEDITSECTION__ (hides the section edit links beside headings)
__NEWSECTIONLINK__ (adds a "+" link for adding a new section on a non-"Talk" page)
__NONEWSECTIONLINK__ (removes the "+" link on "Talk" pages)
__NOGALLERY__ (on a category page, replaces thumbnails with normal links)
__HIDDENCAT__ (on a category page, makes it a hidden category)
__INDEX__ (tells search engines to index the page)
__NOINDEX__ (tells search engines not to index the page)
{{DISPLAYTITLE:title}} (changes the displayed form of the page title)
{{DEFAULTSORT:sortkey}} (sets a default category sort key)

Variables

For documentation, refer to the mw:Variables section of the MediaWiki page.

Variable Output Description
{{FULLPAGENAME}} Help:Magic words (page title including namespace)
{{PAGENAME}} Magic words (page title excluding namespace)
{{BASEPAGENAME}} Magic words (page title excluding subpage and namespace)
{{SUBPAGENAME}} Magic words (subpage part of title)
{{SUBJECTPAGENAME}} Help:Magic words (associated non-talk page)
{{TALKPAGENAME}} Help talk:Magic words (associated talk page)
{{NAMESPACE}} Help (namespace of current page)
{{SUBJECTSPACE}}, {{ARTICLESPACE}} Help, Help (associated non-talk namespace)
{{TALKSPACE}} Help talk (associated talk namespace)
{{FULLPAGENAMEE}}, {{NAMESPACEE}} Help:Magic words, Help etc. (URL-encoded equivalents)

The above can all take a parameter, to operate on a page other than the current page.

Variable Output Description
{{SITENAME}} FamilySearch Wiki Site name
{{SERVER}} https://familysearch.org Server
{{SERVERNAME}} familysearch.org Server name
{{SCRIPTPATH}} /learn/wiki/en Script path
{{CURRENTVERSION}} 1.17.1 (current MediaWiki version)
{{REVISIONID}} 603324 (latest revision to current page)
{{REVISIONDAY}}, {{REVISIONDAY2}}, {{REVISIONMONTH}}, {{REVISIONYEAR}}, {{REVISIONTIMESTAMP}}, {{REVISIONUSER}} 11, 11, 04, 2011, 20110411180557, Jamestanner (date, time, editor at last edit)
{{CURRENTYEAR}}, {{CURRENTMONTH}}, {{CURRENTMONTHNAME}}, {{CURRENTMONTHABBREV}}, {{CURRENTDAY}}, {{CURRENTDAY2}}, {{CURRENTDOW}}, {{CURRENTDAYNAME}}, {{CURRENTTIME}}, {{CURRENTHOUR}}, {{CURRENTWEEK}}, {{CURRENTTIMESTAMP}} 2015, 04, April, Apr, 1, 01, 3, Wednesday, 09:51, 09, 14, 20150401095131 (current date/time variables)
{{LOCALYEAR}} 2015 etc. (as above, based on site's local time)
{{NUMBEROFPAGES}}, {{NUMBEROFARTICLES}}, {{NUMBEROFFILES}}, {{NUMBEROFEDITS}}, {{NUMBEROFVIEWS}}, {{NUMBEROFUSERS}}, {{NUMBEROFADMINS}}, {{NUMBEROFACTIVEUSERS}} 196,010, 81,400, 34,568, 2,127,057, 585,209,140, 150,561, 53, 421 (statistics on FamilySearch Wiki; add :R to return numbers without commas)

Parser functions

These are documented at the mw:main documentation page unless otherwise stated.

Metadata

Parser function Description
{{PAGESIZE:page name}} (size of page in bytes)
{{PROTECTIONLEVEL:action}} (protection level for given action on the current page)
{{PAGESINCATEGORY:categoryname}} (number of pages in the given category)
{{NUMBERINGROUP:groupname}} (number of users in a specific group)

Add |R to return numbers without commas.

Formatting

Parser function Description
{{lc:string}} (convert to lower case)
{{lcfirst:string}} (convert first character to lower case)
{{uc:string}} (convert to upper case)
{{ucfirst:string}} (convert first character to upper case)
{{formatnum:unformatted num}} (format a number with comma separators; add |R to unformat a number)
{{#formatdate:date}} (formats a date according to user preferences; a default can be given as a second parameter for users without date preference); however, please note that the community voted against the concept of date-autoformatting in the March 2009 RfC, and that there is considerable opposition to the use of this parser function.
{{padleft:xyz|stringlength}}, {{padright:xyz|stringlength}} (pad with zeros to the right or left; an alternative padding string can be given as a third parameter)
{{plural:n|is|are}} (produces alternative text according to whether n is greater than 1)
{{#time: format string | date/time object }} (for date/time formatting; also #timel for local time. Covered at the mw:extension documentation page.)

Paths

Parser function Description
{{localurl:page name}}, {{localurl:page name|query string}} (relative path to the title)
{{fullurl:page name}}, {{fullurl:page name|query_string}} (absolute path to the title)
{{filepath:file name}} (absolute URL to a media file)
{{urlencode:string}} (input encoded for use in URLs)
{{anchorencode:string}} (input encoded for use in URL section anchors)
{{ns:n}} (name for the namespace with index n; use {{nse:}} for URL-encoded equivalent)
{{#rel2abs: path }} (converts a relative file path to absolute; see the mw:extension documentation)
{{#titleparts: pagename | number of segments to return | first segment to return }} (splits title into parts; see the mw:extension documentation)

Conditional expressions

These are covered at the mw:extension documentation page. Some parameters are optional.

Parser function Description
{{#expr: expression }} (evaluates the given expression; see Help:Calculation)
{{#if: test string | value if non-empty | value if empty }} (selects one of two values based on whether the test string is empty)
{{#ifeq: string 1 | string 2 | value if equal | value if unequal }} (selects one of two values based on whether the test strings are equal – numerically if applicable)
{{#iferror: test string | value if error | value if correct }} (selects value based on whether the test string generates a parser error)
{{#ifexpr: expression | value if true | value if false }} (selects value based on evaluation of expression)
{{#ifexist: page title | value if exists | value if doesn't exist }} (selects value depending on whether a page title exists)
{{#switch: test | case1 = value for case 1 | ... | default }} (provides alternatives based on the value of the test string)

For the use of these functions in tables, see Conditional tables.

See also