Template:Key press
{{{1}}}
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, needs to be demonstrated with separate templates.
Example:
{{key press|A}}produces A
Keystroke combinations
To illustrate keystroke combinations, just use extra parameters:
{{key press|Alt|P}}produces Alt+P
{{key press|Ctrl|Alt|Del}}produces Ctrl+Alt+Del
This template currently handles up to 5 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:Saintapedia 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 "+" 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. Like this:
{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}produces 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). This could be illustrated like this:
{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}produces Alt+0177
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]]}}produces 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 characters
Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{=}} templates:
{{key press|{{!}}}}produces |
{{key press|{{;}}}}produces ;
{{key press|{{=}}}}produces =
However, if the characters are marked as wikilinks, they can be entered as such:
{{key press|[[|]]}}produces |
{{key press|[[;]]}}produces ;
{{key press|[[=]]}}produces =
If you don't want to mark the characters as links, {{key press|<nowiki>|</nowiki>}} is also an option.
Key symbols
Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names:
{{key press|Caps Lock}}produces ⇪ Caps Lock
{{key press|Shift}}produces ⇧ Shift
{{key press|Enter}}produces ↵ Enter
{{key press|Tab}}produces Tab ↹
{{key press|Backspace}}produces ← Backspace
{{key press|Cmd}}produces ⌘ Cmd
{{key press|Opt}}produces ⌥ Opt
{{key press|Up}}produces ↑
{{key press|Down}}produces ↓
{{key press|Left}}produces ←
{{key press|Right}}produces →
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}}produces ⊞ Win
{{key press|Menu}}produces ≣ Menu
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.
See also
- {{strong}} – For semantically indicating strong emphasis instead of simple typographical boldfacing.
- {{strongbad}} – Same as
{{strong}}but red like this: "Never use{{strongbad}}in articles." - {{stronggood}} – Same as
{{strongbad}}but green like this: "Only use{{stronggood}}on non-article pages." - {{em}} – Similar template for semantically indicating mild emphasis instead of simple typographical italicization.
- {{var}} – Same as {{varserif}} use for all variables (e.g. strIllustratePrefix), except for "I" (upper-case i) and "l" (lower-case L), for which use {{varserif}}.
- {{varserif}} – Same as {{var}} but uses serif font (e.g. strIllustratePrefix), especially for distinguishing between "I" (upper-case i) and "l" (lower-case L) as variables.
- {{wikivar}} – For displaying wikicode variables and magicwords as they would appear in source code, e.g.
{{PAGENAME}},{{DEFAULTSORT:Lastname, Firstname}}. - {{para}} – For displaying wiki template parameters (
|title=) or parameters and values (|year=2008). - {{tlx}} and related – For displaying entire templates (with or without parameters and values) as code.
- {{tag}} – For using HTML elements ("tags") in prose (e.g. "When coding HTML
<img>...</img>tags, always include …"). - {{code}} – For computer source code (e.g. "always include the
alt=parameter"). (Note: to nest other templates like{{var}}inside, use<code>...</code>instead of{{code}}.) - {{syntaxhighlight}} or {{sxhl}} – Wrapper for
<syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text. - {{deprecated code}} or {{dc}} – For deprecated source code in template documentation, articles on HTML specs, etc.
- {{pre}} – For larger blocks of source code and other pre-formatted text.
- {{bq}} – For indented blocks of content, such as block quotations, examples, poems, etc.
- {{kbd}} – For indicating user input.
- {{key press}} – For indicating the input of specific keystrokes, e.g. CtrlX.
- {{samp}} – For example output.
Not to be confused with
- {{Button}} – produces a similar visual effect, but without the semantic markup, e.g. sample text
- {{key box}}
Only Key 1 is required
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Key 1 | 1 | no description | Unknown | optional |
| Key 2 | 2 | no description | Unknown | optional |
| Key 3 | 3 | no description | Unknown | optional |
| Key 4 | 4 | no description | Unknown | optional |
| Key 5 | 5 | no description | Unknown | optional |