Jump to content

Help:Parser function

Add links
From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Ruslik0 (talk | contribs) at 20:16, 11 February 2009 (see also). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Template:H:h

This redirect is about parser functions in general. For the MediaWiki extension ParserFunctions, see Help:ParserFunctions.

A parser function is a template-like construct which returns a value based on at least one unnamed parameter, separated from the function name by a colon ":"; there may be more parameters which, like those of ordinary templates, are each preceded by "|". Parser functions differ by a leading hash character (#):

  1. {{functionname: argument 1 | argument 2 | argument 3...}}
    • Core parser functions (standardly built into MediaWiki); this is for backwards compatibility
    • Optionally for parser function extensions
  2. {{#functionname: argument 1 | argument 2 | argument 3...}}
    • By default for parser function extensions, e.g. ParserFunctions extension, to prevent collision with namespaces and interwiki prefixes

The distinction with variables is that the latter do not have any arguments which are separated by a colon.

For each language there is a file like MessagesEn.php specifying for each variable and parser function whether the name is case-sensitive.

Usually variables are case-sensitive and parser functions are not. To some variables ":R" can be added ("raw" modifier), but, although now a parser function, the name is still case-insensitive. Exceptions are the function names DISPLAYTITLE:, PAGESINNAMESPACE:, PAGESINNS:, and DEFAULTSORT: that are case-sensitive and the variable name CURRENTTIME that is case-insensitive.

MediaWiki's core parser functions are listed below and in Help:Magic words .

Formatting

LC

Makes a text lowercase and removes newlines and spaces from the start and end.

{{lc: AbC dEf }} gives "abc def".
{{lc: Ä Β Ç }} gives ä β ç, expected ä β ç.

UC

Makes a text uppercase and removes newlines and spaces from the start and end.

{{uc: AbCdEf }} gives "ABCDEF".
{{uc:ä β ß}} gives Ä Β SS, expected: Ä Β SS. Don't expect too much.

LCFIRST

Makes the first character lowercase and removes newlines and spaces from the start and end: {{lcfirst: Ab Cd }} gives "ab Cd".

UCFIRST

Makes the first character uppercase and removes newlines and spaces from the start and end: {{ucfirst: aB cD }} gives "AB cD".

URLENCODE

Removes newlines and spaces from the start and end, and converts the remaining text into URL-friendly format by replacing spaces with "+" and other url formatting characters with their escaped equivalents: {{urlencode:hello world ?&=#/:}} gives hello+world+%3F%26%3D%23%2F%3A.

NB: For anchors within a page use {{anchorencode}}

ANCHORENCODE

For anchors within a page use {{anchorencode}} instead of {{urlencode}}. The results of a call to {{anchorencode}} are compatible with intra-page references generated for [[#link]]s, while {{urlencode}}-generated values are not necessarily so.

Note that (contrary to urlencode) the encoding made by "anchorencode", which uses the dot charactor as a prefix before a byte repesented in hexadecimal, is not fully reversible. "anchorencode" is then NOT suitable for passing query parameters. However the encoding made by "urlencode" (which uses "%" characters) is not compatible with the more restricted character sets allowed in HTML and XML for ids. tHe two encodings also differ in the way they encode the space.

Compare:

  • #{{anchorencode:Langue française}} return: "#Langue_française" (valid only for anchors to sections in MediaWiki pages), when
  • {{urlencode:Langue française}} returns: "Langue+fran%C3%A7aise" (for paths or query parameters in URLs, excluding anchors)

The encoding made by anchorencode is suitable to give anchor names within pages made with MdiaWiki.

It is not guaranteed to work with other web sites: if you need to specify an anchor in a page not hosted on a server running MediaWiki, the anchor is not warrantied to work as expected. So, use "anchorencode" only for targetting a MediaWiki web site, such as those from the Xikimedia Foundation projects.

NS

Gives the namespace name for a given namespace number or name:

Code
with Number		 Code
with Name		 Returns
with Number		 Returns
with Name
{{ns:-2}} {{ns:media}} Media Media
{{ns:-1}} {{ns:special}} Special Special
{{ns:0}} (not applicable) (not applicable)
{{ns:1}} {{ns:talk}} Talk Talk
{{ns:2}} {{ns:user}} User User
{{ns:3}} {{ns:user_talk}} User talk User talk
{{ns:4}} {{ns:project}} Wikipedia Wikipedia
{{ns:5}} {{ns:project_talk}} Wikipedia talk Wikipedia talk
{{ns:6}} {{ns:image}} File File
{{ns:7}} {{ns:image_talk}} File talk File talk
{{ns:8}} {{ns:mediawiki}} MediaWiki MediaWiki
{{ns:9}} {{ns:mediawiki_talk}} MediaWiki talk MediaWiki talk
{{ns:10}} {{ns:template}} Template Template
{{ns:11}} {{ns:template_talk}} Template talk Template talk
{{ns:12}} {{ns:help}} Help Help
{{ns:13}} {{ns:help_talk}} Help talk Help talk
{{ns:14}} {{ns:category}} Category Category
{{ns:15}} {{ns:category_talk}} Category talk Category talk
Namespaces 100 and higher are customized by each site
{{ns:100}} {{ns:hilfe}} Portal Template:Ns:Hilfe
{{ns:101}} {{ns:hilfe_diskussion}} Portal talk Template:Ns:Hilfe Diskussion

Template:Xpdoocc.

Template:Xpdoocc.

Template:Xpdoocc.

"{{ns:{{ns:8}} talk}}" gives "MediaWiki talk" [1].

Template:Xpdoocc.

See Help:Variable for more canonical names like "project" and "talk".

NS:1

Template:Xpdoocc, just as Template:Xpd. The canonical name for the talk namespace of articles is "talk" and not "_talk". Appending "_talk" to the namespace name works for all but the main namespace.

The following constructs work:

ns:0 gives null string

Template:Xpd, an empty string. This is often handy, and less vulnerable to vandalism by a compromised administrator account than a template void or similar.

The cryptic magic word __END__ is no longer supported. It formerly allowed for trailing whitespace to be included in the page save, but was removed in revision 19213.

In constructs like {{ {{#if: {{{T|}}} | {{{T}}} | ns:0}} }}, where parameter T is normally the name of a template to be evaluated, but can be undefined or empty, {{ns:0}} is then a clean empty string. Without it {{}} would result in {{}}.

"{{ {{#if: {{{T|}}} | {{{T}}} | ns:0}} }}" gives "" [3].

Template:Xpdoocc, because NS cannot handle an empty {{ns:0}} argument.

Empty or invisible section headers.

The wikitext line 

=== {{ns:0}} ===

creates an entry in the TOC coded in the output HTML as 

<li class="toclevel-2"><a href="#"><span class="tocnumber">2.4</span> </a></li>

attempting but failing to link to the null anchor 

<p><a name=""></a></p>

and with an edit link similar to this: 

[<a href="/w/index.php?title=Help:Parser_function&amp;action=edit&amp;section=12">edit</a>]

The next line is === {{ns:0}} ===. Note the edit link to the right.

An empty section title (with an edit link to the right) as above is obtained using, in this case, === {{ns:0}} ===. This is dubious, but arguably better than using the same trick to get invisble section headers twice on a page. At least /* {{ns:0}} */ makes sense in the edit history, if there's only one section using this particular trick.

As shown in the table of contents this and similar tricks result in non-functional links. In conjunction with __NOTOC__ it's less harmful, and maybe useful to get edit links for invisible sections with categories and interlanguage links. Other possibilities for different invisible section headers:

  1. === __NOTOC__ ===
  2. === ===
  3. === &nbsp; ===
  4. === &#160; ===

URLs etc.

{{localurl:fullpagename}} /wiki/Fullpagename
{{localurl:page|query=x}} /w/index.php?title=Page&query=x
{{localurl:a&b! c}}
{{localurle:a&b! c}} 		/wiki/A%26b!_c
/wiki/A%26b!_c
{{urlencode:a&b! c}} a%26b%21+c
{{anchorencode:a&b! c}} a&b!_c
{{fullurl:fullpagename}} //en.wikipedia.org/wiki/Fullpagename
{{fullurl:ab}} //en.wikipedia.org/wiki/Ab
{{fullurl:a b}} //en.wikipedia.org/wiki/A_b
{{fullurl:ab|u=v}} //en.wikipedia.org/w/index.php?title=Ab&u=v
{{fullurl:m:a b|u=v}} https://meta.wikimedia.org/wiki/a_b?u=v
{{fullurl:m:ab|u=v}} https://meta.wikimedia.org/wiki/ab?u=v
{{fullurl:a b|u=v}} //en.wikipedia.org/w/index.php?title=A_b&u=v
{{fullurl:a b|u=v w}} //en.wikipedia.org/w/index.php?title=A_b&u=v w
{{fullurl:a&b!|u=v}}   //en.wikipedia.org/w/index.php?title=A%26b!&u=v
{{fullurle:a&b!|u=v}}  //en.wikipedia.org/w/index.php?title=A%26b!&u=v

Note that with the interwiki prefix the format "wiki/" is used even for edit pages etc., while it does not write the page name in canonical form.

For interwiki links localurl and fullurl give the same:

{{localurl:w:a}}
{{fullurl:w:a}} 		/wiki/A
//en.wikipedia.org/wiki/A

The parser function localurl: replaces spaces by underscores and special characters by escape codes, e.g. {{localurl:a !}} gives /wiki/A_!. The main purpose was to create a link to a given page in external link style in the same project or a project which uses the same string in the URL between the server name and the page name. This function is now better served by less verbose fullurl: constructs, {{fullurl:page}} is a shorthand for {{SERVER}}{{localurl:page}}.

Both fullurle: and localurle: performed additional character escaping on the resulting link, but no example is known where that still has any additional effect.

Note that fullurl: and localurl: don't encode special characters and spaces in the optional query-string parameter. At least for spaces this will result in broken URLs:
{{fullurl:m:Special:Contributions|target=Jimbo Wales&limit=10}}
https://meta.wikimedia.org/wiki/Special:Contributions?target=Jimbo Wales&limit=10

With target={{urlencode:Jimbo Wales}}&limit=10 as query-string it works:
https://meta.wikimedia.org/wiki/Special:Contributions?target=Jimbo+Wales&limit=10

The new urlencode: encodes spaces as "+", not "_" or the generally supported "%20", this might have interesting effects, take care. Leading and trailing spaces are stripped, but all internal spaces are preserved: {{urlencode:  @  !  }} yields %40++%21.

For obvious reasons encoding "}}" or "|" cannot work directly. Don't encode "=", "&", or ";" in structured query-strings unless you really want it.

Example

Say you want to create a link in a template to the block log for blocked usernames -> "{{fullurl:Special:Log/block|user=User:{{{1}}} }}". This won't work with spaces in the name like "Example blocked user" (unless they are manually underlined) as you'd get: "//en.wikipedia.org/w/index.php?title=Special:Log/block&user=User:Example blocked user", so what you can do is escape it with: "{{fullurl:Special:Log/block|user=User:{{urlencode:{{{1}}}}} }}", giving you "//en.wikipedia.org/w/index.php?title=Special:Log/block&user=User:Example+blocked+user".

See also: bugzilla:5720

Also, the magic words for page name like {{PAGENAME}} {{FULLPAGENAME}} etc all have 'escaped' versions: {{PAGENAMEE}} {{FULLPAGENAMEE}} etc.

#language:

{{#language:code}} gives the local language name of selected RFC 3066 language codes, otherwise it returns the input value as is. For a complete list see the IANA registry.

{{#language:da}} gives dansk
{{#language:fo}} gives føroyskt
{{#language:zh}} gives 中文
{{#language:zh-min-nan}} gives 閩南語 / Bân-lâm-gú
{{#language:ang}} gives Ænglisc
{{#language:tlh}} gives tlh (missing, incomplete list)
{{#language:frr}} gives Nordfriisk (missing, introduced 2006)
{{#language:mw}} gives mw (no language code as of 2006)

This function will replace m:Template:n local (backlinks edit) and some of the Special:Prefixindex/Template:Lang name - templates. For actually supported alpha2 and alpha3 codes see m:Template:sttnw (backlinks edit), the 27*26*26 template calls may take some time.

Pages in category

Word Example Example results Explanation
{{PAGESINCATEGORY:category}}
{{PAGESINCATEGORY:category|R}} 		{{PAGESINCATEGORY:User en}}
{{PAGESINCATEGORY:User en|R}} 		5,994
5994 		[MW1.13+] Returns the number of pages in a given category. Including sub-category pages and file description pages.
{{PAGESINCAT:category}}
{{PAGESINCAT:category|R}} 		{{PAGESINCAT:User en}}
{{PAGESINCAT:User en|R}} 		5,994
5994 		[MW1.13+] Alias of PAGESINCATEGORY.

Use of result

The result, like that of a variable or template, and like a template parameter value, can be used in the following ways: 

*the name of a template: {{ {{lc:ABC}}}}
*the name of a variable: {{ {{uc:currenttime}}}}
*the name of a parser function: {{ {{uc:lc}}:ABC}}
*the name of a template parameter: {{t2|{{#expr:3-1}}=a}}
*the value of a template parameter: {{t2|{{#expr:3-1}}}}
*a template parameter default value: {{{1|{{#expr:7-2}}}}}
*the name of a switch parameter: {{#switch:2|{{#expr:3-1}}=a}}
*the value of a parser function parameter: {{#ifeq:{{lc:AbC}}|abc|yes}}
*the target or label of an internal link: [[{{lc:ABc}}|{{uc:ABc}}]]
*the target or label of an external link: [http://{{lc:ABc}} {{uc:ABc}}]

gives:

  • the name of a template:
    • the name of a variable: 02:10
    • the name of a parser function: abc
    • the name of a template parameter: [[w:List of people by name: {{{1}}}a|{{{1}}}a]]
    • the value of a template parameter: [[w:List of people by name: 2{{{2}}}|2{{{2}}}]]
    • a template parameter default value: 5
    • the name of a switch parameter: a
    • the value of a parser function parameter: yes
    • the target or label of an internal link: ABC
    • the target or label of an external link: ABC

    No longer possible with the new preprocessor: 

    *a template parameter definition ( ''name'' = ''value'' ): {{pab|{{lc:AB=CD}}}}
*a switch parameter definition ( ''name'' = ''value'' ): {{#switch:ab|{{lc:AB=CD}}}}

    gives:

    • a template parameter definition ( name = value ): Template:Pab
    • a switch parameter definition ( name = value ): ab=cd

    The result cannot be used inside XML-style extension tags:

    • <math>{{#expr:3-1}} \over 3 </math> gives Failed to parse (syntax error): {\displaystyle {{#expr:3-1}} \over 3 }

    Expansion

    The first step in expanding any wikitext is identifying the templates, parser functions, variables and parameters from the braces, pipes and semicolons. For a parser function the next step is expanding the wikitext for the name of the parser function.

    Suppose for example that it is #ifexpr. Then the next step is expanding the condition. Based on that either the wikitext for the then-part or that for the else-part is expanded.

    This is illustrated with {{#ifexpr:1|{{ta}}|{{tb}}}} {{#ifexpr:0|{{tc}}|{{td}}}} giving Template:Ta
    −
    This is a test
    		+
    This was a test!
    . A page with this wikitext transcludes ta and td only (with the old preprocessor also tb and tc).


    Interpretation of a parser function as a template

    In some cases a "wrong" parser function call is interpreted as a template call, which results in an entry in the templatelinks table, giving an entry in the list of pages included in a page (on the edit box of the source page) and What links here of the target page.

    This applies e.g. for localurl and fullurl if the parameter is not a valid page name, while "Template:localurl:" and "Template:fullurl:" followed by the parameter is. This is the case if the parameter is a namespace prefix followed by a colon, e.g.:

    This entry in the templatelinks table occurs even if the result produced is not rendered due to a conditional parser function. This may occur in practice using e.g.:

    • {{ #if:{{{1|}}}|..{{ fullurl:Template:{{{1|}}} }}..}}
    • {{ #if:{{{1}}}|..{{ fullurl:Template:{{{1}}} }}..}} in the case that the parameter is equal to the empty string; it does not occur if the parameter is undefined, because "Template:fullurl:Template:{{{1}}}" is not a valid page name.

    Thus the list of templates transcluded in a page may be polluted with the entries of the non-existing template Template:fullurl:Template: and similarly for other namespace names instead of the second "Template", and for "localurl" instead of "fullurl". A remedy is e.g.:

    • {{ #if:{{{1|}}}|..{{ fullurl:Template:{{#if:{{{1}}}|{{{1}}}|[]}} }}..}} because "Template:fullurl:Template:[]" is not a valid page name.

    See also Template:Mlm.

    Substitution

    See also: Help:Substitution.

    Applying "subst:" to a parser function works:

    {{subst:LC:AbC}} gives abc.

    Note that substituting a template which uses a parser function does not replace that parser function with its result. For full recursive substitution use Special:ExpandTemplates.

    Terminology and history

    Core parser functions were originally collectively unnamed in the MediaWiki codebase, although they were informally referred to simply as "functions" by developers. At some time around February 2006, editors of this documentation labelled them "colon functions", an unusual term which was unknown to the developers and the majority of users. In April 2006, the ParserFunctions extension was introduced, along with a new extension interface allowing efficient addition of arbitrary numbers of these entities, now labelled "parser functions". The syntax for the new parser functions was modelled on that of the old core parser functions, the main difference being the addition of the leading hash "#".

    In July 2006, the parser function interface was extended to allow old-style hashless functions, and the old core parser functions were converted from using special-case code to the new parser function interface. They were moved to a CoreParserFunctions module. Thus today, there is no difference at all in syntax or functionality between core parser functions and extension parser functions, besides the leading hash convention.

    Despite this, some users are in the habit of reserving the term "parser function" for members of the ParserFunctions extension. This is confusing and inaccurate -- any extension may define a parser function. The parser function interface has diverse applications. Perhaps it was confusing to call the extension ParserFunctions in the first place, but it was imagined as a fairly general repository of parser functions useful to Wikimedia.

    See also

    Template:H:f

Retrieved from "https://en.wikipedia.org/w/index.php?title=Help:Parser_function&oldid=270067690"