Template:Keypress/doc: Difference between revisions

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: <code><nowiki>{{Keypress|W}}</nowiki></code>. The first parameter is the display text. The template takes two optional parameters, keyID and keyClass.

=== Parameters ===

| 1 || The display text of the key. Will always display as uppercase. Must always be the '''first parameter'''! || any || yes

=== Examples ===

! Key type !! Template text !! Result !! Notes

| Regular key || <code><nowiki>{{keypress|e}}</nowiki></code> || {{keypress|e}} || Background width is fixed

| Modifier (Shift, Ctrl, Alt) || <code><nowiki>{{keypress|CTRL|keyID=control}}</nowiki></code> || {{keypress|CTRL|keyID=control}} || 

| Spacebar || <code><nowiki>{{keypress|Space|keyID=key-spacebar}}</nowiki></code> || {{keypress|Space|keyID=key-spacebar}} || Width is fixed

| Function keys (F1-12, Esc) || <code><nowiki>{{Keypress|fn|keyID=fn}}</nowiki></code><br/><code><nowiki>{{Keypress|fn|keyClass=key-fn}}</nowiki></code> || {{Keypress|fn|keyID=fn}}<br/>{{Keypress|fn|keyClass=key-fn}} || The '''keyClass''' method is flatter and wider than the top one.

<!--e.g. [[Category:Notice templates]] or [[Category:Navbox templates]] or whatever-->

[[Category:Formatting templates]]