Template:Key press
Template documentation
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
- Template:key press (talk links edit) → A
Keystroke combinations
To illustrate keystroke combinations, just use extra parameters:
- Template:key press (talk links edit) → Alt+P
- Template:key press (talk links edit) → 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:WikiDevi 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 then that might cause too wide items. Then instead manually build the key combination with spaces around the "+" so it can line wrap:
- Template:key press (talk links edit) + Template:key press (talk links edit) + Template:key press (talk links edit) → Ctrl + Alt + Del
- Template:key press (talk links edit) → 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):
- Template:key press (talk links edit)Template:key press (talk links edit)Template:key press (talk links edit)Template:key press (talk links edit) → 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:
- Template:Key press (talk links edit) → 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:
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 character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{}} templates or as an HTML entity |, ;, = respectively:
- Template:key press (talk links edit) → |
- Template:key press (talk links edit) → |
- Template:key press (talk links edit) → Template:;
- Template:key press (talk links edit) → ;
- Template:key press (talk links edit) → =
- Template:key press (talk links edit) → =
However, if the characters are marked as wikilinks, they can be entered as such:
- Template:key press (talk links edit) → |
- Template:key press (talk links edit) → ;
- Template:key press (talk links edit) → =
Most markup characters also have aliases:
- Template:key press (talk links edit) → |
- Template:key press (talk links edit) → ;
- Template:key press (talk links edit) → =
- Template:key press (talk links edit) → :
- Template:key press (talk links edit) → *
- Template:key press (talk links edit) → #
Key symbols
Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others (see also Arrows exception below).
- Template:key press (talk links edit) → ⇧ Shift
- Template:key press (talk links edit) → Tab ↹
- Template:key press (talk links edit) → ↵ Enter
- Template:key press (talk links edit) → ⌥ Option
- Template:key press (talk links edit) → ⌥ Opt
- Template:key press (talk links edit) → ⌘ Command
- Template:key press (talk links edit) → ⌘ Cmd
- Template:key press (talk links edit) → ⇪ Caps Lock
- Template:key press (talk links edit) → Scroll Lock
- Template:key press (talk links edit) → ↑
- Template:key press (talk links edit) → ↓
- Template:key press (talk links edit) → ←
- Template:key press (talk links edit) → →
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:
- Template:key press (talk links edit) → ⊞ Win
- Template:key press (talk links edit) → ≣ 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.
- Template:key press (talk links edit) → L↓
- Template:key press (talk links edit) → C←
- Template:key press (talk links edit) → R↑
Stick specific diagonals are also supported:
- Template:key press (talk links edit) → L↖
- Template:key press (talk links edit) → C↘
- Template:key press (talk links edit) → R↗
PlayStation
- Template:key press (talk links edit) → ×
- Template:key press (talk links edit) → ○
- Template:key press (talk links edit) → △
- Template:key press (talk links edit) → □
Technical details
This template calls {{key press/core}}, which holds the code that otherwise would be repeated several times in {{key press}}, thus simplifying the code.
TemplateData
See the monthly error report for this template.
TemplateData for Key press
See also
- {{Button}}, which produces a similar visual effect but without the semantic markup (e.g. Template:Button).
| The above documentation is transcluded from Template:Key press/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
