Template:Param: Difference between revisions

{{{foo}}}

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

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

Usage

{{param|foo}} → {{{foo}}}

{{param|foo|tag=kbd}} → {{{foo}}}

{{param|foo|bar}} → {{{foo|bar}}}

{{param|foo|{{param|bar|nested=yes}}}} → {{{foo|{{{bar}}}}}}

{{param|foo|{{param|bar|{{param|baz|derp|nested=yes}}|nested=yes}}}} → {{{foo|{{{bar|{{{baz|derp}}}}}}}}}

Examples involving {{para}}

{{para|foo|{{param|bar}}}} → |foo={{{bar}}}

{{para|foo|{{param|bar|nested=yes}}}} → |foo={{{bar}}}

{{para|foo}}{{param|bar}} → |foo={{{bar}}}

{{para|foo|{{var|bar}}}} → |foo=bar

Template	Example output	Use
`{{strong}}`	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
`{{strongbad}}`	"Never use ..."	Same as {{strong}} but in red
`{{stronggood}}`	"Only use ..."	Same as {{strong}} but in green
`{{em}}`	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
`{{var}}`	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
`{{var serif}}`	`strIllustratePrefix`	(see {{var}} above)
`{{tld}}`	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
`{{para}}`	`\|year=2008`	To display template parameters with or without values
`{{param}}`	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
`{{tlx}}` etc.	`{{Template\|1\|2\|...\|10}}`	To display a template call (with or without parameters and values) as code
`{{tag}}`	"The `<img>...</img>` tags ..."	To render HTML elements ("tags") in prose
`{{code}}`/`{{codett}}`	"Ensure the <syntaxhighlight lang="text" class="" id="" style="" inline="1">alt=</syntaxhighlight> parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`. {{codett}} differs only in styling: <syntaxhighlight lang="text" class="" id="" style="" inline="1">someMethod</syntaxhighlight> becomes <syntaxhighlight lang="text" class="" id="" style="background:none; border:none; color:inherit; padding: 0px 0px;" inline="1">someMethod</syntaxhighlight>
`{{subst:codenowiki}}`	`{{small\|small text}}`	To wrap example code in <syntaxhighlight lang="text" class="" id="" style="" inline="1">`<nowiki>...</nowiki>`</syntaxhighlight>
`{{subst:kbdnowiki}}`	`{{big\|big text}}`	To wrap example code in <syntaxhighlight lang="text" class="" id="" style="" inline="1">`<nowiki>...</nowiki>`</syntaxhighlight>
`{{syntaxhighlight}}`	_{[this is a block template]}	( or `{{sxhl}}` ) Wrapper for `<syntaxhighlight>...</syntaxhighlight>`, but will wrap overflowing text
`{{deprecated code}}`	"Do not use `<blink>`."	( or `{{dc}}` ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The `{{dc2}}` variant uses strike-through (`<blink>`) while `{{dcr}}` uses red (`<blink>`).
`{{pre}}`	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
`{{quote}}`	_{[this is a block template]}	For block quotations (only – never for non-quotations)
`{{block indent}}`	_{[this is a block template]}	For indented blocks of material; visually identical to `{{quote}}` but without quote markup
`{{kbd}}`	`user input`	To indicate user input
`{{key press}}`	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
`{{key top}}`	`Left shift`	Similar; includes more symbols, but does not directly support combinations
`{{PlayStation key press}}`	`□`	To indicate PlayStation-style gamepad key presses
`{{button}}`	`Don't save`	To indicate a button in a user interface
`{{samp}}`	`example output`	To indicate sample or example output

The above documentation is transcluded from Template:Param/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

@@ Line 1: / Line 1: @@
-{{#ifeq:{{Yesno|{{{nested|no}}}}}|yes||<{{{tag|code}}}>}}&#123;&#123;&#123;{{{1<noinclude>|foo</noinclude>}}}{{#ifeq:{{{2}}}|{{{2|}}} |&#124;}}{{{2|}}}&#125;&#125;&#125;{{#ifeq:{{Yesno|{{{nested|no}}}}}|yes||</{{{tag|code}}}>}}<noinclude>
+{{SAFESUBST:<noinclude />#ifeq:{{SAFESUBST:<noinclude />Yesno|{{{nested|no}}}}}|yes||<{{{tag|code}}}>}}&#123;&#123;&#123;{{{1<noinclude>|foo</noinclude>}}}{{SAFESUBST:<noinclude />#ifeq:{{{2}}}|{{{2|}}} |&#124;}}{{{2|}}}&#125;&#125;&#125;{{SAFESUBST:<noinclude />#ifeq:{{SAFESUBST:<noinclude />Yesno|{{{nested|no}}}}}|yes||</{{{tag|code}}}>}}<noinclude>
 {{Documentation}}
 <!--

Template:Param: Difference between revisions

Latest revision as of 00:58, 3 September 2020

Usage

Examples involving {{para}}

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools