Template:ParserFunction

Template documentation[view] [edit] [history] [purge]

{{pf}}

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

Usage

{{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 parameter}}, 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}}

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
`{{Tj\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`{{Tji\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`<syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{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
`{{mfl\|Example\|hello}}`	{{#invoke:Example\|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|hello}}`	Counterpart to {{tlx}} for linking to Lua modules
`{{ml-lua\|Module:Example}}`	`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\|LASTING}}`	`[[WP:LASTING]]`	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
`{{dtl\|Ping project}}`	{{d:Ping project}}	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl}}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

The above documentation is transcluded from Template:ParserFunction/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Code example	Effect	Notes
`{{Tj\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`{{Tji\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`<syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{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
`{{mfl\|Example\|hello}}`	{{#invoke:Example\|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|hello}}`	Counterpart to {{tlx}} for linking to Lua modules
`{{ml-lua\|Module:Example}}`	`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\|LASTING}}`	`[[WP:LASTING]]`	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
`{{dtl\|Ping project}}`	{{d:Ping project}}	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl}}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

Usage

See also

Other formatting templates