Template:Key top - 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 → ↵ 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
Parameter		Description	Type	Status
name	`1`	The standard or common name of the key. Example Shift	Line	required
label	`2`	Label for the key if different from the name, leave empty to suppress label. Example Level 2 Select	Line	optional
alternate symbol	`3`	Switch for certain alternate symbols (return, control, insert, stop, record) Example true	Boolean	optional

{{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

Semantic markup templates

Template	Example output	Use
{{strong}}	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}}	"Never use ..."	Same as {{strong}} but in red
{{stronggood}}	"Only use ..."	Same as {{strong}} but in green
{{em}}	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}}	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}}	`strIllustratePrefix`	(see {{var}} above)
{{tld}}	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
{{para}}	`\|year=2008`	To display template parameters with or without values
{{param}}	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}}	\|selfref=yes	To display template parameters with colors (as they would appear in the {{Tj }} and {{Tji }} templates)
{{param value}}	`··2·blanks·fore·and·aft··`	To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc.	{{Template\|`1`\|`2`\|...\|`10`}}	To display a template call (with or without parameters and values) as code
{{tji}}	{{hatnote\|Hello\|selfref=yes\|category=no}}	To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}}	"The `‎<img>...‎</img>` tags ..."	To render HTML elements ("tags") in prose
{{code}}/{{codett}}	"Ensure the alt= parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `‎<code>...‎</code>`. {{Codett }} differs only in styling: someMethod becomes someMethod
{{PreCode}}	"FORTH has keyword `?BRANCH`."	Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst :codenowiki}}	`{{small\|small text example}}`	To wrap example code in <code><nowiki>...</nowiki></code>
{{subst :kbdnowiki}}	`{{large\|large text example}}`	To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}	_{[this is a block template]}	( or {{sxhl}} ) Wrapper for `‎<syntaxhighlight>...‎</syntaxhighlight>`, but will wrap overflowing text
{{deprecated code}}	"Do not use `‎<blink>`."	( or {{dc}} ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (`‎<blink>`) while {{dcr}} uses red (`‎<blink>`).
{{pre}}	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
{{tj}}	_{[this is a block template]}	To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}	_{[this is a block template]}	For block quotations (only – never for non-quotations)
{{block indent}}	_{[this is a block template]}	For indented blocks of material; visually identical to {{quote}} but without quote markup
{{kbd}}	`user input`	To indicate user input
{{key press}}	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
{{key top}}	`Left shift`	Similar; includes more symbols, but does not directly support combinations
{{button}}	<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); ">Don't save	To indicate a button in a user interface
{{samp}}	`example output`	To indicate sample or example output

Usage

Examples

TemplateData

See also