Template:Key press

From Baystation 12
Jump to: navigation, search
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

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 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}} + {{key press|Alt}} + {{key press|Del}}Ctrl + Alt + Del
{{key press|Ctrl|Alt|Del|chain= + }}Ctrl + Alt + Del

On the other hand, to illustrate Windows wikipedia: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 wikipedia:plus-minus sign (±) can be entered by holding down the Alt key while typing 0177 (with the wikipedia: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).

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|Scroll Lock}}Scroll Lock
  • {{key press|Up}}
  • {{key press|Down}}
  • {{key press|Left}}
  • {{key press|Right}}
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 Template:Sc2 and Template:Sc2 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}}