Template:Key press: Difference between revisions

From Guild of Archivists
m (1 revision imported)
No edit summary
 
Line 9: Line 9:
-->{{#if:{{{9|}}}|{{{chain eighth|{{{chain|+}}}}}}{{key press/core|{{{9}}}}}}}<!--
-->{{#if:{{{9|}}}|{{{chain eighth|{{{chain|+}}}}}}{{key press/core|{{{9}}}}}}}<!--
-->{{#if:{{{10|}}}|{{{chain ninth|{{{chain|+}}}}}}{{key press/core|{{{10}}}}}}}<!--
-->{{#if:{{{10|}}}|{{{chain ninth|{{{chain|+}}}}}}{{key press/core|{{{10}}}}}}}<!--
-->{{#if:{{{11|}}}|[[Category:Wikipedia keypress template parameter needs fixing]]}}<noinclude>
-->{{#if:{{{11|}}}|[[Category:GoArch keypress template parameter needs fixing]]}}<noinclude>
{{documentation}}
{{documentation}}
<!-- add category and language links to the /doc sub-page, not here -->
<!-- add category and language links to the /doc sub-page, not here -->
</noinclude>
</noinclude>

Latest revision as of 21:12, 11 July 2016

Template documentation[view] [edit] [history] [purge]


This is the {{key press}} template primarily designed to illustrate keys and keystrokes on a computer keyboard. With additional parameters, a single template can even illustrate a combination of multiple simultaneous keystrokes. A sequence of keystrokes, on the other hand, need to be demonstrated with separate templates.

Example

{{key press|A}}A

Keystroke combinations[edit source]

To illustrate keystroke combinations, just use extra parameters:

{{key press|Alt|P}}Alt+P
{{key press|Ctrl|Alt|Del}}Ctrl+Alt+Del

This template currently handles up to 10 key name parameters, which should be more than enough to accommodate for any possible combination of simultaneous keystrokes. If it gets too many key name parameters it reports the page into Category:GoArch keypress template parameter needs fixing. This means we can easily find those pages and fix them, or we can discover if we need to make this template take more parameters.

When you feed several key names to this template, it adds a "+" (or whatever the contents of the optional chain parameter) with no spaces around. This means it won't line wrap. But when you show key combinations for instance in a table then that might cause too wide items. Then instead manually build the key combination with spaces around the "+" so it can line wrap:

{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}Ctrl + Alt + Del
{{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}Ctrl + Alt + Del

On the other hand, to illustrate Windows Alt codes you might want to use separate templates with no intervening punctuation or space. In most Windows systems in North America and Western Europe, for example, the plus-minus sign (±) can be entered by holding down the Alt key while typing 0177 (with the numeric keypad):

{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}Alt+0177

An example of a use case where more than 5 might be used is explaining usage of a macro (keyboard shortcut) created by a third-party application:

{{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}Ctrl+Alt+ Shift+ Win+ Menu+fn+L

Wikilinks[edit source]

If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:

  • {{key press|[[w:Alt key|Alt]]}}Alt

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[w:Control key|Ctrl]] instead of [[w:Ctrl]], which leads to a disambiguation page).

Wiki markup characters[edit source]

Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{}} templates or as an HTML entity &#124;, &#59;, &#61; respectively:

  • {{key press|{{pipe}}}}|
  • {{key press|&#124;}}|
  • {{key press|{{;}}}};
  • {{key press|&#59;}};
  • {{key press|{{=}}}}=
  • {{key press|&#61;}}=

Most markup characters also have aliases:

  • {{key press|pipe}}|
  • {{key press|semicolon}};
  • {{key press|equals}}=
  • {{key press|colon}}:
  • {{key press|asterisk}}*
  • {{key press|hash}}#

Key symbols[edit source]

Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others.

  • {{key press|Shift}} Shift
  • {{key press|Tab}}Tab
  • {{key press|Enter}} Enter
  • {{key press|Option}} Option
  • {{key press|Opt}} Opt
  • {{key press|Command}} Command
  • {{key press|Cmd}} Cmd
  • {{key press|Caps Lock}} Caps Lock
  • {{key press|Scroll Lock}}Scroll Lock
  • {{key press|Up}}
  • {{key press|Down}}
  • {{key press|Left}}
  • {{key press|Right}}
Windows key and Menu key
Old-style Windows key

There are no characters for the Windows key and Menu key. So this template shows approximate characters for them, namely the 'SQUARED PLUS' and 'STRICTLY EQUIVALENT TO' from the Mathematical Operators block:

  • {{key press|Win}} Win
  • {{key press|Menu}} Menu

Video games[edit source]

Video game controllers often have specialized input labels that do not map easily. The following are mappings for various game consoles and input features.

Directional input[edit source]

The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.

  • {{key press|l-down}}L↓
  • {{key press|c-left}}C←
  • {{key press|r-up}}R↑

Stick specific diagonals are also supported:

  • {{key press|l-nw}}L↖
  • {{key press|c-se}}C↘
  • {{key press|r-ne}}R↗
PlayStation[edit source]
  • {{key press|ex}}×
  • {{key press|circle}}
  • {{key press|triangle}}
  • {{key press|square}}

Technical details[edit source]

This template calls {{key press/core}}, which holds the code that otherwise would be repeated several times in {{key press}}, thus simplifying the code.

TemplateData[edit source]

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

TemplateData for Key press

Illustrates keys and keystrokes on a computer keyboard. Keys can include: Ctrl, Alt, Del, Opt, Menu, Left etc. console keys: ex, circle, triangle, square, and left right and center analog sticks: l-down, c-left, r-ne. The names are case insensitive.

Template parameters

ParameterDescriptionTypeStatus
First key1

First key

Linerequired
Second key2

Optional key press in combination as the first.

Lineoptional
Third key3

Optional key press in combination as the first.

Lineoptional
Forth key4

Optional key press in combination as the first.

Lineoptional
Fifth key5

Optional key press in combination as the first.

Lineoptional
Sixth key6

Optional key press in combination as the first.

Lineoptional
Seventh key7

Optional key press in combination as the first.

Lineoptional
Eighth key8

Optional key press in combination as the first.

Lineoptional
Ninth key9

Optional key press in combination as the first.

Lineoptional
Tenth key10

Optional key press in combination as the first.

Lineoptional
Chaining characterchain

Character between chained key presses

Default
+
Lineoptional
Chaining characterchain first

Character between first and second key to press

Default
+
Lineoptional
Chaining characterchain second

Character between second and third key to press

Default
+
Lineoptional
Chaining characterchain third

Character between third and fourth key to press

Default
+
Lineoptional
Chaining characterchain fourth

Character between fourth and fifth key to press

Default
+
Lineoptional

See also[edit source]

  • {{Button}}, which produces a similar visual effect but without the semantic markup (e.g. sample text).