Template:Param value
value
Template:Tlr Provides a lightly bordered box to highlight param values on Template documentation pages. Especially useful in cases where values may have leading or trailing blanks, or multiple embedded blanks.
Usage
{{param value|value}}
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:
|1=
Template:Sndthe value to be highlighted; required (no default)|border=
Template:Sndmay be used to set border attributes. default:thin solid #caa
. Alias:|b=
.|bg-color=
Template:Sndmay be used to set background-color. default:white
. Alias:|bg=
.|style=
Template:Snd may be used to set any CSS style attributes, with one or more semicolon-separated Template:Pval pairs. default:none.|space=
Template:Snd may be used to make spaces visible. Alias:|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 {{=}}
instead of a bare equal sign character.
Examples
{{param value|2blanks between}}
yields:2blanks between
{{param value|2blanks between|space=·}}
yields:2blanks··between
{{param value| * : # }}
yields:* : #
{{param value| * : # |border=2px dashed khaki}}
yields:* : #
{{param value|white|bg=yellow}}
yields:white
{{pvalue|thin solid #caa|bg=#f5fcf9}}
yields: Template:Pvalue{{pval|* #|border=thin dashed purple|bg=#ffe6e6|style=border-radius:5px|space=␠}}
yields: Template:Pval
Making spaces visible
You may make space characters visible by replacing them with any character you choose using param |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 symbolTemplate:Snd(U+2420 = ␠ ) :
{{param value|one two|space=␠}}
⟶one␠␠two
- Blank symbolTemplate:Snd(U+2422 = ␢ ) :
{{pvalue|one two|space=␢}}
⟶ Template:Pvalue- Blank symbolTemplate:Snd (smaller: ␢) :
{{pvalue|one two|space=<small>␢</small>}}
⟶one␢␢two
- Blank symbolTemplate:Snd (smaller: ␢) :
- MiddotTemplate:Snd(U+00B7 = · ) :
{{pval|one two|space=·}}
⟶ Template:Pval - UnderbracketTemplate:Snd(U+23B5 = ⎵ ) :
{{pval|one two|space=⎵}}
⟶ Template:Pval - White rectangleTemplate:Snd(U+25AF = ▯ ) :
{{pval|one two|space=▯}}
⟶ Template:Pval - UndertieTemplate:Snd(U+203F = ‿ ) :
{{pval|one two|space=‿}}
⟶ Template:Pval