Sjabloon:Key press/doc
Sjabloon:Documentation subpage
This is the Sjabloon:Tl 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
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 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}}+ ⎇ Alt + ⌦ Del → ^ Ctrl + ⎇ Alt + ⌦ Del{{key press|Ctrl|Alt|Del|}}→ ^ 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):
{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}→ ⎇ 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 character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the Sjabloon:Tl, Sjabloon:Tl and Sjabloon:Tl templates or as an HTML entity |, ;, = respectively:
{{key press|→ |{{!}}}}{{key press||}}→ |{{key press|→ ;{{|}}}}{{key press|;}}→ ;{{key press|→ ={{=}}}}{{key press|=}}→ =
However, if the characters are marked as wikilinks, they can be entered as such:
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 (see also Arrows exception below).
{{key press|^Control}}→ ^ Control{{key press|Ctrl}}→ ^ Ctrl{{key press|Alt}}→ ⎇ Alt{{key press|Shift}}→ ⇧ Shift
{{key press|Esc}}→ ⎋ Esc{{key press|Tab}}→ Tab ↹{{key press|Enter}}→ ⌅ Enter{{key press|Return}}→ ⏎ Return{{key press|-Return}}→ ↵ Return
{{key press|Option}}→ ⌥ Option{{key press|Opt}}→ ⌥ Opt{{key press|Compose}}→ ⎄ Compose{{key press|Command}}→ ⌘ Command{{key press|Cmd}}→ ⌘ Cmd
{{key press|Ins}}→ ⌤ Ins{{key press|Del}}→ ⌦ Del{{key press|Backspace}}→ ⌫ Backspace
{{key press|Home}}→ ⇱ Home{{key press|End}}→ ⇲ End{{key press|PgUp}}→ ⇞ PgUp{{key press|PgDn}}→ ⇟ PgDn
{{key press|Num Lock}}→ Num ⇩{{key press|Caps Lock}}→ ⇬ Caps Lock{{key press|Scroll Lock}}→ Scroll ⇩
{{key press|Prt Scr}}→ ⎙ PrtScr{{key press|Prtsc}}→ ⎙ PrtScr{{key press|Pause}}→ ⎉ Pause{{key press|Break}}→ ⎊ Break
Windows and Menu keys
There are no characters for the Windows key and Menu key. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:
{{key press|Win}}→ ⌘ Win{{key press|Menu}}→ ≣ Menu
A key parameter
If "key" is included at the end of any template parameter, only a symbol and no text is output (see also Arrows exception below).
{{key press|^Control key}}→ ^{{key press|Ctrl key}}→ ^{{key press|Alt key}}→ ⎇{{key press|Shift key}}→ ⇧
{{key press|Esc key}}→ ⎋{{key press|Tab key}}→ ↹{{key press|Enter key}}→ ⌅{{key press|Return key}}→ ⏎{{key press|-Return key}}→ ↵
{{key press|Option key}}→ ⌥{{key press|Opt key}}→ ⌥{{key press|Compose key}}→ ⎄{{key press|Command key}}→ ⌘{{key press|Cmd key}}→ ⌘
{{key press|Ins key}}→ ⌤{{key press|Del key}}→ ⌦{{key press|Backspace key}}→ ⌫
{{key press|Home key}}→ ⇱{{key press|End key}}→ ⇲{{key press|PgUp key}}→ ⇞{{key press|PgDn key}}→ ⇟
{{key press|Num Lock key}}→ ⇭{{key press|Caps Lock key}}→ ⇬{{key press|Scroll Lock key}}→ ⇳
{{key press|Prt Scr key}}→ ⎙{{key press|Prtsc key}}→ ⎙{{key press|Pause key}}→ ⎉{{key press|Break key}}→ ⎊
Arrows exception
There is a little difference with arrow keys encoding. They are coded as:
{{key press|Up key}}→ ↑ Up{{key press|Down key}}→ ↓ Down{{key press|Left key}}→ ← Left{{key press|Right key}}→ → Right
{{key press|.Up}}→ ⇡ Up{{key press|.Down}}→ ⇣ Down{{key press|.Left}}→ ⇠ Left{{key press|.Right}}→ ⇢ Right
{{key press|Up}}→ ↑{{key press|Down}}→ ↓{{key press|Left}}→ ←{{key press|Right}}→ →
{{key press|.Up key}}→ ⇡{{key press|.Down key}}→ ⇣{{key press|.Left key}}→ ⇠{{key press|.Right key}}→ ⇢
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}}→ □
Technical details
This template calls Sjabloon:Tl, which holds the code that otherwise would be repeated several times in Sjabloon:Tl, thus simplifying the code.
TemplateData
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.
| Parameter | Beschrijving | Type | Status | |
|---|---|---|---|---|
| First key | 1 | First key | Regel | vereist |
| Second key | 2 | Optional key press in combination as the first. | Regel | optioneel |
| Third key | 3 | Optional key press in combination as the first. | Regel | optioneel |
| Forth key | 4 | Optional key press in combination as the first. | Regel | optioneel |
| Fifth key | 5 | Optional key press in combination as the first. | Regel | optioneel |
| Sixth key | 6 | Optional key press in combination as the first. | Regel | optioneel |
| Seventh key | 7 | Optional key press in combination as the first. | Regel | optioneel |
| Eighth key | 8 | Optional key press in combination as the first. | Regel | optioneel |
| Ninth key | 9 | Optional key press in combination as the first. | Regel | optioneel |
| Tenth key | 10 | Optional key press in combination as the first. | Regel | optioneel |
| Chaining character | chain | Character between chained key presses
| Regel | optioneel |
| Chaining character | chain first | Character between first and second key to press
| Regel | optioneel |
| Chaining character | chain second | Character between second and third key to press
| Regel | optioneel |
| Chaining character | chain third | Character between third and fourth key to press
| Regel | optioneel |
| Chaining character | chain fourth | Character between fourth and fifth key to press
| Regel | optioneel |
See also
- Sjabloon:Tl – For semantically indicating strong emphasis instead of simple typographical boldfacing.
- Sjabloon:Tl – Same as
{{strong}}but red like this: "Never use{{strongbad}}in articles." - Sjabloon:Tl – Same as
{{strongbad}}but green like this: "Only use{{stronggood}}on non-article pages." - Sjabloon:Tl – Similar template for semantically indicating mild emphasis instead of simple typographical italicization.
- Sjabloon:Tl – Same as Sjabloon:Tl use for all variables (e.g. strIllustratePrefix), except for "I" (upper-case i) and "l" (lower-case L), for which use Sjabloon:Tl.
- Sjabloon:Tl – Same as Sjabloon:Tl but uses serif font (e.g. strIllustratePrefix), especially for distinguishing between "I" (upper-case i) and "l" (lower-case L) as variables.
- Sjabloon:Tl – For displaying wikicode variables and magicwords as they would appear in source code, e.g.
{{PAGENAME}},{{DEFAULTSORT:Lastname, Firstname}}. - Sjabloon:Tl – For displaying wiki template parameters (
|title=) or parameters and values (|year=2008). - Sjabloon:Tl and related – For displaying entire templates (with or without parameters and values) as code.
- Sjabloon:Tl – For using HTML elements ("tags") in prose (e.g. "When coding HTML
<img>...</img>tags, always include …"). - Sjabloon:Tl – For computer source code (e.g. "always include the
<syntaxhighlight lang="text" enclose="none">alt=</syntaxhighlight>parameter"). (Note: to nest other templates like{{var}}inside, use<code>...</code>instead of{{code}}.) - Sjabloon:Tl or Sjabloon:Tl – Wrapper for
<syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text. - Sjabloon:Tl or Sjabloon:Tl – For deprecated source code in template documentation, articles on HTML specs, etc. (e.g. "do not use
<blink>...</blink> - Sjabloon:Tl – For larger blocks of source code and other pre-formatted text.
- Sjabloon:Tl – For indented blocks of content, such as block quotations, examples, poems, etc.
- Sjabloon:Tl – For indicating user input.
- Sjabloon:Tl – For indicating the input of specific keystrokes, e.g. ^ CtrlX.
- Sjabloon:Tl – For indicating PlayStation-style gamepad key presses, e.g. ×.
- Sjabloon:Tl – For example output.
Not to be confused with
- Sjabloon:Tl – Produces a similar visual effect, but without the semantic markup, e.g. sample text.
