Template:Para/doc

This is a documentation subpage for Template:Para.
It contains usage information, categories and other content that is not part of the original template page.

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

{{para|name}}
renders as

|name=
{{para|title|<var>book title</var>}}
renders as

|title=book title
{{para| |section}}
renders as

|section

(for unnamed parameters in the example code; note the empty first parameter in the {{para}} template)
{{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}}` options¹ →	DEFAULT	`<syntaxhighlight lang="text" enclose="none">nolink=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">subst=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">braceinside=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">alttext=Foo</syntaxhighlight>` `<syntaxhighlight lang="text" enclose="none">2=Foo</syntaxhighlight>`
normal	DEFAULT	`{{tlg}}`¹ `{{tl}}` `{{tlp}}`² `{{tlu}}`³	`{{tlf}}`²	`{{tls}}` `{{tlsp}}` `{{tlsu}}`³	`{{tn}}`	`{{tla}}`
`code`	`<syntaxhighlight lang="text" enclose="none">code=yes</syntaxhighlight>`	`{{tl2}}` `{{tlx}}` `{{tlxu}}`³	`{{tlc}}`² `{{tld}}`² `{{tnull}}`	`{{tlxs}}`	N/A
monospace `kbd`	`<syntaxhighlight lang="text" enclose="none">plaincode=yes</syntaxhighlight>`⁴ `<syntaxhighlight lang="text" enclose="none">kbd=yes</syntaxhighlight>`⁵	`{{tltt}}`⁵ `{{tltt2}}`⁵	N/A	`{{tltss}}`⁶	N/A
bold	`<syntaxhighlight lang="text" enclose="none">bold=yes</syntaxhighlight>`	`{{tlb}}`	N/A
`bold+code`	code=yes</syntaxhighlight>	`{{tlxb}}`
`italic+code`	code=yes</syntaxhighlight>	`{{tlxi}}`
¹ `{{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. ³ Allows links to templates in any namespace. ⁴ REDIRECT Template:Template link code uses `<code style="border:none; background-color:transparent;"></code>`. ⁵ Displays monospaced font using `<kbd></kbd>` tags (changed from `<tt></tt>` for HTML 5 compliance). ⁶ 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:Tln	Produces a normal link to the template
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	Template:Elc Template:Elc	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}}`	Template:Sclx	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}}`	Template:Dtl	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 view
`{{tsetl\|Hatnote}}`	Template:Tsetl
`{{ti\|Hatnote}}`	Template:Hatnote (talk, links, edit)
`{{tic\|Hatnote}}`	Template:Tic
`{{tim\|Hatnote}}`	m:Template:Hatnote (talk, backlinks, edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (talk, backlinks, edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	Template:Ttl
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)