Editing Template:Keypress/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS LINKS AT THE END OF THIS PAGE. -->
__NOTOC__

Template imported from English Wikipedia.

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:
:<code><nowiki>{{key press|A}}</nowiki></code> produces {{key press|A}}

=== Keystroke combinations ===

To illustrate keystroke combinations, just use extra parameters:

:<code><nowiki>{{key press|Alt|P}}</nowiki></code> produces {{key press|Alt|P}}

:<code><nowiki>{{key press|Ctrl|Alt|Del}}</nowiki></code> produces {{key press|Ctrl|Alt|Del}}

This template currently handles up to 5 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.

When you feed several key names to this template, it adds a "+" 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. Like this:

:<code><nowiki>{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}</nowiki></code> produces {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}

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]]). This could be illustrated like this:

:<code><nowiki>{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}</nowiki></code> produces {{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}

=== 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:
* <code><nowiki>{{key press|[[Alt key|Alt]]}}</nowiki></code> produces {{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]]).

=== Wiki markup characters ===

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:

* <code><nowiki>{{key press|{{!}}}}</nowiki></code> produces {{key press|{{!}}}}
* <code><nowiki>{{key press|{{;}}}}</nowiki></code> produces {{key press|{{;}}}}
* <code><nowiki>{{key press|{{=}}}}</nowiki></code> produces {{key press|{{=}}}}

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

* <code><nowiki>{{key press|[[|]]}}</nowiki></code> produces {{key press|[[|]]}}
* <code><nowiki>{{key press|[[;]]}}</nowiki></code> produces {{key press|[[;]]}}
* <code><nowiki>{{key press|[[=]]}}</nowiki></code> produces {{key press|[[=]]}}

If you don't want to mark the characters as links, <code><nowiki>{{key press|&lt;nowiki>|&lt;/nowiki>}}</nowiki></code> is also an option.

=== Key symbols ===

Some key names have a fitting [[Unicode]] character. This template automatically adds such "icons" to the following key names:

* <code><nowiki>{{key press|Shift}}</nowiki></code> produces {{key press|Shift}}
* <code><nowiki>{{key press|Caps Lock}}</nowiki></code> produces {{key press|Caps Lock}}
* <code><nowiki>{{key press|Enter}}</nowiki></code> produces {{key press|Enter}}
* <code><nowiki>{{key press|Tab}}</nowiki></code> produces {{key press|Tab}}
* <code><nowiki>{{key press|Backspace}}</nowiki></code> produces {{key press|Backspace}}
* <code><nowiki>{{key press|Cmd}}</nowiki></code> produces {{key press|Cmd}}
* <code><nowiki>{{key press|Opt}}</nowiki></code> produces {{key press|Opt}}
* <code><nowiki>{{key press|Up}}</nowiki></code> produces {{key press|Up}}
* <code><nowiki>{{key press|Down}}</nowiki></code> produces {{key press|Down}}
* <code><nowiki>{{key press|Left}}</nowiki></code> produces {{key press|Left}}
* <code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}

[[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]]

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:

* <code><nowiki>{{key press|Win}}</nowiki></code> produces {{key press|Win}}
* <code><nowiki>{{key press|Menu}}</nowiki></code> produces {{key press|Menu}}

==== Video games ====

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

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

* <code><nowiki>{{key press|l-down}}</nowiki></code> produces {{key press|l-down}}
* <code><nowiki>{{key press|c-left}}</nowiki></code> produces {{key press|c-left}}
* <code><nowiki>{{key press|r-up}}</nowiki></code> produces {{key press|r-up}}

Stick specific diagonals are also supported:

* <code><nowiki>{{key press|l-nw}}</nowiki></code> produces {{key press|l-nw}}
* <code><nowiki>{{key press|c-se}}</nowiki></code> produces {{key press|c-se}}
* <code><nowiki>{{key press|r-ne}}</nowiki></code> produces {{key press|r-ne}}

===== PlayStation =====

* <code><nowiki>{{key press|ex}}</nowiki></code> produces {{key press|ex}}
* <code><nowiki>{{key press|circle}}</nowiki></code> produces {{key press|circle}}
* <code><nowiki>{{key press|triangle}}</nowiki></code> produces {{key press|triangle}}
* <code><nowiki>{{key press|square}}</nowiki></code> produces {{key press|square}}

{{clear}}

=== Technical details ===

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

=== See also ===

{{Var/seealso}}

==== Not to be confused with ====
* {{tl|Button}} – Produces a similar visual effect, but without the semantic markup, e.g. {{Button|sample text}}.