Template:Key press/doc

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


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
{{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: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= + }}
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:

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

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

Most markup characters also have aliases:

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

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:

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
ParameterDescriptionTypeDefaultAuto valueStatus
First key1First keylineemptyemptyrequired
Second key2Optional key press in combination as the first.lineemptyemptyoptional
Third key3Optional key press in combination as the first.lineemptyemptyoptional
Forth key4Optional key press in combination as the first.lineemptyemptyoptional
Fifth key5Optional key press in combination as the first.lineemptyemptyoptional
Sixth key6Optional key press in combination as the first.lineemptyemptyoptional
Seventh key7Optional key press in combination as the first.lineemptyemptyoptional
Eighth key8Optional key press in combination as the first.lineemptyemptyoptional
Ninth key9Optional key press in combination as the first.lineemptyemptyoptional
Tenth key10Optional key press in combination as the first.lineemptyemptyoptional
Chaining characterchainCharacter between chained key pressesline+emptyoptional
Chaining characterchain firstCharacter between first and second key to pressline+emptyoptional
Chaining characterchain secondCharacter between second and third key to pressline+emptyoptional
Chaining characterchain thirdCharacter between third and fourth key to pressline+emptyoptional
Chaining characterchain fourthCharacter between fourth and fifth key to pressline+emptyoptional

Not to be confused with

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