Template:Key press/doc - Revision history

Caleb Cooper at 22:33, 3 November 2020

2020-11-03T22:33:43Z

← Older revision		Revision as of 22:33, 3 November 2020
Line 4:		Line 4:
	{{Redirect\|Template:Key\|map key templates\|Category:Legend templates}}		{{Redirect\|Template:Key\|map key templates\|Category:Legend templates}}
	{{Lua\|Module:Key}}		{{Lua\|Module:Key}}
	{{used in system~~\|in [[MediaWiki:Clearyourcache]]~~}}		{{used in system}}
	{{high-use}}		{{high-use}}
	__NOTOC__		__NOTOC__

	This is the {{tl\|key press}} template primarily designed to illustrate keys and keystrokes on a [[computer keyboard]]. With additional parameters, a single template can even illustrate a combination of multiple ''simultaneous'' keystrokes. A sequence of keystrokes, on the other hand, need to be demonstrated with separate templates.		This is the {{tl\|key press}} template primarily designed to illustrate keys and keystrokes on a [[Wikipedia:computer keyboard\|computer keyboard]]. With additional parameters, a single template can even illustrate a combination of multiple ''simultaneous'' keystrokes. A sequence of keystrokes, on the other hand, need to be demonstrated with separate templates.

	Example		Example
