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 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), and the second (optional) parameter is a value for the first example parameter or, if the first {{para}} parameter is empty, an unnamed example parameter.

Examples

Code	Result	Notes
{{para|name}}	|name=
{{para|title|<var>book title</var>}}	|title=book title
{{para| |section}}	|section	For unnamed parameters; note empty first parameter in the code
{{para|<var>parameter</var>|<var>value</var>}}	|parameter=value

When using literal, pre-specified values, simply provide the value (as in the third example above). When illustrating hypothetical, variable, or user-definable values, use <var>value</var> (as in the second example above). The same should be done for non-literal, example parameters (fourth example above).

See also

See also the three tables below; they describe the family of approximately forty templates built for talking about templates.

Here are some related templates or subjects not found in the tables:

• {{Param}}
• {{Parameter}}
• {{tag}}, for providing a similar service, but for HTML tags

General-purpose formatting

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Uses monospace font but not <code>...</code>.
• ⁴ Allows links to templates in any namespace.

Other formatting templates

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix

With utility links

Code example	Effect
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
{{tfd links|Hatnote}}	Template:Hatnote (edit · talk · history · links · logs · subpages · delete)
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	{{Hatnote}} links talk view
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk view
{{ti|Hatnote}}	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽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)