Eisspeedway

value

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

{{pvalue}}
{{pval}}

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= – the value to be highlighted; required (no default)

|border= – may be used to set border attributes. default: thin solid #caa. Alias: |b=.

|bg-color= – may be used to set background-color. default: white. Alias: |bg=.

|style= – may be used to set any CSS style attributes, with one or more semicolon-separated attribute:value pairs. default:none.

|space= – 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: thin solid #caa
{{pval|* #|border=thin dashed purple|bg=#ffe6e6|style=border-radius:5px|space=␠}} yields: *␠␠#

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 symbol – (U+2420 = ␠ ) : {{param value|one two|space=␠}} ⟶ one␠␠two
Blank symbol – (U+2422 = ␢ ) : {{pvalue|one two|space=␢}} ⟶ one␢␢two
- Blank symbol – (smaller: ␢) : {{pvalue|one two|space=<small>␢</small>}} ⟶ one␢␢two
Middot – (U+00B7 = · ) : {{pval|one two|space=·}} ⟶ one··two
Underbracket – (U+23B5 = ⎵ ) : {{pval|one two|space=⎵}} ⟶ one⎵⎵two
White rectangle – (U+25AF = ▯ ) : {{pval|one two|space=▯}} ⟶ one▯▯two
Undertie – (U+203F = ‿ ) : {{pval|one two|space=‿}} ⟶ one‿‿two

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
{{tjp}}	selfref=yes	To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
{{param value}}	`··2·blanks·fore·and·aft··`	To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc.	`{{Template\|1\|2\|...\|10}}`	To display a template call (with or without parameters and values) as code
{{tji}}	{{hatnote\|Hello\|selfref=yes\|category=no}}	To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}}	"The `<img>...</img>` tags ..."	To render HTML elements ("tags") in prose
{{code}}/{{codett}}	"Ensure the `alt=` parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`. {{codett}} differs only in styling: `someMethod` becomes `someMethod`
{{PreCode}}	"FORTH has keyword `?BRANCH`."	Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki}}	`{{small\|small text example}}`	To wrap example code in `<code><nowiki>...</nowiki></code>`
{{subst:kbdnowiki}}	`{{large\|large text example}}`	To wrap example code in `<kbd><nowiki>...</nowiki></kbd>`
{{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
{{tj}}	_{[this is a block template]}	To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{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
{{button}}	`Don't save`	To indicate a button in a user interface
{{samp}}	`example output`	To indicate sample or example output

Template:Param value

Usage

Parameters

Examples

Making spaces visible

See also