Template:Key press/doc

From LIMSWiki
< Template:Key press
Revision as of 19:09, 23 September 2016 by Shawndouglas (talk | contribs) (Created as needed.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump 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

in → A

Keystroke combinations

To illustrate keystroke combinations, just use extra parameters:

in → Alt+P
in → 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:LIMSwiki 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:

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

in{{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:

in → 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:

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

  • in → Template:Pipe
  • in → |
  • in → ;
  • in → ;
  • in → =
  • in → =

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

  • in →
  • in → ;
  • in → =

Most markup characters also have aliases:

  • in → |
  • in → ;
  • in → =
  • in → :
  • in → *
  • in → #

Key symbols

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

  • in → ⇧ Shift
  • in → Tab ↹
  • in → ↵ Enter
  • in → ⌥ Option
  • in → ⌥ Opt
  • in → ⌘ Command
  • in → ⌘ Cmd
  • in → ⇪ Caps Lock
  • in → Scroll Lock
  • in →
  • in →
  • in →
  • in →
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 block:

  • in → ⊞ Win
  • in → ≣ 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.

  • in → L↓
  • in → C←
  • in → R↑

Stick specific diagonals are also supported:

  • in → L↖
  • in → C↘
  • in → R↗
PlayStation
  • in → ×
  • in →
  • in →
  • in →

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.

Key press

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

  • {{Button}}, which produces a similar visual effect but without the semantic markup (e.g. Template:Button).
  • {{Key top}}, which produces a similar visual effect, but includes more symbols and does not directly support key chaining (e.g. Template:Key top)