Line 23:		Line 23:
	: {{tc\|key press\|Ctrl\|Alt\|Del\|5=chain=&#32;+&#32;}} → {{key press\|Ctrl\|Alt\|Del\|chain= + }}		: {{tc\|key press\|Ctrl\|Alt\|Del\|5=chain=&#32;+&#32;}} → {{key press\|Ctrl\|Alt\|Del\|chain= + }}

	To illustrate sequences where all keys do not need to be pressed simultaneously, the plus signs can be omitted by setting ''chain=''. For example, in most Windows systems in North America and Western Europe, [[Alt code]]s can be used to insert the [[plus-minus sign]] (±) by holding down the {{key press\|Alt}} key while typing <code>0177</code> with the [[numeric keypad]]:		To illustrate sequences where all keys do not need to be pressed simultaneously, the plus signs can be omitted by setting ''chain=''. For example, in most Windows systems in North America and Western Europe, [[Wikipedia:Alt code\|Alt code]]s can be used to insert the [[Wikipedia:plus-minus sign\|plus-minus sign]] (±) by holding down the {{key press\|Alt}} key while typing <code>0177</code> with the [[Wikipedia:numeric keypad\|numeric keypad]]:
	: {{tc\|key press\|Alt\|0}}{{tlc\|key press\|1\|7\|7\|chain{{=}}}} → {{key press\|Alt\|0}}{{key press\|1\|7\|7\|chain=}}		: {{tc\|key press\|Alt\|0}}{{tlc\|key press\|1\|7\|7\|chain{{=}}}} → {{key press\|Alt\|0}}{{key press\|1\|7\|7\|chain=}}

Line 31:		Line 31:
	===Wikilinks===		===Wikilinks===
	If there is an article about the key you can [[Wikipedia:WP:wikilink\|wikilink]] the key's name like any other wiki text. Like this:		If there is an article about the key you can [[Wikipedia:WP:wikilink\|wikilink]] the key's name like any other wiki text. Like this:
	* {{tc\|key press\|<nowiki>[[Alt key\|Alt]]</nowiki>}} → {{key press\|[[Alt key\|Alt]]}}		* {{tc\|key press\|<nowiki>[[Wikipedia:Alt key\|Alt]]</nowiki>}} → {{key press\|[[Wikipedia:Alt key\|Alt]]}}

	If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key\|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[Wikipedia:WP:Disambiguation page\|disambiguation page]]).		If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Wikipedia:Control key\|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Wikipedia:Ctrl\|]]</nowiki></code>, which leads to a [[Wikipedia:WP:Disambiguation page\|disambiguation page]]).

	===Wiki markup characters===		===Wiki markup characters===
	Some wiki markup characters, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tlx\|!}}, {{tlx\|;}} and {{tlx\|{{=}}}} templates or as an [[Wikipedia:HTML entity]] &#124;, &#59;, &#61; respectively:		Some wiki markup characters, like the [[Wikipedia:pipe symbol\|pipe symbol]], the [[Wikipedia:semicolon\|semicolon]] and the [[Wikipedia:equals sign\|equals sign]], need to be entered using the {{tlx\|!}}, {{tlx\|;}} and {{tlx\|{{=}}}} templates or as an [[Wikipedia:HTML entity]] &#124;, &#59;, &#61; respectively:
	* {{tc\|key press\|{{tc\|pipe}}}} → {{key press\|{{pipe}}}}		* {{tc\|key press\|{{tc\|pipe}}}} → {{key press\|{{pipe}}}}
	* {{tc\|key press\|&#124;}} → {{key press\|\|}}		* {{tc\|key press\|&#124;}} → {{key press\|\|}}
Line 58:		Line 58:

	===Key symbols===		===Key symbols===
	Some key names have a fitting [[Unicode]] character. This template automatically adds such "icons" to the following key names among others.		Some key names have a fitting [[Wikipedia:Unicode\|Unicode]] character. This template automatically adds such "icons" to the following key names among others.
	* {{tc\|key press\|Shift}} → {{key press\|Shift}}		* {{tc\|key press\|Shift}} → {{key press\|Shift}}
	* {{tc\|key press\|Tab}} → {{key press\|Tab}}		* {{tc\|key press\|Tab}} → {{key press\|Tab}}
Line 73:		Line 73:
	[[File:AltGr Win Menu Ctrl key.jpg\|thumb\|200px\|Windows key and Menu key]]		[[File:AltGr Win Menu Ctrl key.jpg\|thumb\|200px\|Windows key and Menu key]]
	[[File:Ctl wndws alt.jpg\|thumb\|200px\|Old-style Windows key]]		[[File:Ctl wndws alt.jpg\|thumb\|200px\|Old-style Windows key]]
	There are no characters for the [[Windows key]] and [[Menu key]]. So this template shows approximate characters for them, namely the {{sc2\|SQUARED PLUS}} and {{sc2\|STRICTLY EQUIVALENT TO}} from the [[Mathematical Operators]] Unicode block:		There are no characters for the [[Wikipedia:Windows key\|Windows key]] and [[Wikipedia:Menu key\|Menu key]]. So this template shows approximate characters for them, namely the {{sc2\|SQUARED PLUS}} and {{sc2\|STRICTLY EQUIVALENT TO}} from the [[Wikipedia:Mathematical Operators\|Mathematical Operators]] Unicode block:
	* {{tc\|key press\|Win}} → {{key press\|Win}}		* {{tc\|key press\|Win}} → {{key press\|Win}}
	* {{tc\|key press\|Menu}} → {{key press\|Menu}}		* {{tc\|key press\|Menu}} → {{key press\|Menu}}
Line 185:		Line 185:
	[[Category:Software templates]]		[[Category:Software templates]]
	[[Category:Computer keys\|τ]]		[[Category:Computer keys\|τ]]

	[[nl:Sjabloon:Toets]]
	[[sl:Predloga:Keypress]]
	}}</includeonly>		}}</includeonly>

Caleb Cooper: Text replacement - "[[HTML" to "[[Wikipedia:HTML"

2020-10-21T16:22:11Z

Text replacement - "[[HTML" to "[[Wikipedia:HTML"

