แม่แบบ:Key press

ไฟล์:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

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= + }} → 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

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 |, &#59;, = respectively:

• {{key press|{{pipe}}}} → |
• {{key press||}} → |
• {{key press|&#59;}} → ;
• {{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}} → →

ไฟล์:AltGr Win Menu Ctrl key.jpg

Windows key and Menu key

ไฟล์:Ctl wndws alt.jpg

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 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 for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Key press in articles based on its TemplateData.

TemplateData for Key press

<templatedata> { "description": { "en": "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.", "cs": "Ilustruje klávesy a úhozy na klávesnici počítače. Klávesy mohou zahrnovat: Ctrl, Alt, Del, Opt, Menu, Left atd. klávesy konzoly: ex, kruh, trojúhelník, čtverec a levá pravá a středová analogová páčka: l-dolů, c-left, r-ne. Jména nerozlišují malá a velká písmena." }, "params": { "1": { "label": { "en": "First key", "cs": "První klávesa" }, "description": { "en": "First key", "cs": "První klávesa" }, "type": "string/line", "required": true }, "2": { "label": { "en": "Second key", "cs": "Druhá klávesa" }, "description": { "en": "Optional key press in combination as the first.", "cs": "Volitelné stisknutí klávesy v kombinaci jako u první." }, "type": "string/line", "required": false }, "3": { "label": { "en": "Third key", "cs": "Třetí klávesa" }, "inherits": "2" }, "4": { "label": { "en": "Fourth key", "cs": "Čtvrtá klávesa" }, "inherits": "2" }, "5": { "label": { "en": "Fifth key", "cs": "Pátá klávesa" }, "inherits": "2" }, "6": { "label": { "en": "Sixth key", "cs": "Šestá klávesa" }, "inherits": "2" }, "7": { "label": { "en": "Seventh key", "cs": "Sedmá klávesa" }, "inherits": "2" }, "8": { "label": { "en": "Eighth key", "cs": "Osmá klávesa" }, "inherits": "2" }, "9": { "label": { "en": "Ninth key", "cs": "Devátá klávesa" }, "inherits": "2" }, "10": { "label": { "en": "Tenth key", "cs": "Desátá klávesa" }, "inherits": "2" }, "chain": { "label": { "en": "Chaining character", "cs": "Řetězcový znak" }, "description": { "en": "Character between chained key presses", "cs": "Znaky mezi současně stisknutými klávesami" }, "default": "+", "inherits": "2" }, "chain first": { "description": { "en": "Character between first and second key to press", "cs": "Znak mezi první a druhou stisknutou klávesou" }, "inherits": "chain" }, "chain second": { "description": { "en": "Character between second and third key to press", "cs": "Znak mezi druhou a třetí stisknutou klávesou" }, "inherits": "chain" }, "chain third": { "description": { "en": "Character between third and fourth key to press", "cs": "Znak mezi třetí a čtvrtou stisknutou klávesou" }, "inherits": "chain" }, "chain fourth": { "description": { "en": "Character between fourth and fifth key to press", "cs": "Znak mezi čtvrtou a pátou stisknutou klávesou" }, "inherits": "chain" } } } </templatedata>

See also

• {{Button}} – produces a similar visual effect but without the semantic markup (e.g. sample text); more for representing interface elements.)
• {{Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons

The above documentation is transcluded from แม่แบบ:Key press/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.