Template:Key press/doc View history

(→‎Key symbols: commented out other game systems)
m (decomplexifying)
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
__NOTOC__
__NOTOC__


This is the {{tl|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.
This is the {{tl|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:
Example:
:{{tlc|key press|A}} → {{key press|A}}
:{{tlx|key press|A}} → {{key press|A}}
:{{tlx|key press|A}} → {{key press|A}}


=== Keystroke combinations ===
=== Keystroke combinations ===


To illustrate keystroke combinations, just use extra parameters:
To illustrate keystroke combinations, just use extra parameters:
:{{tlc|key press|Alt|P}} → {{key press|Alt|P}}
:{{tlx|key press|Alt|P}} → {{key press|Alt|P}}
:{{tlc|key press|Ctrl|Alt|Del}} → {{key press|Ctrl|Alt|Del}}
:{{tlx|key press|Ctrl|Alt|Del}} → {{key press|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:Wikipedia 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.
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: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:
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:
:{{tlc|key press|Ctrl}} + {{tlc|key press|Alt}} + {{tlc|key press|Del}} → {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
:{{tlx|key press|Ctrl}} + {{tlx|key press|Alt}} + {{tlx|key press|Del}} →  
:{{tlc|key press|Ctrl|Alt|Del|5=chain= + }} → {{key press|Ctrl|Alt|Del|chain= + }}
::{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
:{{tlx|key press|Ctrl|Alt|Del|5=chain= + }} →  
::{{key press|Ctrl|Alt|Del|chain= + }}


On the other hand, to illustrate Windows [[Alt code]]s 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 <code>0177</code> (with the [[numeric keypad]]):
On the other hand, to illustrate Windows [[Alt code]]s 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 <code>0177</code> (with the [[numeric keypad]]):
:{{tlc|key press|Alt|0}}{{tlc|key press|1}}{{tlc|key press|7}}{{tlc|key press|7}} → {{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}
:{{tlx|key press|Alt|0}}{{tlx|key press|1}}{{tlx|key press|7}}{{tlx|key press|7}} →
::{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}


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:
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:
:{{tlc|Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} → {{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}
:{{tlx|Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} →  
::{{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}


=== Wikilinks ===
=== Wikilinks ===


If there is an article about the key you can [[WP:wikilink|wikilink]] the key's name like any other wiki text. Like this:
If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:
* {{tlc|key press|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key press|[[Alt key|Alt]]}}
* {{tlx|key press|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key press|[[Alt key|Alt]]}}


If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[WP:Disambiguation page|disambiguation page]]).
If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. <code><nowiki>[[Control key|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[WP:Disambiguation page|disambiguation page]]).
Line 36: Line 41:


Some wiki markup character, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates or as an [[HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
Some wiki markup character, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates or as an [[HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
* {{tlc|key press|{{Tlc|!}}}} → {{key press|{{!}}}}
* {{tlx|key press|{{tlx|!}}}} → {{key press|{{!}}}}
* {{tlc|key press|&amp;#124;}} → {{key press|&#124;}}
* {{tlx|key press|&amp;#124;}} → {{key press|&#124;}}
* {{tlc|key press|{{Tlc|&#124;}}}} → {{key press|{{;}}}}
* {{tlx|key press|{{tlx|&#59;}}}} → {{key press|{{;}}}}
* {{tlc|key press|&amp;#59;}} →  {{key press|&#59;}}
* {{tlx|key press|&amp;#59;}} →  {{key press|&#59;}}
* {{tlc|key press|{{Tlc|&#61;}}}} → {{key press|{{=}}}}
* {{tlx|key press|{{tlx|&#61;}}}} → {{key press|{{=}}}}
* {{tlc|key press|&amp;#61;}} →  {{key press|&#61;}}
* {{tlx|key press|&amp;#61;}} →  {{key press|&#61;}}


However, if the characters are marked as wikilinks, they can be entered as such:
However, if the characters are marked as wikilinks, they can be entered as such:
* {{tlc|key press|<nowiki>[[&#124;]]</nowiki>}} → {{key press|[[|]]}}
* {{tlx|key press|<nowiki>[[&#124;]]</nowiki>}} → {{key press|[[|]]}}
* {{tlc|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
* {{tlx|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
* {{tlc|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}
* {{tlx|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}


Most markup characters also have aliases:
Most markup characters also have aliases:
* {{tlc|key press|pipe}} → {{key press|pipe}}
* {{tlx|key press|pipe}} → {{key press|pipe}}
* {{tlc|key press|semicolon}} → {{key press|semicolon}}
* {{tlx|key press|semicolon}} → {{key press|semicolon}}
* {{tlc|key press|equals}} → {{key press|equals}}
* {{tlx|key press|equals}} → {{key press|equals}}
* {{tlc|key press|colon}} → {{key press|colon}}
* {{tlx|key press|colon}} → {{key press|colon}}
* {{tlc|key press|asterisk}} → {{key press|asterisk}}
* {{tlx|key press|asterisk}} → {{key press|asterisk}}
* {{tlc|key press|hash}} → {{key press|hash}}
* {{tlx|key press|hash}} → {{key press|hash}}


=== Key symbols ===
=== Key symbols ===


Some key names have a fitting [[Unicode]] character. This template automatically adds such "icons" to the following key names among others (see also ''Arrows exception'' below).
Some key names have a fitting [[Unicode]] character. This template automatically adds such "icons" to the following key names among others (see also ''Arrows exception'' below).
* {{tlc|key press|Shift}} → {{key press|Shift}}
* {{tlx|key press|Shift}} → {{key press|Shift}}
* {{tlc|key press|Tab}} → {{key press|Tab}}
* {{tlx|key press|Tab}} → {{key press|Tab}}
* {{tlc|key press|Enter}} → {{key press|Enter}}
* {{tlx|key press|Enter}} → {{key press|Enter}}
* {{tlc|key press|Option}} → {{key press|Option}}
* {{tlx|key press|Option}} → {{key press|Option}}
* {{tlc|key press|Opt}} → {{key press|Opt}}
* {{tlx|key press|Opt}} → {{key press|Opt}}
* {{tlc|key press|Command}} → {{key press|Command}}
* {{tlx|key press|Command}} → {{key press|Command}}
* {{tlc|key press|Cmd}} → {{key press|Cmd}}
* {{tlx|key press|Cmd}} → {{key press|Cmd}}
* {{tlc|key press|Caps Lock}} → {{key press|Caps Lock}}
* {{tlx|key press|Caps Lock}} → {{key press|Caps Lock}}
* {{tlc|key press|Scroll Lock}} → {{key press|Scroll Lock}}
* {{tlx|key press|Scroll Lock}} → {{key press|Scroll Lock}}
* {{tlc|key press|Up}} → {{key press|Up}}
* {{tlx|key press|Up}} → {{key press|Up}}
* {{tlc|key press|Down}} → {{key press|Down}}
* {{tlx|key press|Down}} → {{key press|Down}}
* {{tlc|key press|Left}} → {{key press|Left}}
* {{tlx|key press|Left}} → {{key press|Left}}
* {{tlc|key press|Right}} → {{key press|Right}}
* {{tlx|key press|Right}} → {{key press|Right}}
[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]]
[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]]
[[File:Ctl wndws alt.jpg|thumb|200px|Old-style Windows key]]
[[File:Ctl wndws alt.jpg|thumb|200px|Old-style Windows key]]
There are no characters for the [[Windows key]] and [[Menu key]]. Besides, the Windows logo is [[trademark]]ed. So this template shows approximate characters for them in the following way:
There are no characters for the [[Windows key]] and [[Menu key]]. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:
* {{tlc|key press|Win}} → {{key press|Win}}
* {{tlx|key press|Win}} → {{key press|Win}}
* {{tlc|key press|Menu}} → {{key press|Menu}}
* {{tlx|key press|Menu}} → {{key press|Menu}}


<!-- This is for other keyboard systems as it existed in Wikipedia; kept for reference only
<!-- This is for other keyboard systems as it existed in Wikipedia; kept for reference only
Line 87: Line 92:
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.


* {{tlc|key press|l-down}} → {{key press|l-down}}
* {{tlx|key press|l-down}} → {{key press|l-down}}
* {{tlc|key press|c-left}} → {{key press|c-left}}
* {{tlx|key press|c-left}} → {{key press|c-left}}
* {{tlc|key press|r-up}} → {{key press|r-up}}
* {{tlx|key press|r-up}} → {{key press|r-up}}


Stick specific diagonals are also supported:
Stick specific diagonals are also supported:


* {{tlc|key press|l-nw}} → {{key press|l-nw}}
* {{tlx|key press|l-nw}} → {{key press|l-nw}}
* {{tlc|key press|c-se}} → {{key press|c-se}}
* {{tlx|key press|c-se}} → {{key press|c-se}}
* {{tlc|key press|r-ne}} → {{key press|r-ne}}
* {{tlx|key press|r-ne}} → {{key press|r-ne}}


===== PlayStation =====
===== PlayStation =====


* {{tlc|key press|ex}} → {{key press|ex}}
* {{tlx|key press|ex}} → {{key press|ex}}
* {{tlc|key press|circle}} → {{key press|circle}}
* {{tlx|key press|circle}} → {{key press|circle}}
* {{tlc|key press|triangle}} → {{key press|triangle}}
* {{tlx|key press|triangle}} → {{key press|triangle}}
* {{tlc|key press|square}} → {{key press|square}}
* {{tlx|key press|square}} → {{key press|square}}
-->
-->
{{clear}}
{{clear}}
Line 186: Line 191:
}
}
</templatedata>
</templatedata>
=== See also ===
{{Var/seealso}}


==== Not to be confused with ====
==== Not to be confused with ====
Line 201: Line 202:
<!-- [[Category:Graphic templates]] - Don't add this one; this isn't a graphic template, as it's all done in CSS. -->
<!-- [[Category:Graphic templates]] - Don't add this one; this isn't a graphic template, as it's all done in CSS. -->
[[Category:Semantic markup templates]]
[[Category:Semantic markup templates]]
[[Category:Software templates]]
[[Category:Computer keys]]
[[Category:computer keys]]
[[Category:Incomplete templates]]
 
[[nl:Sjabloon:Toets]]
[[sl:Predloga:Keypress]]


</includeonly>
</includeonly>

Latest revision as of 15:15, 22 June 2015

This is a documentation subpage for Template:Key press.
It contains usage information, categories and other content that is not part of the original template page.


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
{{key press|A}}A

Keystroke combinations

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

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

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

Wiki markup characters

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:

However, if the characters are marked as wikilinks, they can be entered as such:

Most markup characters also have aliases:

Key symbols

Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others (see also Arrows exception below).

File:AltGr Win Menu Ctrl key.jpg
Windows key and Menu key
File:Ctl wndws alt.jpg
Old-style Windows key

There are no characters for the Windows key and Menu key. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:

Technical details

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

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

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

Not to be confused with

  • {{Button}} – Produces a similar visual effect, but without the semantic markup, e.g. sample text.