Template:Para/doc

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 is the name of the example parameter to display (this may be empty, but it must be present), and the second (optional) one is a value for the first example parameter, or (if the first {{para}} parameter is empty) an unnamed example parameter.

Examples

1.   {{para|name}}

   renders as

   |name=

2.   {{para|title|<var>book title</var>}}

   renders as

   |title=book title

3.   {{para| |section}}

   renders as

   |section

   (for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)

4.   {{para|<var>parameter</var>|<var>value</var>}}

   renders as

   |parameter=value

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <var>value</var> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).

Related pages

• Template:Tlx – for providing examples of entire-template code with included parameters

General-purpose formatting

Comparison of template-linking templates according to their style

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ {{tlg}} options1 →	DEFAULT	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}}1 {{tl}} {{tlp}}2 {{tlu}}3	{{tlf}}2	{{tls}} {{tlsp}} {{tlsu}}3	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{tlxu}}3	{{tlc}}2 {{tld}}2 {{tnull}}	{{tlxs}}	—
monospace kbd	plaincode=yes4 kbd=yes5	{{tltt}}5 {{tltt2}}5	—	{{tltss}}6
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}
1  {{tlg}} is the most general, allowing any combination of text style and/or link style options. 2  Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags. 3  Allows links to templates in any namespace. 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>. 5  Displays monospaced font using <kbd>...</kbd> tags (changed from <tt>...</tt> for HTML 5 compliance). 6  Displays monospaced font using <span style="font-family:monospace;">...</span>.

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

With utility links

Code example	Effect
{{lt|Hatnote}}	Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tltt|Hatnote}}	{{Hatnote}}
{{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)
{{tim|Hatnote}}	m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)