← Older revision		Revision as of 16:22, 21 October 2020
Line 36:		Line 36:

	===Wiki markup characters===		===Wiki markup characters===
	Some wiki markup characters, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tlx\|!}}, {{tlx\|;}} and {{tlx\|{{=}}}} templates or as an [[HTML entity]] &#124;, &#59;, &#61; respectively:		Some wiki markup characters, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tlx\|!}}, {{tlx\|;}} and {{tlx\|{{=}}}} templates or as an [[Wikipedia:HTML entity]] &#124;, &#59;, &#61; respectively:
	* {{tc\|key press\|{{tc\|pipe}}}} → {{key press\|{{pipe}}}}		* {{tc\|key press\|{{tc\|pipe}}}} → {{key press\|{{pipe}}}}
	* {{tc\|key press\|&#124;}} → {{key press\|\|}}		* {{tc\|key press\|&#124;}} → {{key press\|\|}}

Caleb Cooper: Text replacement - "[[WP:" to "[[Wikipedia:WP:"

2020-10-21T08:13:03Z

Text replacement - "[[WP:" to "[[Wikipedia:WP:"

← Older revision		Revision as of 08:13, 21 October 2020
Line 30:		Line 30:

	===Wikilinks===		===Wikilinks===
	If there is an article about the key you can [[WP:wikilink\|wikilink]] the key's name like any other wiki text. Like this:		If there is an article about the key you can [[Wikipedia:WP:wikilink\|wikilink]] the key's name like any other wiki text. Like this:
	* {{tc\|key press\|<nowiki>[[Alt key\|Alt]]</nowiki>}} → {{key press\|[[Alt key\|Alt]]}}		* {{tc\|key press\|<nowiki>[[Alt key\|Alt]]</nowiki>}} → {{key press\|[[Alt key\|Alt]]}}

	If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key\|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[WP:Disambiguation page\|disambiguation page]]).		If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key\|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[Wikipedia:WP:Disambiguation page\|disambiguation page]]).

	===Wiki markup characters===		===Wiki markup characters===

Caleb Cooper: /* See also */

2020-10-19T11:24:32Z

Caleb Cooper at 11:20, 19 October 2020

2020-10-19T11:20:13Z

← Older revision		Revision as of 11:20, 19 October 2020
Line 5:		Line 5:
	{{Lua\|Module:Key}}		{{Lua\|Module:Key}}
	{{used in system\|in [[MediaWiki:Clearyourcache]]}}		{{used in system\|in [[MediaWiki:Clearyourcache]]}}
	{{high use}}		{{high-use}}
	__NOTOC__		__NOTOC__

Caleb Cooper: Created page with "{{Documentation subpage}} {{Commons Import}} {{Redirect|Template:Key|map key templates|Category:Legend..."

2020-10-19T11:18:52Z

Created page with "{{Documentation subpage}} {{Commons Import}}  {{Redirect|Template:Key|map key templates|Category:Legend..."

New page

{{Documentation subpage}}
{{Commons Import}}

{{Redirect|Template:Key|map key templates|Category:Legend templates}}
{{Lua|Module:Key}}
{{used in system|in [[MediaWiki:Clearyourcache]]}}
{{high use}}
__NOTOC__

This is the {{tl|key press}} template primarily designed to illustrate keys and keystrokes on a [[computer keyboard]]. With additional parameters, a single template can even illustrate a combination of multiple ''simultaneous'' keystrokes. A sequence of keystrokes, on the other hand, need to be demonstrated with separate templates.

Example
: {{tc|key press|A}} → {{key press|A}}
As lower-case alphabetic characters a–z do not appear on most keyboards, they should not be used as parameters.

===Keystroke combinations===
To illustrate keystroke combinations, just use extra parameters:
: {{tc|key press|Alt|P}} → {{key press|Alt|P}}
: {{tc|key press|Ctrl|Alt|Del}} → {{key press|Ctrl|Alt|Del}}

