Template:Key press/doc

{{#ifeq:doc |doc

    | 

{{#ifeq:show |show

         | Mbox
        }}{{#if: |
         |   {{#ifexist:Template:Key press
                  | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  |
                 }}
        }}
    | 
   }}

{{#invoke:redirect hatnote|redirect|1}} {{#invoke:Lua banner|main}} Used in system

This is the 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

Tc → {{safesubst:#invoke:key|keypress}}

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:

Tc → {{safesubst:#invoke:key|keypress}}

Tc → {{safesubst:#invoke:key|keypress}}

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:

Tc + Tlc + Tlc → {{safesubst:#invoke:key|keypress}} + {{safesubst:#invoke:key|keypress}} + {{safesubst:#invoke:key|keypress}}

Tc → {{safesubst:#invoke:key|keypress}}

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 {{safesubst:#invoke:key|keypress}} key while typing 0177 with the Numeric keypad:

TcTlc → {{safesubst:#invoke:key|keypress}}{{safesubst:#invoke:key|keypress}}

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:

Tc → {{safesubst:#invoke:key|keypress}}

Wikilinks

If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:

• Tc → {{safesubst:#invoke:key|keypress}}

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[Alt key|Alt]] instead of [[Alt]], 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 Tlx, Tlx and Tlx templates or as an HTML entity |, &#59;, = respectively:

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

However, if the characters are marked as wikilinks, they can be entered as such:

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

Most markup characters also have aliases:

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

Key symbols

Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others.

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

File:AltGr Win Menu Ctrl key.jpg

Windows key and Menu key

File: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

1. REDIRECT Smallcaps2

R from template shortcut and

1. REDIRECT Smallcaps2

R from template shortcut from the Mathematical Operators Unicode block:

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

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.

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

Stick specific diagonals are also supported:

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

PlayStation

• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}
• Tc → {{safesubst:#invoke:key|keypress}}

TemplateData

TemplateDataHeader <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

• Tlx – 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 | front = 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

| initiator | phone star = ✲ Caps Lock | terminator | phone hash = ⌗ Caps Lock | times | multiply | num star = × Caps Lock | divide | num slash = ÷ Caps Lock | asterisk | star | * = * | hash | hash sign | pound | pound sign | # = # | colon | : = : | pipe symbol | vertical bar | pipe = | | semicolon = ; | equals = = | ex = × | circle = ○ | square = □ | triangle = △ | #default = Caps Lock }})

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

{{#invoke:Navbox|navbox}}