View source for Global Lua Modules/Keys

<noinclude>{{LangSelect}}</noinclude><includeonly>{{Languages}}
{{Infobox Lua
| description = {{{description|This module implements the {{t|Keys}} template in Lua}}}
| type = invocable
| status = stable
| author = [[User:Majr|Majr]]
| code = Keys
| dependencies =
* [[Module:Keys/Symbols]]
* [[Module:Keys/Symbols/i18n]]
* [[Module:I18n]]
}}
{{{intro|{{t|Keys}} template is designed to illustrate keys and keystrokes on a keyboard. It can be used to show single keystrokes, combination keystrokes and a keystroke sequence.}}}

== {{i18n|getMsg|Documentation|installation}} ==
{{Lua Install}}

{{See also|{{{template-link|w:c:templates:module:Keys}}}}}

== {{i18n|getMsg|Documentation|usage}} ==
{{{usage-1|To show combination keystrokes, place pluses between each key.}}}
:<code><nowiki>{{keys|Alt+P}}</nowiki></code> {{{produces|produces}}} {{keys|Alt+P}}
:<code><nowiki>{{keys|Ctrl+Alt+Del}}</nowiki></code> {{{produces|produces}}} {{keys|Ctrl+Alt+Del}}

{{{usage-2|To show a keystroke sequence, use separate parameters. This can be combined with combination keystrokes.}}}
:<code><nowiki>{{keys|A|B|C|D}}</nowiki></code> {{{produces|produces}}} {{keys|A|B|C|D}}
:<code><nowiki>{{keys|Alt+0|1|7|7}}</nowiki></code> {{{produces|produces}}} {{keys|Alt+0|1|7|7}}
:<code><nowiki>{{keys|Alt+|0|1|7|7}}</nowiki></code> {{{produces|produces}}} {{keys|Alt+|0|1|7|7}}

{{{usage-3|Pluses on their own will be displayed as a key.}}}
:<code><nowiki>{{keys|1|+|2}}</nowiki></code> {{{produces|produces}}} {{keys|1|+|2}}
:<code><nowiki>{{keys|1+|+|+2}}</nowiki></code> {{{produces|produces}}} {{keys|1+|+|+2}}

== {{{shortcuts-header|Supported Named/Symbol shortcuts}}} ==

=== {{{arrow-keys-header|Arrow keys}}} ===
;<nowiki>{{key|</nowiki>{{{arrow-up|up}}}<nowiki>}}</nowiki>		:{{key|{{{arrow-up|up}}}}}
;<nowiki>{{key|</nowiki>{{{arrow-down|down}}}<nowiki>}}</nowiki>		:{{key|{{{arrow-down|down}}}}}
;<nowiki>{{key|</nowiki>{{{arrow-left|left}}}<nowiki>}}</nowiki>		:{{key|{{{arrow-left|left}}}}}
;<nowiki>{{key|</nowiki>{{{arrow-right|right}}}<nowiki>}}</nowiki>		:{{key|{{{arrow-right|right}}}}}

=== {{{other-keys-header|Other common keys}}} ===
;<nowiki>{{key|shift}}</nowiki>		:{{key|shift}}
;<nowiki>{{key|lshift}}</nowiki>	:{{key|lshift}}
;<nowiki>{{key|rshift}}</nowiki>	:{{key|rshift}}
;<nowiki>{{key|</nowiki>{{{enter|enter}}}<nowiki>}}</nowiki>		:{{key|{{{enter|enter}}}}}
;<nowiki>{{key|tab}}</nowiki>		:{{key|tab}}
;<nowiki>{{key|</nowiki>{{{backspace|backspace}}}<nowiki>}}</nowiki>	:{{key|{{{backspace|backspace}}}}}
;<nowiki>{{key|equals}}</nowiki>	:{{key|equals}}
;<nowiki>{{key|pipe}}</nowiki>		:{{key|pipe}}

=== {{{mac-only-keys-header|Mac-only keys}}} ===
;<nowiki>{{key|cmd}}</nowiki>		:{{key|cmd}}
;<nowiki>{{key|command}}</nowiki>	:{{key|command}}
;<nowiki>{{key|opt}}</nowiki>		:{{key|opt}}

=== {{{non-mac-keys-header|Non-Mac keys}}} ===
;<nowiki>{{key|</nowiki>{{{super|super}}}<nowiki>}}</nowiki>		:{{key|{{{super|super}}}}} ({{{super-key-note|also called “windows” Key}}})
;<nowiki>{{key|menu}}</nowiki>		:{{key|menu}}

=== {{{xbox-keys-header|Xbox Controller buttons}}} ===
;<nowiki>{{key|xb-a}}</nowiki>		:{{key|xb-a}}
;<nowiki>{{key|xb-b}}</nowiki>		:{{key|xb-b}}
;<nowiki>{{key|xb-x}}</nowiki>		:{{key|xb-x}}
;<nowiki>{{key|xb-y}}</nowiki>		:{{key|xb-y}}
;<nowiki>{{key|xb-lb}}</nowiki>		:{{key|xb-lb}} ({{{left-bumper|Left Bumper}}})
;<nowiki>{{key|xb-rb}}</nowiki>		:{{key|xb-rb}} ({{{right-bumper|Right Bumper}}})
;<nowiki>{{key|xb-lt}}</nowiki>		:{{key|xb-lt}} ({{{left-trigger|Left Trigger}}})
;<nowiki>{{key|xb-rt}}</nowiki>		:{{key|xb-rt}} ({{{right-trigger|Right Trigger}}})
;<nowiki>{{key|xb-back}}</nowiki>	:{{key|xb-back}}
;<nowiki>{{key|xb-start}}</nowiki>	:{{key|xb-start}}

{{{shortcuts-note|All other text used in this template will be used verbatim.}}}

[[Category:Template documentation|{{PAGENAME}}]]</includeonly>