When you feed several key names to this template, it adds a "+" (or whatever the contents of the optional ''chain'' parameter) with no spaces around. This means it won't line wrap. But when you show key combinations for instance in a table that might cause items to be too wide. Instead manually build the key combination with spaces around the "+" so it can line wrap:
: {{tc|key press|Ctrl}} + {{tlc|key press|Alt}} + {{tlc|key press|Del}} → {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
: {{tc|key press|Ctrl|Alt|Del|5=chain=&#32;+&#32;}} → {{key press|Ctrl|Alt|Del|chain= + }}

To illustrate sequences where all keys do not need to be pressed simultaneously, the plus signs can be omitted by setting ''chain=''. For example, in most Windows systems in North America and Western Europe, [[Alt code]]s can be used to insert the [[plus-minus sign]] (±) by holding down the {{key press|Alt}} key while typing <code>0177</code> with the [[numeric keypad]]:
: {{tc|key press|Alt|0}}{{tlc|key press|1|7|7|chain{{=}}}} → {{key press|Alt|0}}{{key press|1|7|7|chain=}}

An example of a use case where more than 5 might be used is explaining usage of a macro (keyboard shortcut) created by a third-party application:
: {{tc|Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} → {{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}

===Wikilinks===
If there is an article about the key you can [[WP:wikilink|wikilink]] the key's name like any other wiki text. Like this:
* {{tc|key press|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key press|[[Alt key|Alt]]}}

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[WP:Disambiguation page|disambiguation page]]).

===Wiki markup characters===
Some wiki markup characters, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tlx|!}}, {{tlx|;}} and {{tlx|{{=}}}} templates or as an [[HTML entity]] &#124;, &#59;, &#61; respectively:
* {{tc|key press|{{tc|pipe}}}} → {{key press|{{pipe}}}}
* {{tc|key press|&#124;}} → {{key press||}}
* {{tc|key press|{{tc|;}}}} → {{key press|{{;}}}}
* {{tc|key press|&#59;}} → {{key press|;}}
* {{tc|key press|{{tc|=}}}} → {{key press|{{=}}}}
* {{tc|key press|&#61;}} → {{key press|=}}

However, if the characters are marked as wikilinks, they can be entered as such:
* {{tc|key press|<nowiki>[[|]]</nowiki>}} → {{key press|[[|]]}}
* {{tc|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
* {{tc|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}

Most markup characters also have aliases:
* {{tc|key press|pipe}} → {{key press|pipe}}
* {{tc|key press|semicolon}} → {{key press|semicolon}}
* {{tc|key press|equals}} → {{key press|equals}}
* {{tc|key press|colon}} → {{key press|colon}}
* {{tc|key press|asterisk}} → {{key press|asterisk}}
* {{tc|key press|hash}} → {{key press|hash}}

===Key symbols===
Some key names have a fitting [[Unicode]] character. This template automatically adds such "icons" to the following key names among others.
* {{tc|key press|Shift}} → {{key press|Shift}}
* {{tc|key press|Tab}} → {{key press|Tab}}
* {{tc|key press|Enter}} → {{key press|Enter}}
* {{tc|key press|Option}} → {{key press|Option}}
* {{tc|key press|Opt}} → {{key press|Opt}}
* {{tc|key press|Command}} → {{key press|Command}}
* {{tc|key press|Cmd}} → {{key press|Cmd}}
* {{tc|key press|Caps Lock}} → {{key press|Caps Lock}}
* {{tc|key press|Up}} → {{key press|Up}}
* {{tc|key press|Down}} → {{key press|Down}}
* {{tc|key press|Left}} → {{key press|Left}}
* {{tc|key press|Right}} → {{key press|Right}}
[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]]
[[File:Ctl wndws alt.jpg|thumb|200px|Old-style Windows key]]
There are no characters for the [[Windows key]] and [[Menu key]]. So this template shows approximate characters for them, namely the {{sc2|SQUARED PLUS}} and {{sc2|STRICTLY EQUIVALENT TO}} from the [[Mathematical Operators]] Unicode block:
* {{tc|key press|Win}} → {{key press|Win}}
* {{tc|key press|Menu}} → {{key press|Menu}}

====Video games====
Video game controllers often have specialized input labels that do not map easily. The following are mappings for various game consoles and input features.

=====Directional input=====
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.
* {{tc|key press|l-down}} → {{key press|l-down}}
* {{tc|key press|c-left}} → {{key press|c-left}}
* {{tc|key press|r-up}} → {{key press|r-up}}

Stick specific diagonals are also supported:
* {{tc|key press|l-nw}} → {{key press|l-nw}}
* {{tc|key press|c-se}} → {{key press|c-se}}
* {{tc|key press|r-ne}} → {{key press|r-ne}}

=====PlayStation=====
* {{tc|key press|ex}} → {{key press|ex}}
* {{tc|key press|circle}} → {{key press|circle}}
* {{tc|key press|triangle}} → {{key press|triangle}}
* {{tc|key press|square}} → {{key press|square}}
{{clear}}

===TemplateData===
{{TemplateDataHeader}}
<templatedata>
{
"description": "Illustrates keys and keystrokes on a computer keyboard. Keys can include: Ctrl, Alt, Del, Opt, Menu, Left etc. console keys: ex, circle, triangle, square, and left right and center analog sticks: l-down, c-left, r-ne. The names are case insensitive.",
"params": {
"1": {
"label": "First key",
"description": "First key",
"type": "string/line",
"required": true
},
"2": {
"label": "Second key",
"description": "Optional key press in combination as the first.",
"type": "string/line",
"required": false
},
"3": {
"label": "Third key",
"inherits": "2"
},
"4": {
"label": "Fourth key",
"inherits": "2"
},
"5": {
"label": "Fifth key",
"inherits": "2"
},
"6": {
"label": "Sixth key",
"inherits": "2"
},
"7": {
"label": "Seventh key",
"inherits": "2"
},
"8": {
"label": "Eighth key",
"inherits": "2"
},
"9": {
"label": "Ninth key",
"inherits": "2"
},
"10": {
"label": "Tenth key",
"inherits": "2"
},
"chain": {
"label": "Chaining character",
"description": "Character between chained key presses",
"default": "+",
"inherits": "2"
},
"chain first": {
"description": "Character between first and second key to press",
"inherits": "chain"
},
"chain second": {
"description": "Character between second and third key to press",
"inherits": "chain"
},
"chain third": {
"description": "Character between third and fourth key to press",
"inherits": "chain"
},
"chain fourth": {
"description": "Character between fourth and fifth key to press",
"inherits": "chain"
}
}
}
</templatedata>

===See also===
* {{tlx|Key top}} – produces a similar visual effect, but includes more symbols and does not directly support key combinations (e.g. {{key top|Caps Lock}})
* {{tlx|Button}} – produces a similar visual effect but without the semantic markup (e.g. {{Button|sample text}}); more for representing interface elements.
* {{tlx|Playstation key press}} – to simulate gamepad buttons (e.g. {{tlx|Playstation key press|s}})
* {{tlx|Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons

{{Semantic markup templates}}

<includeonly>{{Sandbox other||

[[Category:Programming typing-aid templates]]

[[Category:Semantic markup templates]]
[[Category:Software templates]]
[[Category:Computer keys|τ]]

[[nl:Sjabloon:Toets]]
[[sl:Predloga:Keypress]]
}}</includeonly>

← Older revision		Revision as of 11:24, 19 October 2020
Line 175:		Line 175:

	===See also===		===See also===
			See wikipedia for more detail: [[wikipedia:Template:Key press]]
	* {{tlx\|Key top}} – produces a similar visual effect, but includes more symbols and does not directly support key combinations (e.g. {{key top\|Caps Lock}})
	* {{tlx\|Button}} – produces a similar visual effect but without the semantic markup (e.g. {{Button\|sample text}}); more for representing interface elements.
	* {{tlx\|Playstation key press}} – to simulate gamepad buttons (e.g. {{tlx\|Playstation key press\|s}})
	* {{tlx\|Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons

	{{Semantic markup templates}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|