Template:Para/doc

Not to be confused with Template:Paragraph break or Template:Param.

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 This page is being depreciated).

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 This page is being depreciated and/or {{var|value}} (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., {{para|section}} → |section=
• |2= or second unnamed parameter – the value name; e.g., {{para|section|about}} → |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., {{para||section}} → |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 (green monospaced text) that would be applied by This page is being depreciated. Since {{para}} contains This page is being depreciated markup inside its source which would override the color of {{mxt}}, these parameters can be used when {{para}} is used for text inside a passage of {{mxt}} 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 This page is being depreciated, the “bad monospaced example text" 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 This page is being depreciated 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

See a monthly parameter usage report for Template:Para in articles based on its TemplateData.

TemplateData for Para

Gives examples of template parameter source code

Template parameters

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:

• This page is being depreciated, for markup of examples of parameter names as they would appear in MediaWiki source code of templates, e.g. {{param|foo}} gives: {{{foo}}}
• This page is being depreciated, for markup of examples of parameter names as they would appear in the {{tj}} and {{tji}} templates.
• This page is being depreciated, for markup of examples of HTML elements' attributes and values; e.g. {{tag|a|attribs=href=/demo.php|o}} gives: This page is being depreciated

General-purpose formatting

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

Text style ↓	This page is being depreciated options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
This page is being depreciated options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	This page is being depreciated {{subst:Template:tlsu}}	{{subst:tlsf}} <template link>	{{tn}}	{{tla}}
code	code=yes	{{tl2}} This page is being depreciated {{Template:tlxu}}	This page is being depreciated <template link> {{tnull}}<template link>	This page is being depreciated	{{subst:tlsc}} <template link>	—
monospace	plaincode=yes	—		This page is being depreciated	—
kbd	kbd=yes
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	This page is being depreciated

Other formatting templates

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

Code example	Effect	Notes
This page is being depreciated	{{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
This page is being depreciated	{{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
This page is being depreciated	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
This page is being depreciated	{{hatnote|Some text}} Some text	Shows code and example
This page is being depreciated	Template:Hatnote	Produces a normal link to the template
This page is being depreciated This page is being depreciated	[[Template:Example]] [[Template:Example|Text]]suffix	Shows how wikilink would be entered in wiki markup, with optional link text and suffix
This page is being depreciated	{{#invoke:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
This page is being depreciated	{{#invoke:Example|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
This page is being depreciated	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
This page is being depreciated	require('Module:Example')	Link to Lua modules and built-in libraries, showing Lua code.
This page is being depreciated	title=book title	Formats template parameters for display, with or without values
This page is being depreciated	[[WP:LASTING]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a This page is being depreciated tag.
This page is being depreciated This page is being depreciated	This page is being depreciated <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
This page is being depreciated	{{d:Ping project}}	Wikidata counterpart to {{tl}}
This page is being depreciated This page is being depreciated	{{#if}} {{#if:{{{1}}}|true|false}}	Magic word links
This page is being depreciated This page is being depreciated	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
This page is being depreciated	{{uc:}}	Magic word links

With utility links

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

Code example	Effect
This page is being depreciated	Template:Hatnote (edit | talk | history | links | watch | logs)
This page is being depreciated	Template:Hatnote(edit talk links history)
This page is being depreciated	{{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
This page is being depreciated	Template:Hatnote (talk · history · transclusions · logs · subpages)
This page is being depreciated	{{Hatnote}} links talk edit
This page is being depreciated	{{subst:Hatnote}}  links talk edit
This page is being depreciated	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
This page is being depreciated	This page is being depreciated
This page is being depreciated	m:Template:Hatnote (backlinks edit)
This page is being depreciated	Template:Hatnote (backlinks edit)
This page is being depreciated	{{Hatnote}} (talk)
This page is being depreciated	Template:Hatnote (links, talk)
This page is being depreciated	Template:Hatnote (links, talk)