Template:Key: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 79: | Line 79: | ||
}}}} {{#var:key}}.png|alt={{#var:key}}|{{{size|50px}}}|{{{link|Controls}}}|{{#var:key}}]] }}<!-- | }}}} {{#var:key}}.png|alt={{#var:key}}|{{{size|50px}}}|{{{link|Controls}}}|{{#var:key}}]] }}<!-- | ||
-->{{#if: {{#var:keyboard}} | [[Controls|<kbd class="{{#switch: {{lc:{{{color}}}}} |black=black|white=white|blue=blue|orange=orange| | -->{{#if: {{#var:keyboard}} | [[Controls|<kbd class="{{#switch: {{lc:{{{color}}}}} |black=black|white=white|blue=blue|orange=orange|black}}"><!-- | ||
-->{{#switch:{{#var:keyboard}} | -->{{#switch:{{#var:keyboard}} |
Revision as of 08:52, 29 June 2022
When used, this template displays game controls, supporting both keyboard keys and controller buttons.
Usage
- Note: For a summary of possible console, key, and button values, see Template:Key/library.
Keyboard
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.
{{key | button }}
button
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.- Optional: there is an additional parameter,
color
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.
Example
This template's display is styled using the .dark
and .light
.blue
.orange
classes located in Template:Key/style.css.
Press {{Key|Shift|color=black}} and {{Key|F|color=blue|}} or {{Key|Shift|color=white}} and {{Key|F|color=orange|}} at the same time.
produces:
Press
⇧ Shift
and
or
and
at the same time.
Consoles and controllers
{{key | console | button | size = optional size }}
console
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.button
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
size
parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 50px.
Example
Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}}
to open your inventory wheel and select the item with
Changing the default color
The default color for the keyboard and mouse is suitable for light-skinned wikis. To change the default settings so it fits for a dark-skinned wiki, without having to use |color=light
each time, you can search for and change these sections in the template:
Search for: |#default = _White_Mouse_
...and change it to: |#default = _Black_Mouse_
<kbd class="{{#switch: {{lc:{{{color}}}}} |dark=dark|light=light|light}}">
...and change light at the end of the line to dark
.
This is located in Template:Key/style.css.
The above documentation is transcluded from Template:Key/doc. (edit | history)