Template:Key press/doc

From blackwiki
< Template:Key press
Revision as of 17:20, 4 May 2014 by imported>Codename Lisa (Deleted items that are no longer support by the core template. (They don't render.))
Jump to navigation Jump to search


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

This template currently handles up to 10 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:Wikipedia 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 "+" (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=&#32;+&#32;}}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):

{{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).

Wiki markup characters

Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{=}} templates or as an HTML entity &#124;, &#59;, &#61; respectively:

  • {{key press|{{!}}}}|
  • {{key press|{{|}}}};
  • {{key press|{{=}}}}=

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

  • {{key press|[[|]]}}|
  • {{key press|[[;]]}};
  • {{key press|[[=]]}}=

Key symbols

Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others (see also Arrows exception below).

  • {{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

}}

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. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:

  • {{key press|Win}}⊞ Win
  • {{key press|Menu}}≣ Menu
A key parameter

If "key" is included at the end of any template parameter, only a symbol and no text is output (see also Arrows exception below).

2
The unnamed parameter 2= is no longer supported. Please see the documentation for {{columns-list}}.
  • {{key press|^Control key}}^Control key
  • {{key press|Ctrl key}}Ctrl key
  • {{key press|Alt key}}Alt key
  • {{key press|Shift key}}Shift key
  • {{key press|Esc key}}Esc key
  • {{key press|Tab key}}Tab key
  • {{key press|Enter key}}Enter key
  • {{key press|Return key}}Return key
  • {{key press|-Return key}}-Return key
  • {{key press|Option key}}Option key
  • {{key press|Opt key}}Opt key
  • {{key press|Compose key}}Compose key
  • {{key press|Command key}}Command key
  • {{key press|Cmd key}}Cmd key
  • {{key press|Ins key}}Ins key
  • {{key press|Del key}}Del key
  • {{key press|Backspace key}}Backspace key
  • {{key press|Home key}}Home key
  • {{key press|End key}}End key
  • {{key press|PgUp key}}PgUp key
  • {{key press|PgDn key}}PgDn key
  • {{key press|Num Lock key}}Num Lock key
  • {{key press|Caps Lock key}}Caps Lock key
  • {{key press|Scroll Lock key}}Scroll Lock key
  • {{key press|Prt Scr key}}Prt Scr key
  • {{key press|Prtsc key}}Prtsc key
  • {{key press|Pause key}}Pause key
  • {{key press|Break key}}Break key
Arrows exception

There is a little difference with arrow keys encoding. They are coded as:

2
The unnamed parameter 2= is no longer supported. Please see the documentation for {{columns-list}}.
  • {{key press|Up key}}Up key
  • {{key press|Down key}}Down key
  • {{key press|Left key}}Left key
  • {{key press|Right key}}Right key
  • {{key press|.Up}}.Up
  • {{key press|.Down}}.Down
  • {{key press|.Left}}.Left
  • {{key press|.Right}}.Right
  • {{key press|Up}}
  • {{key press|Down}}
  • {{key press|Left}}
  • {{key press|Right}}
  • {{key press|.Up key}}.Up key
  • {{key press|.Down key}}.Down key
  • {{key press|.Left key}}.Left key
  • {{key press|.Right key}}.Right key

Lua error: Internal error: The interpreter has terminated with signal "24".

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}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|c-left}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|r-up}}Lua error: Internal error: The interpreter has terminated with signal "24".

Stick specific diagonals are also supported:

  • {{key press|l-nw}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|c-se}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|r-ne}}Lua error: Internal error: The interpreter has terminated with signal "24".
PlayStation
  • {{key press|ex}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|circle}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|triangle}}Lua error: Internal error: The interpreter has terminated with signal "24".
  • {{key press|square}}Lua error: Internal error: The interpreter has terminated with signal "24".

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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Key press

Lua error: Internal error: The interpreter has terminated with signal "24".

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

ParameterDescriptionTypeStatus
First key1

First key

Linerequired
Second key2

Optional key press in combination as the first.

Lineoptional
Third key3

Optional key press in combination as the first.

Lineoptional
Forth key4

Optional key press in combination as the first.

Lineoptional
Fifth key5

Optional key press in combination as the first.

Lineoptional
Sixth key6

Optional key press in combination as the first.

Lineoptional
Seventh key7

Optional key press in combination as the first.

Lineoptional
Eighth key8

Optional key press in combination as the first.

Lineoptional
Ninth key9

Optional key press in combination as the first.

Lineoptional
Tenth key10

Optional key press in combination as the first.

Lineoptional
Chaining characterchain

Character between chained key presses

Default
+
Lineoptional
Chaining characterchain first

Character between first and second key to press

Default
+
Lineoptional
Chaining characterchain second

Character between second and third key to press

Default
+
Lineoptional
Chaining characterchain third

Character between third and fourth key to press

Default
+
Lineoptional
Chaining characterchain fourth

Character between fourth and fifth key to press

Default
+
Lineoptional

See also

Template:Var/seealso

Not to be confused with

  • {{Button}} – Produces a similar visual effect, but without the semantic markup, e.g. sample text.