Lord DarkSide: Created page with "{{Documentation}} NOTOC This is the {{tl|key}} template primarily designed to illustrate keys and..."

2019-08-05T14:39:08Z

Created page with "{{Documentation}}  __NOTOC__ This is the {{tl|key}} template primarily designed to illustrate keys and..."

New page

{{Documentation}}

__NOTOC__

This is the {{tl|key}} 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
: <nowiki>{{key|A}}</nowiki> → {{key|A}}
As lower-case alphabetic characters a–z do not appear on keyboards, they should not be used as parameters.

===Keystroke combinations===
To illustrate keystroke combinations, just use extra parameters:
: <nowiki>{{key|Alt|P}}</nowiki> → {{key|Alt|P}}
: <nowiki>{{key|Ctrl|Alt|Del}}</nowiki> → {{key|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:
: <nowiki>{{key|Ctrl}} + {{key|key|Alt}} + {{key|key|Del}}</nowiki> → {{key|Ctrl}} + {{key|Alt}} + {{key|Del}}
: <nowiki>{{key|Ctrl|Alt|Del|5=chain=&#32;+&#32;}}</nowiki> → {{key|Ctrl|Alt|Del|chain= + }}

To illustrate sequences where all keys do not need to be pressed simultaneously, the plus signs can be ommitted 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 {{key|Alt}} key while typing <code>0177</code> with the numeric keypad:
: <nowiki>{{key|Alt|0}}{{key|1|7|7|chain{{=}}}}</nowiki> → {{key|Alt|0}}{{key|1|7|7|chain=}}

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:
: <nowiki>{{key|Ctrl|Alt|Shift|Win|Menu|fn|L}}</nowiki> → {{key|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|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key|[[Alt key|Alt]]}}

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, 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 {{key|!}}, {{key|;}} templates or as an HTML entity &#124;, &#59;, &#61; respectively:
* <nowiki>{{key|&#124;}}</nowiki> → {{key||}}
* <nowiki>{{key|&#59;}}</nowiki> → {{key|;}}
* <nowiki>{{key|&#61;}}</nowiki> → {{key|=}}

However, if the characters are marked as wikilinks, they can be entered as such:
* {{key|<nowiki>[[|]]</nowiki>}} → {{key|}}
* {{key|<nowiki>[[;]]</nowiki>}} → {{key|[[;]]}}
* {{key|<nowiki>[[=]]</nowiki>}} → {{key|[[=]]}}

Most markup characters also have aliases:
* <nowiki>{{key|pipe}}</nowiki> → {{key|pipe}}
* <nowiki>{{key|semicolon}}</nowiki> → {{key|semicolon}}
* <nowiki>{{key|equals}}</nowiki> → {{key|equals}}
* <nowiki>{{key|colon}}</nowiki> → {{key|colon}}
* <nowiki>{{key|asterisk}}</nowiki> → {{key|asterisk}}
* <nowiki>{{key|hash}}</nowiki> → {{key|hash}}

===Key symbols===
Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others.
* <nowiki>{{key|Shift}}</nowiki> → {{key|Shift}}
* <nowiki>{{key|Tab}}</nowiki> → {{key|Tab}}
* <nowiki>{{key|Enter}}</nowiki> → {{key|Enter}}
* <nowiki>{{key|Option}}</nowiki> → {{key|Option}}
* <nowiki>{{key|Opt}}</nowiki> → {{key|Opt}}
* <nowiki>{{key|Command}}</nowiki> → {{key|Command}}
* <nowiki>{{key|Cmd}}</nowiki> → {{key|Cmd}}
* <nowiki>{{key|Caps Lock}}</nowiki> → {{key|Caps Lock}}
* <nowiki>{{key|Scroll Lock}}</nowiki> → {{key|Scroll Lock}}
* <nowiki>{{key|Up}}</nowiki> → {{key|Up}}
* <nowiki>{{key|Down}}</nowiki> → {{key|Down}}
* <nowiki>{{key|Left}}</nowiki> → {{key|Left}}
* <nowiki>{{key|Right}}</nowiki> → {{key|Right}}

There are no characters for the Windows key and Menu key.
* <nowiki>{{key|Win}}</nowiki> → {{key|Win}}
* <nowiki>{{key|Menu}}</nowiki> → {{key|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.
* <nowiki>{{key|l-down}}</nowiki> → {{key|l-down}}
* <nowiki>{{key|c-left}}</nowiki> → {{key|c-left}}
* <nowiki>{{key|r-up}}</nowiki> → {{key|r-up}}

Stick specific diagonals are also supported:
* <nowiki>{{key|l-nw}}</nowiki> → {{key|l-nw}}
* <nowiki>{{key|c-se}}</nowiki> → {{key|c-se}}
* <nowiki>{{key|r-ne}}</nowiki> → {{key|r-ne}}

{{clear}}


[[Category:Computer keys|τ]]

Template:Key/Documentation - Revision history

Lord DarkSide: Created page with "{{Documentation}} __NOTOC__ This is the {{tl|key}} template primarily designed to illustrate keys and..."

Lord DarkSide: Created page with "{{Documentation}} NOTOC This is the {{tl|key}} template primarily designed to illustrate keys and..."