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:
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:
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]]):
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]]):
Revision as of 06:19, 29 May 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
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 then that might cause too wide items. Then 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|5=chain= + }} → Ctrl + Alt + Del
On the other hand, to illustrate Windows Alt codes 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 0177 (with the numeric keypad):
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 {{{{#if: |subst:}}!{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}}, {{{{#if: |subst:}};{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} and {{{{#if: |subst:}}={{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} templates or as an HTML entity |, ;, = respectively:
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 Unicode block:
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.
<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
{{{{#if: |subst:}}Key top{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} – produces a similar visual effect, but includes more symbols and does not directly support key combinations (e.g. {{#switch:caps lock
| shift lock = ⇪ Caps Lock
| second level lock | 2nd level lock | l2 lock
| level 2 lock = ⇫ Caps Lock
| capitals lock
| caps lock = ⇬ Caps Lock
| numeric lock = ⇭ Caps Lock
| num | num lock = Caps Lock ⇩
| third level lock | 3rd level lock | l3 lock
| level 3 lock = ⇯ Caps Lock
| generalized lock | generalised lock
| lock | general lock = ⇩ Caps Lock
| group lock = ⇰ Caps Lock
| scrolling
| scrolling lock = ⇳ Caps Lock
| scroll | scroll lock = Caps Lock ⇩
| pause = ⎉ Caps Lock
| break = ⎊ Caps Lock
| second level | 2nd level
| level 2 select | level 2 selector
| level 2 | shift = ⇧ Caps Lock
| alternate graphic | alt graph | alt graphic | alt grill
| alt car | alt char | right alt | ralt
| alt group | alternate group | altgroup
| altgr | alt gr
| third level | 3rd level
| level 3 select | level 3 selector
| level 3 = ⇮ Caps Lock
| group select | group selector
| group = ⇨ Caps Lock
| enter = ⌅ Caps Lock
| return = {{#switch:|thin|narrow=↵|thick|hollow=⏎|bend||#default=↩}} Caps Lock
| submit | send = ⎆ Caps Lock
| opt | option = ⌥ Caps Lock
| alternate | left alt | lalt
| alt = ⎇ Caps Lock
| greek = Caps Lock
| top = Caps Lock
| super = ❖ Caps Lock
| hyper = ✦ Caps Lock
| repeat = Caps Lock
| code = ⌃ Caps Lock
| graph = ⎇ Caps Lock
| meta = ◆ Caps Lock
| function | fn = Caps Lock
| backwards erase | erase
| backspace = {{#if:|⟵|⌫}} Caps Lock
| del | delete = ⌦ Caps Lock
| ins | insert = {{#if:|⎀|⌤}} Caps Lock
| clear input = ⌧ Clear
| esc | escape = ⎋ Caps Lock
| ctrl | control | helm = {{#if:|⎈|⌃}} Caps Lock
| os | vendor
| cmd | command = ⌘ Caps Lock
| windows | win = {{#if:|⊞|⌘}} Caps Lock
| apple = ⌘
| menu = ≣ Caps Lock
| cmp | compose = ⎄ Caps Lock
| /\ = ⇡ Up
| up | up arrow | move up = {{#if:|🔼|↑}} Caps Lock
| \/ = ⇣ Down
| down | down arrow | move down = {{#if:|🔽|↓}} Caps Lock
| <- = ⇠ Left
| left | left arrow | move left = {{#if:|◀|←}} Caps Lock
| -> = ⇢ Right
| right | right arrow | move right = {{#if:|▶|→}} Caps Lock
| north west | north-west | nw | <\
| top-left | top left = ↖
| south east | south-east | se | \>
| bottom-right | bottom right = ↘
| north east | north-east | ne | />
| top-right | top right = ↗
| south west | south-west | sw | </
| bottom-left | bottom left = ↙
| tabulator | htab | horizontal tab | horizontal tabulator
| tab = Caps Lock ↹
| right tab = Tab ⇥
| shift tab | left tab = ⇤ Tab
| vertical tab | vertical tabulator = ↨ Caps Lock
| pos1 | start
| home = {{#if:|↖|⇱}} Caps Lock
| end = {{#if:|↘|⇲}} Caps Lock
| line start = ⇤ Caps Lock
| line end = ⇥ Caps Lock
| page start | top = ⤒ Caps Lock
| page end | bottom = ⤓ Caps Lock
| page up | pgup | pg up = ⇞ Caps Lock
| page down
| pgdn | pgdown | pg down = ⇟ Caps Lock
| left page | prev page | prev. page = ⎗ Caps Lock
| previous page = ⎗ Caps Lock
| right page | next page = ⎘ Caps Lock
| prtscr | prt scr | prtsc | prt sc
| print, print screen = ⎙ Caps Lock
| clrscr | clr scr | cls | clr sc
| clear | clear screen = ⎚ Caps Lock
| play | playback | start playback
| scroll right = ▶ Caps Lock
| play reverse | reverse
| scroll left = ◀ Caps Lock
| play/pause | play pause = ⏯ Caps Lock
| pause | pause playback = ‖ Caps Lock
| stop = {{#if:|◼|■}} Caps Lock
| eject = ⏏ Caps Lock
| record = {{#if:|🔴|●}} Caps Lock
| fwd | forward = ⏭ Caps Lock
| skip | skip forward = ⏭ Caps Lock
| skip back | skip backward = ⏮ Caps Lock
| backward | backwards
| rewind = ⏪ Caps Lock
| ffad | fast forward = ⏩ Caps Lock
| downward | downwards = ⏬ Caps Lock
| skip down | scroll down = 🔽 Caps Lock
| upward | upwards = ⏫ Caps Lock
| skip up | scroll up = 🔼 Caps Lock
| random | randomize | rnd | rand = 🔀 Caps Lock
| repeat | rpt = 🔁 Caps Lock
| repeat once | rpt1 = 🔂 Caps Lock
| reload | refresh = 🔄 Caps Lock
| reception = 📶 Caps Lock
| mute = 🔇 Caps Lock
| volume down | quieter = 🔉 Caps Lock
| volume up | louder = 🔊 Caps Lock
| home | house = ⌂ Caps Lock
{{{{#if: |subst:}}Button{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} – produces a similar visual effect but without the semantic markup (e.g. sample text); more for representing interface elements.
{{{{#if: |subst:}}Kbd{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} – to indicate user input (of any kind) without making it look like keys or buttons
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, {{#if:|}}{{varserif{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{2}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{3}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{4}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{5}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{6}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{7}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{8}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{9}}}}}}}{{#if:|}} should be used to ensure a noticeable distinction
To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{#if:|}}{{para{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{2}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{3}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{4}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{5}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{6}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{7}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{8}}}}}{{#if: |{{#if:|{{{1}}} }}|{{#if:|{{{1}}} }}{{{9}}}}}}}{{#if:|}} above
For indented blocks of material; visually identical to {{{{#if: |subst:}}quote{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||...}}}} but without quote markup
| shift lock = ⇪ Left shift
| second level lock | 2nd level lock | l2 lock
| level 2 lock = ⇫ Left shift
| capitals lock
| caps lock = ⇬ Left shift
| numeric lock = ⇭ Left shift
| num | num lock = Left shift ⇩
| third level lock | 3rd level lock | l3 lock
| level 3 lock = ⇯ Left shift
| generalized lock | generalised lock
| lock | general lock = ⇩ Left shift
| group lock = ⇰ Left shift
| scrolling
| scrolling lock = ⇳ Left shift
| scroll | scroll lock = Left shift ⇩
| pause = ⎉ Left shift
| break = ⎊ Left shift
| second level | 2nd level
| level 2 select | level 2 selector
| level 2 | shift = ⇧ Left shift
| alternate graphic | alt graph | alt graphic | alt grill
| alt car | alt char | right alt | ralt
| alt group | alternate group | altgroup
| altgr | alt gr
| third level | 3rd level
| level 3 select | level 3 selector
| level 3 = ⇮ Left shift
| group select | group selector
| group = ⇨ Left shift
| enter = ⌅ Left shift
| return = {{#switch:|thin|narrow=↵|thick|hollow=⏎|bend||#default=↩}} Left shift
| submit | send = ⎆ Left shift
| opt | option = ⌥ Left shift
| alternate | left alt | lalt
| alt = ⎇ Left shift
| greek = Left shift
| top = Left shift
| super = ❖ Left shift
| hyper = ✦ Left shift
| repeat = Left shift
| code = ⌃ Left shift
| graph = ⎇ Left shift
| meta = ◆ Left shift
| function | fn = Left shift
| backwards erase | erase
| backspace = {{#if:|⟵|⌫}} Left shift
| del | delete = ⌦ Left shift
| ins | insert = {{#if:|⎀|⌤}} Left shift
| clear input = ⌧ Clear
| esc | escape = ⎋ Left shift
| ctrl | control | helm = {{#if:|⎈|⌃}} Left shift
| os | vendor
| cmd | command = ⌘ Left shift
| windows | win = {{#if:|⊞|⌘}} Left shift
| apple = ⌘
| menu = ≣ Left shift
| cmp | compose = ⎄ Left shift
| /\ = ⇡ Up
| up | up arrow | move up = {{#if:|🔼|↑}} Left shift
| \/ = ⇣ Down
| down | down arrow | move down = {{#if:|🔽|↓}} Left shift
| <- = ⇠ Left
| left | left arrow | move left = {{#if:|◀|←}} Left shift
| -> = ⇢ Right
| right | right arrow | move right = {{#if:|▶|→}} Left shift
| north west | north-west | nw | <\
| top-left | top left = ↖
| south east | south-east | se | \>
| bottom-right | bottom right = ↘
| north east | north-east | ne | />
| top-right | top right = ↗
| south west | south-west | sw | </
| bottom-left | bottom left = ↙
| tabulator | htab | horizontal tab | horizontal tabulator
| tab = Left shift ↹
| right tab = Tab ⇥
| shift tab | left tab = ⇤ Tab
| vertical tab | vertical tabulator = ↨ Left shift
| pos1 | start
| home = {{#if:|↖|⇱}} Left shift
| end = {{#if:|↘|⇲}} Left shift
| line start = ⇤ Left shift
| line end = ⇥ Left shift
| page start | top = ⤒ Left shift
| page end | bottom = ⤓ Left shift
| page up | pgup | pg up = ⇞ Left shift
| page down
| pgdn | pgdown | pg down = ⇟ Left shift
| left page | prev page | prev. page = ⎗ Left shift
| previous page = ⎗ Left shift
| right page | next page = ⎘ Left shift
| prtscr | prt scr | prtsc | prt sc
| print, print screen = ⎙ Left shift
| clrscr | clr scr | cls | clr sc
| clear | clear screen = ⎚ Left shift
| play | playback | start playback
| scroll right = ▶ Left shift
| play reverse | reverse
| scroll left = ◀ Left shift
| play/pause | play pause = ⏯ Left shift
| pause | pause playback = ‖ Left shift
| stop = {{#if:|◼|■}} Left shift
| eject = ⏏ Left shift
| record = {{#if:|🔴|●}} Left shift
| fwd | forward = ⏭ Left shift
| skip | skip forward = ⏭ Left shift
| skip back | skip backward = ⏮ Left shift
| backward | backwards
| rewind = ⏪ Left shift
| ffad | fast forward = ⏩ Left shift
| downward | downwards = ⏬ Left shift
| skip down | scroll down = 🔽 Left shift
| upward | upwards = ⏫ Left shift
| skip up | scroll up = 🔼 Left shift
| random | randomize | rnd | rand = 🔀 Left shift
| repeat | rpt = 🔁 Left shift
| repeat once | rpt1 = 🔂 Left shift
| reload | refresh = 🔄 Left shift
| reception = 📶 Left shift
| mute = 🔇 Left shift
| volume down | quieter = 🔉 Left shift
| volume up | louder = 🔊 Left shift
| home | house = ⌂ Left shift
| initiator | phone star = ✲ Left shift
| terminator | phone hash = ⌗ Left shift
| times | multiply | num star = × Left shift
| divide | num slash = ÷ Left shift
| asterisk | star
| * = *
| hash | hash sign | pound | pound sign
| # = #
| colon
| : = :
| pipe symbol | vertical bar
| pipe = |
| semicolon = ;
| equals = =
| ex = ×
| circle = ○
| square = □
| triangle = △
| #default = Left shift
}}
Similar; includes more symbols, but does not directly support combinations