Template:Key top

From wikiNonStop

{{{1}}}

Template documentation


Usage

This template renders a key top as found on typewriters and computer keyboards including a standardized or common symbol if available, e.g. from ISO/IEC 9995-7. Keys for which there is an associated Wikipedia article are rendered with a hyperlink. Unlike {{key press}}, this template is not intended to be used for combinations of multiple keys, i.e. “keyboard shortcuts”. It shall be used in descriptions of the physical keys and their functions.

The first, mandatory parameter holds the “natural” key name which is used to select a symbol and link. Its contents is usually also output unchanged next to the symbol unless the second parameter is set to an explicit label, which most often will be blank to suppress the label. The third, also optional parameter, is a binary switch that toggles alternate representations of a very limited selection of symbols: vs. , vs. vs. , vs. , vs. and vs. 🔴.

Examples

in → ↩ return
in → ↩ Return
in → ↩ RETURN
in →
in → ⌅ Enter
in → ↩ Enter
in →
in →
in →
in →
in →
in →
in → ↵ Return
in → ⌃ Ctrl
in → ⎈ Ctrl
in → ⎇ Alt
in → ⌥ Option
in → ⌥ Alt
in → ⌘ Windows
in → ⌘ Command
in → ◆ Meta
in → ❖ Super
in → ⊞ Windows
in → ❖ Windows

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Key top

Display symbolic key tops as seen on computer keyboards, phones and typewriters.

Template parameters

ParameterDescriptionTypeStatus
name1

The standard or common name of the key.

Example
Shift
Linerequired
label2

Label for the key if different from the name, leave empty to suppress label.

Example
Level 2 Select
Lineoptional
alternate symbol3

Switch for certain alternate symbols (return, control, insert, stop, record)

Example
true
Booleanoptional

See also

  • {{Key press}} – produces a similar visual effect, but includes fewer symbols while directly supporting combinations (e.g. Ctrl+x)
  • {{Button}} – produces a similar visual effect but without the semantic markup (e.g. <span class="nowrap" title="<translate nowrap> This is not a clickable button; it illustrates the button one should find.</translate>" style="padding:.2em .6em; border:1px solid; border-color:#AAA #555 #555 #AAA; border-radius: 3px; background-color: #F2F2F2; background-image: linear-gradient(to bottom, #FCFCFC, #E0E0E0); ">sample text); more for representing interface elements.
  • {{Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons