Template:Parameter

|

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

Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code).

It must have at least one or two parameters itself. The first parameter is the name of the example parameter to display (this may be empty, but it must be present). The second (optional) parameter is a value for the first example parameter; or, if the first parameter is empty, the second illustrates an example unnamed parameter (which in some cases may serve as a pre-defined parameter that takes no |=value after it, e.g. the |section in Template:Tlx).

Examples

Code	Result	Notes
{{para|name}}	|name=
{{para|title|The Oxford English Dictionary}}	|title=The Oxford English Dictionary
{{para||section}}	|section	For unnamed parameters; note empty first parameter in the code
{{para|{{var|parameter}}|{{var|value}}}}	|parameter=value

When using literal, pre-specified parameter names and values, simply provide them (as in the first through third examples above). When illustrating hypothetical/example parameter names, or variable or user-definable values, use something like Template:Tlx and/or Template:Tnull (as in the last example above).

Parameters

• |1= or first unnamed parameter – the parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter (which, depending on the context, may serve as a valueless parameter name); e.g., Template:Tnull → |section=
• |2= or second unnamed parameter – the value name; e.g., Template:Tnull → |section=about.
  • When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), and only the parameter is shown with no equal’s sign; e.g., Template:Tnull → |section
• |plain=y (or any other value besides y) – removes the faint border and light-grey background, which may be useful in various situations. The border and text color are set to inherit, to use the colors of the surrounding text. This parameter cooperates with the two below, in that if either are used, the text will be colorized while the border and background will still be removed.
• |mxt=y or |green=y – to apply the style (Template:Mxt) that would be applied by Template:Tlx. Since Template:Tnull contains <code> markup inside its source which would override the color of Template:Tnull, these parameters can be used when Template:Tnull is used for text inside a passage of Template:Tnull content. This parameter cooperates with |plain= in applying the color but respecting the removal of border and background.
• |!mxt=y or |red=y – same as above, but applies the red of Template:Tlx, the “Template:!mxt" template.
• |style= – to apply arbitrary CSS style, for some specialized contextual purpose. Example: |style=background-color: Yellow;. Any color, background-color, or border specified here will override those provided by any of the above parameters, regardless of the order in which the parameters are given in the template. As this template uses a <span> element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output.
  • B To specifically style the parameter name and/or the value:
    e.g., {{para|page|{{var|'''single''' page number}}}}, {{para|page'''''<u>s</u>'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}}
    gives: |page=single page number, |pages=page range, or multiple individual pages, or both

TemplateData

Template:Template parameter usage

TemplateData for Parameter

Gives examples of template parameter source code

Template parameters[Edit template data]

Parameter		Description	Type	Status
Parameter name	1	The parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter.	String	suggested
Value name	2	The value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name).	String	suggested
Plain	plain	Removes the faint border and light-grey background. Default y	Boolean	optional
Green text	mxt green	Colors the text in green. Default y	Boolean	optional
Red text	!mxt red	Colors the text in red. Default y	Boolean	optional
Style	style	Apply arbitrary CSS style, for some specialized contextual purpose. Example background-color: Yellow;	Content	optional

See also

The three tables below describe the family of approximately forty templates built for talking about templates.

There are also some related templates or subjects not found in those tables:

• Template:Tlx, for markup of examples of parameter names as they would appear in MediaWiki source code of templates, e.g. Template:Tnull gives: Template:Param
• Template:Tlx, for markup of examples of HTML elements' attributes and values; e.g. Template:Tlx gives: <a href=/demo.php>

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	optionsTemplate:NoteTag to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
optionsTemplate:NoteTag to achieve link style	—Template:Screen reader-only	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	Template:TlgTemplate:NoteTag Template:Tl Template:TlpTemplate:NoteTag Template:TluTemplate:NoteTag	Template:TlfTemplate:NoteTag <template link>	Template:Tls Template:TlsuTemplate:NoteTag	Template:TlsfTemplate:NoteTag <template link>	Template:Tn	Template:Tla
code	code=yes	Template:Tl2 Template:TlxuTemplate:NoteTag	Template:TlcTemplate:NoteTag <template link> Template:Tnull<template link>	Template:Tlxs	Template:TlscTemplate:NoteTag <template link>	—Template:Screen reader-only
monospace	plaincode=yesTemplate:NoteTag	—Template:Screen reader-only		Template:TltssTemplate:NoteTag	—Template:Screen reader-only
kbd	kbd=yesTemplate:NoteTag
bold	bold=yes	Template:Tlb	—Template:Screen reader-only
bold+code	bold=yes|code=yes	Template:Tlxb
italic+code	italic=yes|code=yes	Template:Tlxi

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
<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
<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
Template:Tlx	Template:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
Template:Tlx	{{hatnote|Some text}} Some text	Shows code and example
Template:Tlx	Template:Tln	Produces a normal link to the template
Template:Tlx Template:Tlx	Template:Elc Template:Elc	Shows how wikilink would be entered in wiki markup, with optional link text and suffix
Template:Tlx	Template:Ml	Counterpart to Template:Tl for linking to Lua modules
Template:Tlx	Template:Mlx	Counterpart to Template:Tl for linking to Lua modules
Template:Tlx	Template:Ml-lua	Link to Lua modules and built-in libraries, showing Lua code.
Template:Tlx	|title=book title	Formats template parameters for display, with or without values
Template:Tlx	Template:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
Template:Tlx Template:Tlx	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
Template:Tlx	Template:Dtl	Wikidata counterpart to Template:Tl
Template:Tlx Template:Tlx	Template:Mwl Template:Mwl	Magic word links
Template:Tlx Template:Tlx	Template:Pf Template:Pf	Parser function equivalent to Template:Tl

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
Template:Tlx	Template:Lt
Template:Tlx	Template:Lts
Template:Tlx	{{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
Template:Tlx
Template:Tlx	{{Hatnote}} links talk edit
Template:Tlx	{{subst:Hatnote}}  links talk edit
Template:Tlx	Template:Ti
Template:Tlx	Template:Tic
Template:Tlx	Template:Tiw
Template:Tlx	Template:Tlt
Template:Tlx	Template:Hatnote (links, talk)
Template:Tlx	Template:Twlh

The above documentation is transcluded from Template:Parameter/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.