View source for Template:Param value/doc

{{Documentation subpage}}
{{distinguish|Template:Template parameter value}}
{{High-use}}
{{tlr|clear=right|pvalue|pval}}
{{Uses TemplateStyles|Template:Param value/styles.css}}
Provides a lightly bordered box to highlight param values on [[Wikipedia:Template documentation|Template documentation]] pages. Especially useful in cases where values may have leading or trailing blanks, or multiple embedded blanks.

== Usage ==

{{tlc|param value|<var>value</var>}}

== Parameters ==

There is one required positional parameter for the value, and four optional params: three for styling the display, and one replacement parameter for dealing with how to render a blank space:

: {{para|1}}{{snd}}the value to be highlighted; required (no default)
: {{para|border}}{{snd}}may be used to set border attributes. default: {{param value|thin solid #caa|bg=#f5fcf9}}. Alias: {{para|b}}.
: {{para|bg-color}}{{snd}}may be used to set background-color. default: {{param value|white|bg=#f5fcf9}}. Alias: {{para|bg}}.
: {{para|style}}{{snd}} may be used to set any [[CSS|CSS style attributes]], with one or more semicolon-separated {{pval|''attribute'':value||bg=#f5fcf9|style=border-radius:3px}} pairs. default:none.
: {{para|space}}{{snd}} may be used to make spaces visible. Alias: {{para|sp}}. See [[#Making spaces visible]] below.

'''Note on special characters:''' if the value to be highlighted contains an equal sign, it must be escaped: use <code><nowiki>{{=}}</nowiki></code> instead of a bare equal sign character.

== Examples ==

* <code><nowiki>{{param value|2blanks  between}}</nowiki></code> yields: {{param value|2blanks  between}}
* <code><nowiki>{{param value|2blanks  between|space=·}}</nowiki></code> yields: {{param value|2blanks  between|space=·}}
* <code><nowiki>{{param value|  * : # }}</nowiki></code> yields: {{param value|  * : # }}
* <code><nowiki>{{param value|  * : # |border=2px dashed khaki}}</nowiki></code> yields: {{param value|  * : # |border=2px dashed khaki}}
* <code><nowiki>{{param value|white|bg=yellow}}</nowiki></code> yields: {{param value|white|bg=yellow}}
* <code><nowiki>{{pvalue|thin solid #caa|bg=#f5fcf9}}</nowiki></code> yields: {{pvalue|thin solid #caa|bg=#f5fcf9}}
* <code><nowiki>{{pval|*  #|border=thin dashed purple|bg=#ffe6e6|style=border-radius:5px|space=␠}}</nowiki></code> yields: {{pval|*  #|border=thin dashed purple|bg=#ffe6e6|style=border-radius:5px|space=␠}}

== Making spaces visible ==

You may make [[Whitespace character|space characters]] visible by replacing them with any character you choose using param {{para|space}}. Here are some characters that have been historically used for this purpose. In these examples, there are two spaces between ''one'' and ''two'':
* Space symbol{{snd}}([[Control Pictures#Block|U+2420]] = ␠ ) : <code><nowiki>{{param value|one  two|space=␠}}</nowiki></code> ⟶ {{param value|one  two|space=␠}}
* [[Blank symbol]]{{snd}}([[Control Pictures#Block|U+2422]] = ␢ ) : <code><nowiki>{{pvalue|one  two|space=␢}}</nowiki></code> ⟶ {{pvalue|one  two|space=␢}}
** [[Blank symbol]]{{snd}} (smaller:  <small>␢</small>) : <code><nowiki>{{pvalue|one  two|space=<small>␢</small>}}</nowiki></code> ⟶ {{param value|one  two|space=<small>␢</small>}}
* [[Middot]]{{snd}}([[Whitespace character#U+00B7|U+00B7]] = &middot; ) : <code><nowiki>{{pval|one  two|space=·}}</nowiki></code> ⟶ {{pval|one  two|space=·}}
* Underbracket{{snd}}([[Miscellaneous Technical#(2380–23BF)|U+23B5]] = ⎵ ) :  <code><nowiki>{{pval|one  two|space=⎵}}</nowiki></code> ⟶ {{pval|one  two|space=⎵}}
* White rectangle{{snd}}([[Geometric Shapes (Unicode block)#U+25A0–U+25CF|U+25AF]] = ▯ ) : <code><nowiki>{{pval|one  two|space=▯}}</nowiki></code> ⟶ {{pval|one  two|space=▯}}
* [[Undertie]]{{snd}}([[General Punctuation#Block|U+203F]] = ‿ ) : <code><nowiki>{{pval|one  two|space=‿}}</nowiki></code> ⟶ {{pval|one  two|space=‿}}

== See also ==
* {{tl|mono}}, monospaced font only
* {{tl|code}}, which only provides syntax highlighting, without forbidding line breaks
* {{tl|Codett}}, wrapper for this template that removes background and border styling
* {{tl|PreCode}}, which forbids line breaks inside the code
* {{tl|Syntaxhighlight}}
* {{tl|kbd}}, for keyboard input

{{Semantic markup templates}}
<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->

[[Category:Typing-aid templates]]
[[Category:Semantic markup templates]]
[[Category:Documentation assistance templates]]
}}</includeonly>