Template:ParserFunction/doc

{{Pf}} is used to conveniently link to a ParserFunction, along the lines of {{tl}}. Pf stands for ParserFunction.

Usage[edit]

{{ParserFunction|parser function}}, this creates a direct link to the relevant function, omit # and colon, e.g. use {{ParserFunction|ifexpr}} to get {{#ifexpr}}.

{{ParserFunction|parser function|1st parameter|2nd parameter|3rd parameter|4th parametr}}, this creates a link with parameters include, e.g. use {{ParserFunction|ifexpr|1+1>1|true|false}} to get {{#ifexpr:1+1>1|true|false}}. For parameters with equals signs, use {{ParserFunction|1=parser function|2=1st parameter|3=2nd parameter|4=3rd parameter|5=4th parametr}}, e.g. use {{ParserFunction|1=ifexpr|2=1+1=1|3=1+1=1|4=1+1!=1}} to get {{#ifexpr:1+1=1|1+1=1|1+1!=1}}.

Use |_code=yes to wrap the output in <code>...</code> tags, e.g. {{ParserFunction|ifexpr|1+1>1|true|false|_code=yes}}produces {{#ifexpr:1+1>1|true|false}}.

Input Output
{{ParserFunction|expr}} {{#expr}}
{{ParserFunction|if}} {{#if}}
{{ParserFunction|ifeq}} {{#ifeq}}
{{ParserFunction|iferror}} {{#iferror}}
{{ParserFunction|ifexpr}} {{#ifexpr}}
{{ParserFunction|ifexist}} {{#ifexist}}
{{ParserFunction|rel2abs}} {{#rel2abs}}
{{ParserFunction|switch}} {{#switch}}
{{ParserFunction|time}} {{#time}}
{{ParserFunction|titleparts}} {{#titleparts}}
{{ParserFunction|lc}} {{lc}}
{{ParserFunction|uc}} {{uc}}
{{ParserFunction|lcfirst}} {{lcfirst}}
{{ParserFunction|ucfirst}} {{ucfirst}}
{{ParserFunction|urlencode}} {{urlencode}}
{{ParserFunction|anchorencode}} {{anchorencode}}
{{ParserFunction|ns}} {{ns}}
{{ParserFunction|localurl}} {{localurl}}
{{ParserFunction|localurle}} {{localurle}}
{{ParserFunction|fullurl}} {{fullurl}}
{{ParserFunction|fullurle}} {{fullurle}}
{{ParserFunction|language}} {{#language}}
{{ParserFunction|pagesincategory}} {{pagesincategory}}
{{ParserFunction|pagesincat}} {{pagesincat}}
{{ParserFunction|section}} {{#section}}
{{ParserFunction|section-x}} {{#section-x}}
{{ParserFunction|section-h}} {{#section-h}}
{{ParserFunction|lst}} {{#lst}}
{{ParserFunction|lstx}} {{#lstx}}
{{ParserFunction|lsth}} {{#lsth}}

See also[edit]

Other formatting templates[edit]

General-purpose formatting[edit]

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
{{tlg}} options[note 1]
to achieve link style
DEFAULT nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{tlsf}}[note 2]
<template link>
{{tn}} {{tla}}
code code=yes {{tl2}}


{{tlx}}
{{Template:tlxu}}[note 3]

{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}} {{subst:tlsc}}[note 2]
<template link>
monospace plaincode=yes[note 4] {{subst:tltss}}[note 5]
kbd kbd=yes[note 5]
bold bold=yes {{tlb}}
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 2.3 2.4 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates[edit]

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}} require('Module:Example') Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}} title=book title Formats template parameters for display, with or without values
{{sclx|Cleanup}} [[BTW:CLEANUP]] Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
‎<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links[edit]

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote (Edit Discussion links Page history)
{{tfd links|Hatnote}} Template:Hatnote (talk · history · transclusions · logs · subpages)
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)