Difference between revisions of "Template:Key press/doc"

From blackwiki
Jump to navigation Jump to search
imported>Lemondoge
imported>Idell
(→‎Wikilinks: Used 2× [ and ] to disable wikilink)
 
(27 intermediate revisions by 19 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE END OF THIS PAGE. -->
 
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE END OF THIS PAGE. -->
 +
{{Redirect|Template:Key|map key templates|Category:Legend templates}}
 +
{{Lua|Module:Key}}
 +
{{used in system|in [[MediaWiki:Clearyourcache]]}}
 +
{{high use}}
 
__NOTOC__
 
__NOTOC__
  
Line 7: Line 11:
 
Example
 
Example
 
: {{tc|key press|A}} → {{key press|A}}
 
: {{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===
 
===Keystroke combinations===
Line 13: Line 18:
 
: {{tc|key press|Ctrl|Alt|Del}} → {{key press|Ctrl|Alt|Del}}
 
: {{tc|key press|Ctrl|Alt|Del}} → {{key press|Ctrl|Alt|Del}}
  
This template currently handles up to 10 key name parameters, which should be more than enough to accommodate for any possible combination of simultaneous keystrokes. If it gets too many key name parameters it reports the page into [[:Category:Wikipedia keypress template parameter needs fixing]]. This means we can easily find those pages and fix them, or we can discover if we need to make this template take more parameters.
+
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:
 
 
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 then that might cause too wide items. Then 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}} + {{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=&amp;#32;+&amp;#32;}} → {{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}
 
: {{tc|key press|Ctrl|Alt|Del|5=chain=&amp;#32;+&amp;#32;}} → {{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}
  
On the other hand, to illustrate Windows [[Alt code]]s you might want to use separate templates with no intervening punctuation or space. In most Windows systems in North America and Western Europe, for example, the [[plus-minus sign]] (±) can be entered by holding down the 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, [[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}}{{tlc|key press|7}}{{tlc|key press|7}} → {{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}
+
: {{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:
 
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:
Line 27: 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 [[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|&#91;&#91;Alt key|Alt&#93;&#93;}} → {{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 [[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 {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates or as an [[HTML entity]] &amp;#124;, &amp;#59;, &amp;#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 [[HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
 
* {{tc|key press|{{tc|pipe}}}} → {{key press|{{pipe}}}}
 
* {{tc|key press|{{tc|pipe}}}} → {{key press|{{pipe}}}}
 
* {{tc|key press|&amp;#124;}} → {{key press|&#124;}}
 
* {{tc|key press|&amp;#124;}} → {{key press|&#124;}}
Line 41: Line 44:
  
 
However, if the characters are marked as wikilinks, they can be entered as such:
 
However, if the characters are marked as wikilinks, they can be entered as such:
* {{tc|key press|<nowiki>[[&#124;]]</nowiki>}} → {{key press|}}
+
* {{tc|key press|<nowiki>[[|]]</nowiki>}} → {{key press|[[|]]}}
 
* {{tc|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
 
* {{tc|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
 
* {{tc|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}
 
* {{tc|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}
Line 63: Line 66:
 
* {{tc|key press|Cmd}} → {{key press|Cmd}}
 
* {{tc|key press|Cmd}} → {{key press|Cmd}}
 
* {{tc|key press|Caps Lock}} → {{key press|Caps Lock}}
 
* {{tc|key press|Caps Lock}} → {{key press|Caps Lock}}
* {{tc|key press|Scroll Lock}} → {{key press|Scroll Lock}}
 
 
* {{tc|key press|Up}} → {{key press|Up}}
 
* {{tc|key press|Up}} → {{key press|Up}}
 
* {{tc|key press|Down}} → {{key press|Down}}
 
* {{tc|key press|Down}} → {{key press|Down}}
Line 70: Line 72:
 
[[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 'SQUARED PLUS' and 'STRICTLY EQUIVALENT TO' from the [[Mathematical Operators]] block:
+
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|Win}} → {{key press|Win}}
 
* {{tc|key press|Menu}} → {{key press|Menu}}
 
* {{tc|key press|Menu}} → {{key press|Menu}}
Line 94: Line 96:
 
* {{tc|key press|square}} → {{key press|square}}
 
* {{tc|key press|square}} → {{key press|square}}
 
{{clear}}
 
{{clear}}
 
===Technical details===
 
This template calls {{tl|key press/core}}, which holds the code that otherwise would be repeated several times in {{tl|key press}}, thus simplifying the code.
 
  
 
===TemplateData===
 
===TemplateData===
Line 121: Line 120:
 
},
 
},
 
"4": {
 
"4": {
"label": "Forth key",
+
"label": "Fourth key",
 
"inherits": "2"
 
"inherits": "2"
 
},
 
},
Line 175: Line 174:
  
 
===See also===
 
===See also===
* {{tl|Button}}, which produces a similar visual effect but without the semantic markup (e.g. {{Button|sample text}}).
+
* {{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}})
* {{tl|Key top}}, which produces a similar visual effect, but includes more symbols and does not directly support key chaining (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}}
 
{{Semantic markup templates}}
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- CATEGORY LINKS BELOW THIS LINE, PLEASE: -->
 
<!-- CATEGORY LINKS BELOW THIS LINE, PLEASE: -->
 
[[Category:Programming typing-aid templates]]
 
[[Category:Programming typing-aid templates]]
Line 190: Line 191:
 
[[nl:Sjabloon:Toets]]
 
[[nl:Sjabloon:Toets]]
 
[[sl:Predloga:Keypress]]
 
[[sl:Predloga:Keypress]]
</includeonly>
+
}}</includeonly>

Latest revision as of 18:07, 10 February 2021


This is the {{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

{{key press|A}}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:

{{key press|Alt|P}}Alt+P
{{key press|Ctrl|Alt|Del}}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:

{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}Ctrl + Alt + Del
{{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}Ctrl + Alt + Del

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 codes can be used to insert the plus-minus sign (±) by holding down the Alt key while typing 0177 with the numeric keypad:

{{key press|Alt|0}}{{key press|1|7|7|chain=}}Alt+0177

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:

{{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}Ctrl+Alt+⇧ Shift+⊞ Win+≣ Menu+fn+L

Wikilinks

If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:

  • {{key press|[[Alt key|Alt]]}}Alt

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[Control key|Ctrl]] instead of [[Ctrl]], which leads to a 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 {{!}}, {{;}} and {{=}} templates or as an HTML entity &#124;, &#59;, &#61; respectively:

  • {{key press|{{pipe}}}}|
  • {{key press|&#124;}}|
  • {{key press|{{;}}}};
  • {{key press|&#59;}};
  • {{key press|{{=}}}}=
  • {{key press|&#61;}}=

However, if the characters are marked as wikilinks, they can be entered as such:

  • {{key press|[[|]]}}|
  • {{key press|[[;]]}};
  • {{key press|[[=]]}}=

Most markup characters also have aliases:

  • {{key press|pipe}}|
  • {{key press|semicolon}};
  • {{key press|equals}}=
  • {{key press|colon}}:
  • {{key press|asterisk}}*
  • {{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.

  • {{key press|Shift}}⇧ Shift
  • {{key press|Tab}}Tab ↹
  • {{key press|Enter}}↵ Enter
  • {{key press|Option}}⌥ Option
  • {{key press|Opt}}⌥ Opt
  • {{key press|Command}}⌘ Command
  • {{key press|Cmd}}⌘ Cmd
  • {{key press|Caps Lock}}⇪ Caps Lock
  • {{key press|Up}}
  • {{key press|Down}}
  • {{key press|Left}}
  • {{key press|Right}}
Windows key and Menu key
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 Template:Sc2 and Template:Sc2 from the Mathematical Operators Unicode block:

  • {{key press|Win}}⊞ Win
  • {{key press|Menu}}≣ 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.

  • {{key press|l-down}}L↓
  • {{key press|c-left}}C←
  • {{key press|r-up}}R↑

Stick specific diagonals are also supported:

  • {{key press|l-nw}}L↖
  • {{key press|c-se}}C↘
  • {{key press|r-ne}}R↗
PlayStation
  • {{key press|ex}}×
  • {{key press|circle}}
  • {{key press|triangle}}
  • {{key press|square}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Key press

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.

Template parameters

ParameterDescriptionTypeStatus
First key1

First key

Linerequired
Second key2

Optional key press in combination as the first.

Lineoptional
Third key3

Optional key press in combination as the first.

Lineoptional
Fourth key4

Optional key press in combination as the first.

Lineoptional
Fifth key5

Optional key press in combination as the first.

Lineoptional
Sixth key6

Optional key press in combination as the first.

Lineoptional
Seventh key7

Optional key press in combination as the first.

Lineoptional
Eighth key8

Optional key press in combination as the first.

Lineoptional
Ninth key9

Optional key press in combination as the first.

Lineoptional
Tenth key10

Optional key press in combination as the first.

Lineoptional
Chaining characterchain

Character between chained key presses

Default
+
Lineoptional
Chaining characterchain first

Character between first and second key to press

Default
+
Lineoptional
Chaining characterchain second

Character between second and third key to press

Default
+
Lineoptional
Chaining characterchain third

Character between third and fourth key to press

Default
+
Lineoptional
Chaining characterchain fourth

Character between fourth and fifth key to press

Default
+
Lineoptional

See also

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