Template:Key/doc: Difference between revisions
m (1 revision imported) |
No edit summary |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
|||
{{doc/start}} |
|||
{{Lua|Module:Key}} |
|||
When used, this template displays game controls, supporting both keyboard keys and controller buttons. |
|||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE END OF THIS PAGE. --> |
|||
* Images used by this template are hosted at http://commons.gamepedia.com. |
|||
__NOTOC__ |
|||
* This template's display is styled using the <code>.keysDark</code> and <code>.keysLight</code> classes located in [[MediaWiki:Common.css]]. |
|||
This is the {{tl|key press}} template primarily designed to illustrate keys and keystrokes on a [[w:computer keyboard|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. |
|||
== Usage == |
|||
* '''Note:''' For a summary of possible console, key, and button values, see [[Template:Key/library]]. |
|||
Example |
|||
=== Keyboard === |
|||
: {{tc|key|A}} → {{key|A}} |
|||
If using the template for keyboard keys, there is only one required input. For mouse usage, see the [[#Consoles and controllers]], using "mouse" as the console. |
|||
As lower-case alphabetic characters a–z do not appear on keyboards, they should not be used as parameters. |
|||
===Keystroke combinations=== |
|||
'''<code><nowiki>{{</nowiki>key | ''button'' <nowiki>}}</nowiki></code>''' |
|||
To illustrate keystroke combinations, just use extra parameters: |
|||
* <code>button</code> is the keyboard key to be pressed. Some key inputs, such as Shift or Tab will automatically add symbols or other formatting. Any other inputs will be output as they are with the first letter capitalized. |
|||
: {{tc|key|Alt|P}} → {{key|Alt|P}} |
|||
* ''Optional'': there is an additional parameter, <code>keyboardvariant</code> which determines whether the key is dark text on a light key (default) or the inverse. This will likely never be used, and if a wiki would prefer light on dark, it should be changed as the default. |
|||
: {{tc|key|Ctrl|Alt|Del}} → {{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: |
|||
====Example==== |
|||
: {{tc|key|Ctrl}} + {{tlc|key|Alt}} + {{tlc|key|Del}} → {{key|Ctrl}} + {{key|Alt}} + {{key|Del}} |
|||
<pre>Press {{Key|Shift}} and {{Key|F}} at the same time.</pre> |
|||
: {{tc|key|Ctrl|Alt|Del|5=chain=&#32;+&#32;}} → {{key|Ctrl|Alt|Del|chain= + }} |
|||
produces:<br/> |
|||
Press {{Key|Shift}} and {{Key|F}} at the same time. |
|||
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, [[w:Alt code|Alt code]]s can be used to insert the [[w:plus-minus sign|plus-minus sign]] (±) by holding down the {{key|Alt}} key while typing <code>0177</code> with the [[w:numeric keypad|numeric keypad]]: |
|||
=== Consoles and controllers === |
|||
: {{tc|key|Alt|0}}{{tlc|key|1|7|7|chain{{=}}}} → {{key|Alt|0}}{{key|1|7|7|chain=}} |
|||
'''<code><nowiki>{{</nowiki>key | ''console'' | ''button'' | size = ''optional size'' <nowiki>}}</nowiki></code>''' |
|||
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: |
|||
* <code>console</code> is the console the key belongs to. The parameter is '''not''' case-sensitive and supports many possible consoles. See [[Template:Key/library]] for possible values. |
|||
: {{tc|key|Ctrl|Alt|Shift|Win|Menu|fn|L}} → {{key|Ctrl|Alt|Shift|Win|Menu|fn|L}} |
|||
* <code>button</code> is the button to be pressed, such as "A" or "Right Trigger". While the template tries to be intuitive such that the correct input for a button is whatever you think it is, if your attempt at a button isn't working, see [[Template:Key/library]] for possible values. |
|||
* The <code>size</code> parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 20px. |
|||
=== |
===Wikilinks=== |
||
If there is an article about the key you can [[w:wikilink|wikilink]] the key's name like any other wiki text. Like this: |
|||
<pre>Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}}</pre> |
|||
* {{tc|key|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key|[[w:Alt key|Alt]]}} |
|||
produces:<br/> |
|||
Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}} |
|||
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 [[w:Disambiguation page|disambiguation page]]). |
|||
== Changing the default color == |
|||
The default color for the keyboard and mouse is suitable for dark-skinned wikis. To change the default settings so it fits for a light-skinned wiki, without having to use <code>keyboardvariant = light</code> each time, you can search for and change these sections in the template: |
|||
===Wiki markup characters=== |
|||
Some wiki markup characters, like the [[w:pipe symbol|pipe symbol]], the [[w:semicolon|semicolon]] and the [[w:equals sign|equals sign]], need to be entered using the {{tlx|!}}, {{tlx|;}} and {{tlx|{{=}}}} templates or as an [[w:HTML entity|HTML entity]] &#124;, &#59;, &#61; respectively: |
|||
* {{tc|key|{{tc|!}}}} → {{key|{{!}}}} |
|||
* {{tc|key|&#124;}} → {{key||}} |
|||
* {{tc|key|{{tc|;}}}} → {{key|{{;}}}} |
|||
* {{tc|key|&#59;}} → {{key|;}} |
|||
* {{tc|key|{{tc|=}}}} → {{key|{{=}}}} |
|||
* {{tc|key|&#61;}} → {{key|=}} |
|||
Most markup characters also have aliases: |
|||
Search for: <code>|#default = _White_Mouse_</code><br/> |
|||
* {{tc|key|pipe}} → {{key|pipe}} |
|||
...and change it to: <code>|#default = _Black_Mouse_</code> |
|||
* {{tc|key|semicolon}} → {{key|semicolon}} |
|||
* {{tc|key|equals}} → {{key|equals}} |
|||
* {{tc|key|colon}} → {{key|colon}} |
|||
* {{tc|key|asterisk}} → {{key|asterisk}} |
|||
* {{tc|key|hash}} → {{key|hash}} |
|||
===Key symbols=== |
|||
Some key names have a fitting [[w:Unicode|Unicode]] character. This template automatically adds such "icons" to the following key names among others. |
|||
* {{tc|key|Shift}} → {{key|Shift}} |
|||
* {{tc|key|Tab}} → {{key|Tab}} |
|||
* {{tc|key|Enter}} → {{key|Enter}} |
|||
* {{tc|key|Option}} → {{key|Option}} |
|||
* {{tc|key|Opt}} → {{key|Opt}} |
|||
* {{tc|key|Command}} → {{key|Command}} |
|||
* {{tc|key|Cmd}} → {{key|Cmd}} |
|||
* {{tc|key|Caps Lock}} → {{key|Caps Lock}} |
|||
* {{tc|key|Up}} → {{key|Up}} |
|||
* {{tc|key|Down}} → {{key|Down}} |
|||
* {{tc|key|Left}} → {{key|Left}} |
|||
* {{tc|key|Right}} → {{key|Right}} |
|||
[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]] |
|||
[[File:Ctl wndws alt.jpg|thumb|200px|Old-style Windows key]] |
|||
There are no characters for the [[w:Windows key|Windows key]] and [[w:Menu key|Menu key]]. So this template shows approximate characters for them, namely the SQUARED PLUS and STRICTLY EQUIVALENT TO from the [[w:Mathematical Operators|Mathematical Operators]] Unicode block: |
|||
* {{tc|key|Win}} → {{key|Win}} |
|||
* {{tc|key|Menu}} → {{key|Menu}} |
|||
====Video games==== |
|||
Search for: <code><nowiki><kbd class="{{#switch: {{lc:{{{keyboardvariant}}}}} |dark=keysDark|light=keysLight|</nowiki><div style="color: #00ff00;">keysDark</div>}}"></code><br/> |
|||
Video game controllers often have specialized input labels that do not map easily. The following are mappings for various game consoles and input features. |
|||
...and change ''keysDark'' at the end of the line to <code>''keysLight''</code>. |
|||
=====Directional input===== |
|||
{{doc/end}} |
|||
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices. |
|||
* {{tc|key|l-down}} → {{key|l-down}} |
|||
* {{tc|key|c-left}} → {{key|c-left}} |
|||
* {{tc|key|r-up}} → {{key|r-up}} |
|||
Stick specific diagonals are also supported: |
|||
* {{tc|key|l-nw}} → {{key|l-nw}} |
|||
* {{tc|key|c-se}} → {{key|c-se}} |
|||
* {{tc|key|r-ne}} → {{key|r-ne}} |
|||
=====PlayStation===== |
|||
* {{tc|key|ex}} → {{key|ex}} |
|||
* {{tc|key|circle}} → {{key|circle}} |
|||
* {{tc|key|triangle}} → {{key|triangle}} |
|||
* {{tc|key|square}} → {{key|square}} |
|||
{{clear}} |
|||
===TemplateData=== |
|||
<templatedata> |
|||
{ |
|||
"description": "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.", |
|||
"params": { |
|||
"1": { |
|||
"label": "First key", |
|||
"description": "First key", |
|||
"type": "string/line", |
|||
"required": true |
|||
}, |
|||
"2": { |
|||
"label": "Second key", |
|||
"description": "Optional key press in combination as the first.", |
|||
"type": "string/line", |
|||
"required": false |
|||
}, |
|||
"3": { |
|||
"label": "Third key", |
|||
"inherits": "2" |
|||
}, |
|||
"4": { |
|||
"label": "Fourth key", |
|||
"inherits": "2" |
|||
}, |
|||
"5": { |
|||
"label": "Fifth key", |
|||
"inherits": "2" |
|||
}, |
|||
"6": { |
|||
"label": "Sixth key", |
|||
"inherits": "2" |
|||
}, |
|||
"7": { |
|||
"label": "Seventh key", |
|||
"inherits": "2" |
|||
}, |
|||
"8": { |
|||
"label": "Eighth key", |
|||
"inherits": "2" |
|||
}, |
|||
"9": { |
|||
"label": "Ninth key", |
|||
"inherits": "2" |
|||
}, |
|||
"10": { |
|||
"label": "Tenth key", |
|||
"inherits": "2" |
|||
}, |
|||
"chain": { |
|||
"label": "Chaining character", |
|||
"description": "Character between chained key presses", |
|||
"default": "+", |
|||
"inherits": "2" |
|||
}, |
|||
"chain first": { |
|||
"description": "Character between first and second key to press", |
|||
"inherits": "chain" |
|||
}, |
|||
"chain second": { |
|||
"description": "Character between second and third key to press", |
|||
"inherits": "chain" |
|||
}, |
|||
"chain third": { |
|||
"description": "Character between third and fourth key to press", |
|||
"inherits": "chain" |
|||
}, |
|||
"chain fourth": { |
|||
"description": "Character between fourth and fifth key to press", |
|||
"inherits": "chain" |
|||
} |
|||
} |
|||
} |
|||
</templatedata> |
|||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
|||
[[Category:Formatting templates]] |
|||
}}</includeonly> |
Latest revision as of 22:08, 15 December 2019
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|A}}
→ 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:
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:
{{key|Ctrl}}
+{{key|Alt}}
+{{key|Del}}
→ Ctrl + Alt + Del{{key|Ctrl|Alt|Del|chain= + }}
→ Ctrl + Alt + Del
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 Alt key while typing 0177
with the numeric keypad:
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|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 characters, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}
, {{;}}
and {{=}}
templates or as an HTML entity |, ;, = respectively:
{{key|
→ |{{!}}
}}{{key||}}
→ |{{key|
→ ;{{;}}
}}{{key|;}}
→ ;{{key|
→ ={{=}}
}}{{key|=}}
→ =
Most markup characters also have aliases:
{{key|pipe}}
→ |{{key|semicolon}}
→ ;{{key|equals}}
→ ={{key|colon}}
→ :{{key|asterisk}}
→ *{{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.
{{key|Shift}}
→ ⇧ Shift{{key|Tab}}
→ Tab ↹{{key|Enter}}
→ ↵ Enter{{key|Option}}
→ ⌥ Option{{key|Opt}}
→ ⌥ Opt{{key|Command}}
→ ⌘ Command{{key|Cmd}}
→ ⌘ Cmd{{key|Caps Lock}}
→ ⇪ Caps Lock{{key|Up}}
→ ↑{{key|Down}}
→ ↓{{key|Left}}
→ ←{{key|Right}}
→ →
![](http://static.miraheze.org/phereonwiki/thumb/3/3f/AltGr_Win_Menu_Ctrl_key.jpg/200px-AltGr_Win_Menu_Ctrl_key.jpg)
![](http://static.miraheze.org/phereonwiki/thumb/1/1e/Ctl_wndws_alt.jpg/200px-Ctl_wndws_alt.jpg)
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 Unicode block:
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[]
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.
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
| Line | optional |
Chaining character | chain first | Character between first and second key to press
| Line | optional |
Chaining character | chain second | Character between second and third key to press
| Line | optional |
Chaining character | chain third | Character between third and fourth key to press
| Line | optional |
Chaining character | chain fourth | Character between fourth and fifth key to press
| Line | optional |