Template:Key top/doc

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

{{key top|return}} → ↩ return

{{key top|Return}} → ↩ Return

{{key top|RETURN}} → ↩ RETURN

{{key top|Return|}} → ↩

{{key top|Enter}} → ⌅ Enter

{{key top|Return|Enter}} → ↩ Enter

{{key top|Return||}} → ↩

{{key top|Return|true}} → ↩

{{key top|Return|narrow}} → ↵

{{key top|Return|hollow}} → ⏎

{{key top|Return|thin}} → ↵

{{key top|Return|thick}} → ⏎

{{key top|Return|Return|narrow}} → ↵ Return

{{key top|Ctrl}} → ⌃ Ctrl

{{key top|Ctrl|3=true}} → ⎈ Ctrl

{{key top|Alt}} → ⎇ Alt

{{key top|Option}} → ⌥ Option

{{key top|Option|Alt}} → ⌥ Alt

{{key top|Windows}} → ⌘ Windows

{{key top|Command}} → ⌘ Command

{{key top|Meta}} → ◆ Meta

{{key top|Super}} → ❖ Super

{{key top|Windows|3=true}} → ⊞ Windows

{{key top|Super|Windows}} → ❖ Windows

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Key top in articles based on its TemplateData.

TemplateData for Key top

<templatedata> { "params": { "1": {"description": "The standard or common name of the key.", "label": "name", "type": "line", "example": "Shift", "required": true}, "2": {"description": "Label for the key if different from the name, leave empty to suppress label.", "label": "label", "type": "line", "example": "Level 2 Select", "required": false}, "3": {"description": "Switch for certain alternate symbols (return, control, insert, stop, record)", "label": "alternate symbol", "type": "boolean", "example": "true", "required": false} }, "description": "Display symbolic key tops as seen on computer keyboards, phones and typewriters." } </templatedata>

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. sample text); more for representing interface elements.
• {{Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons