Difference between revisions of "Template:Key/doc"
Jump to navigation
Jump to search
(Created page with "When used, this template displays game controls, supporting both keyboard keys and controller buttons. <!-- * Images used by this template are hosted at http://commons.gameped...") |
m (→Examples) |
||
Line 45: | Line 45: | ||
| keyboardvariant = light | | keyboardvariant = light | ||
}} | }} | ||
+ | </pre> | ||
Keyboard keys can be entered in shorthand like this: | Keyboard keys can be entered in shorthand like this: |
Revision as of 13:20, 15 July 2019
When used, this template displays game controls, supporting both keyboard keys and controller buttons.
- This template's display is styled using the
.keysDark
and.keysLight
classes located in MediaWiki:Common.css.
Usage
- Note: For a summary of possible console, key, and button values, see Template:Key/library.
Keyboard
{{key | keyboard key | keyboardvariant = dark or light }}
- The
keyboard key
parameter is the keyboard key to be pressed. - The
keyboardvariant
parameter is the graphic style and is not required - the template defaults todark
, rendering a white key with black text. Enterdark
for dark wikis, orlight
for light wikis.
Controller
{{key | console = console type | key = controller button | size = optional size }}
- The
console
parameter is used to state which console the key belongs to. The parameter is not case-sensitive. See Template:Key/library for possible values. - The
button
parameter is the button to be pressed, such as "A" or "Cross". Note that this template uses the registered trademark names, i.e. "cross" instead of "X" for Playstation buttons, but the template has alternative spellings and entries included. 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.
Examples
Keyboard
The keyboardvariant
parameter does not usually need to be entered explicitly. A default is generally set during a wiki's spinup. The parameter is used here to illustrate the two available versions.
{{key | keyboard = caps lock | keyboardvariant = dark }}
Or for light wikis:
{{key | keyboard = caps lock | keyboardvariant = light }}
Keyboard keys can be entered in shorthand like this: ⇪ Caps Lock
{{key|caps lock}}