Template:Param value/doc - Revision history

Matt at 21:33, 9 April 2025

2025-04-09T21:33:36Z

← Older revision		Revision as of 17:33, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{High-use}}~~
	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.		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.

Matt at 08:58, 9 April 2025

2025-04-09T08:58:09Z

← Older revision		Revision as of 04:58, 9 April 2025
Line 2:		Line 2:
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use}}		{{High-use}}
	~~{{tlr\|clear=right\|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.		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.

Matt at 08:47, 9 April 2025

2025-04-09T08:47:47Z

← Older revision		Revision as of 04:47, 9 April 2025
Line 41:		Line 41:
	* White rectangle{{snd}}(U+25AF = ▯ ) : <code><nowiki>{{pval\|one two\|space=▯}}</nowiki></code> ⟶ {{pval\|one two\|space=▯}}		* White rectangle{{snd}}(U+25AF = ▯ ) : <code><nowiki>{{pval\|one two\|space=▯}}</nowiki></code> ⟶ {{pval\|one two\|space=▯}}
	* Undertie{{snd}}(U+203F = ‿ ) : <code><nowiki>{{pval\|one two\|space=‿}}</nowiki></code> ⟶ {{pval\|one two\|space=‿}}		* Undertie{{snd}}(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 higlighting, 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}}
	* , for keyboard input

	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|

Matt at 08:47, 9 April 2025

2025-04-09T08:47:38Z

← Older revision		Revision as of 04:47, 9 April 2025
Line 48:		Line 48:
	* {{tl\|PreCode}}, which forbids line breaks inside the code		* {{tl\|PreCode}}, which forbids line breaks inside the code
	* {{tl\|Syntaxhighlight}}		* {{tl\|Syntaxhighlight}}
	* ~~{{tl\|kbd}}~~, for keyboard input		* , for keyboard input

	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|

Matt at 14:43, 8 April 2025

2025-04-08T14:43:18Z

← Older revision		Revision as of 10:43, 8 April 2025
Line 50:		Line 50:
	* {{tl\|kbd}}, for keyboard input		* {{tl\|kbd}}, for keyboard input

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

Matt at 22:52, 6 April 2025

2025-04-06T22:52:14Z

Matt at 21:15, 5 March 2025

2025-03-05T21:15:42Z

← Older revision		Revision as of 17:15, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use}}		{{High-use}}

Matt: Protected "Template:Param value/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T20:10:13Z

Protected "Template:Param value/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 16:10, 5 March 2025
(No difference)

Matt: Created page with "{{Documentation subpage}} {{High-use}} {{tlr|clear=right|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 == {{tlc|param value|`value`}} == Parameters == There is one required positional parameter for the value, and four optional params: three for stylin..."

2025-03-05T19:02:48Z

Created page with "{{Documentation subpage}} {{High-use}} {{tlr|clear=right|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 == {{tlc|param value|<var>value</var>}} == Parameters == There is one required positional parameter for the value, and four optional params: three for stylin..."

New page

{{Documentation subpage}}
{{High-use}}
{{tlr|clear=right|pvalue|pval}}
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: ␢) : <code><nowiki>{{pvalue|one two|space=␢}}</nowiki></code> ⟶ {{param value|one two|space=␢}}
* [[Middot]]{{snd}}([[Whitespace character#U+00B7|U+00B7]] = · ) : <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 higlighting, 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||


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

← Older revision		Revision as of 18:52, 6 April 2025
Line 3:		Line 3:
	{{High-use}}		{{High-use}}
	{{tlr\|clear=right\|pvalue\|pval}}		{{tlr\|clear=right\|pvalue\|pval}}
	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.		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 ==		== Usage ==
Line 16:		Line 16:
	: {{para\|border}}{{snd}}may be used to set border attributes. default: {{param value\|thin solid #caa\|bg=#f5fcf9}}. Alias: {{para\|b}}.		: {{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\|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\|style}}{{snd}} may be used to set any 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.		: {{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.		'''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.
Line 33:		Line 33:
	== Making spaces visible ==		== 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'':		You may make 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=␠}}		* Space symbol{{snd}}(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}}(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>}}		** 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]]~~ = · ) : <code><nowiki>{{pval\|one two\|space=·}}</nowiki></code> ⟶ {{pval\|one two\|space=·}}		* Middot{{snd}}(U+00B7 = · ) : <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=⎵}}		* Underbracket{{snd}}(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=▯}}		* White rectangle{{snd}}(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=‿}}		* Undertie{{snd}}(U+203F = ‿ ) : <code><nowiki>{{pval\|one two\|space=‿}}</nowiki></code> ⟶ {{pval\|one two\|space=‿}}

	== See also ==		== See also ==