Template:Keypress/doc

This template allows users to use in-line "keypress" formatting, for demonstrating which keyboard key(s) a user should press. There is currently no special key for mouse clicks.

Usage

At its most basic, the template can be used for regular keys by inserting the following: {{Keypress|W}}. The first parameter is the display text. The template takes two optional parameters, keyID and keyClass.

{{Keypress
|Display text (must be first!)
|keyID= the element ID. Optional
|keyClass= the element class, without the "key " prefix. Optional
}}

Parameters

Parameters	Description	Type	Required
1	The display text of the key. Will always display as uppercase. Must always be the first parameter!	any	yes
keyID	the element ID of the key, applies specific formatting to the background	css	no
keyClass	the element class of the key, applies specific formatting. Do not preface it with "key "	string	no

Examples

Key type	Template text	Result	Notes
Regular key	{{keypress|e}}	e	Background width is fixed
Modifier (Shift, Ctrl, Alt)	{{keypress|CTRL|keyID=control}}	CTRL
Spacebar	{{keypress|Space|keyID=key-spacebar}}	Space	Width is fixed
Function keys (F1-12, Esc)	{{Keypress|fn|keyID=fn}} {{Keypress|fn|keyClass=key-fn}}	fn fn	The keyClass method is flatter and wider than the top one.