Template:Key/doc

This is a documentation subpage for Template:Key.
It contains usage information, categories and other content that is not part of the original template page.

This template uses Module:Key, a script written in Lua.
Please see wikipedia:wp:Lua and mw:Extension:Scribunto to learn more.

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|A}} → A

As lower-case alphabetic characters a–z do not appear on keyboards, they should not be used as parameters.

Keystroke combinations

To illustrate keystroke combinations, just use extra parameters:

{{key|Alt|P}} → Alt+P

{{key|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|Ctrl}} + {{key|Alt}} + {{key|Del}} → Ctrl + Alt + Del

{{key|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 ommitted 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|Alt|0}}{{key|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|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|[[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 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|{{!}}}} → |
• {{key||}} → |
• {{key|{{;}}}} → ;
• {{key|&#59;}} → ;
• {{key|{{=}}}} → =
• {{key|=}} → =

Most markup characters also have aliases:

• {{key|pipe}} → |
• {{key|semicolon}} → ;
• {{key|equals}} → =
• {{key|colon}} → :
• {{key|asterisk}} → *
• {{key|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|Shift}} → ⇧ Shift
• {{key|Tab}} → Tab ↹
• {{key|Enter}} → ↵ Enter
• {{key|Option}} → ⌥ Option
• {{key|Opt}} → ⌥ Opt
• {{key|Command}} → ⌘ Command
• {{key|Cmd}} → ⌘ Cmd
• {{key|Caps Lock}} → ⇪ Caps Lock
• {{key|Up}} → ↑
• {{key|Down}} → ↓
• {{key|Left}} → ←
• {{key|Right}} → →

Windows key and Menu key

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|Win}} → ⊞ Win
• {{key|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|l-down}} → L↓
• {{key|c-left}} → C←
• {{key|r-up}} → R↑

Stick specific diagonals are also supported:

• {{key|l-nw}} → L↖
• {{key|c-se}} → C↘
• {{key|r-ne}} → R↗

PlayStation

• {{key|ex}} → ×
• {{key|circle}} → ○
• {{key|triangle}} → △
• {{key|square}} → □

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.

Template parameters

Parameter		Description	Type	Status
First key	1	First key	Line	required
Second key	2	Optional key press in combination as the first.	Line	optional
Third key	3	Optional key press in combination as the first.	Line	optional
Fourth key	4	Optional key press in combination as the first.	Line	optional
Fifth key	5	Optional key press in combination as the first.	Line	optional
Sixth key	6	Optional key press in combination as the first.	Line	optional
Seventh key	7	Optional key press in combination as the first.	Line	optional
Eighth key	8	Optional key press in combination as the first.	Line	optional
Ninth key	9	Optional key press in combination as the first.	Line	optional
Tenth key	10	Optional key press in combination as the first.	Line	optional
Chaining character	chain	Character between chained key presses Default +	Line	optional
Chaining character	chain first	Character between first and second key to press Default +	Line	optional
Chaining character	chain second	Character between second and third key to press Default +	Line	optional
Chaining character	chain third	Character between third and fourth key to press Default +	Line	optional
Chaining character	chain fourth	Character between fourth and fifth key to press Default +	Line	optional