வார்ப்புரு:Key press

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Key

This template uses TemplateStyles:

Template:Key press/styles.css

This template is used in MediaWiki:Clearyourcache.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

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

வார்ப்புரு:Tc → A

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

Keystroke combinations[தொகு]

To illustrate keystroke combinations, just use extra parameters:

வார்ப்புரு:Tc → Alt+P

வார்ப்புரு:Tc → 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:

வார்ப்புரு:Tc + {{key press|Alt}} + {{key press|Del}} → Ctrl + Alt + Del

வார்ப்புரு:Tc → Ctrl + Alt + Del

To illustrate sequences where all keys do not need to be pressed simultaneously, the plus signs can be omitted 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:

வார்ப்புரு:Tc{{key press|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:

வார்ப்புரு:Tc → 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:

வார்ப்புரு:Tc → Alt

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[Alt key|Alt]] instead of [[Alt]], 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 {{!}} ({{Pipe}}), {{;}} and {{=}} templates or as an HTML entity | (|), ; (;), = (=) respectively:

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

Most markup characters also have alias templates:

Key symbols[தொகு]

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

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 வார்ப்புரு:Sc2 and வார்ப்புரு:Sc2 from the Mathematical Operators Unicode block:

வார்ப்புரு:Tc → ⊞ Win
வார்ப்புரு:Tc → ≣ Menu

In some cases, the automatic recognition of tokens and consequently the addition of symbols may not be desired; in these cases the token recognition can be suppressed by HTML encoding the text, e.g. {{key press|Enter}} will give Enter (plain text) instead of ↵ Enter (token).

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.

Stick specific diagonals are also supported:

PlayStation[தொகு]

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

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