Template:Key press/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(47 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
__NOTOC__
This is the {{tl|key press}} template, which can be used to illustrate keystrokes. Typographically it works best with examples that are separated from the normal flow of text, e.g. in table cells. It can also be used in lists (as in this page), but it may be a good idea to add an empty line between each list item, so the key borders won't overlap each other.
This is the {{tl|key press}} template, which can be used to illustrate keystrokes. Typographically it works best with examples that are separated from the normal flow of text, e.g. in table cells. It can also be used in lists (as in this page), but it may be a good idea to add an empty line between each list item, so the key borders won't overlap each other.


Line 15: Line 11:
:<code><nowiki>{{key press|Ctrl|Alt|Del}}</nowiki></code> produces {{key press|Ctrl|Alt|Del}}
:<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. 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 5 key name parameters; more than enough to accomodate for any possible '''combined''' key stroke. 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 "+" 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:
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:
Line 21: Line 17:
:<code><nowiki>{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}</nowiki></code> produces {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
:<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:
On the other hand, to illustrate Windows [[w:Alt code|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 [[w:plus-minus sign|plus-minus sign]] (±) can be entered by holding down the Alt key while typing <code>0177</code> (with the [[w:numeric keypad|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}}
:<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}}
Line 28: Line 24:


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 [[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]]}}
:<code><nowiki>{{key press|[[w:Alt key|Alt]]}}</nowiki></code> produces {{key press|[[w: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 34: Line 30:
=== Wiki characters ===
=== Wiki 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:
Some wiki markup character, like the [[w:pipe symbol|pipe symbol]], the [[w:semicolon|semicolon]] and the [[w:equals sign|equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates:
 
:<code><nowiki>{{key press|{{!}}}}</nowiki></tt> produces {{key press|{{!}}}}
 
:<code><nowiki>{{key press|{{;}}}}</nowiki></tt> produces {{key press|{{;}}}}


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


:<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.
Alternately, <code><nowiki>{{key press|&lt;nowiki>|&lt;/nowiki>}}</nowiki></code> is also an option.


=== Key symbols ===
=== Key symbols ===
Line 61: Line 51:


:<code><nowiki>{{key press|Enter}}</nowiki></code> produces {{key press|Enter}}
:<code><nowiki>{{key press|Enter}}</nowiki></code> produces {{key press|Enter}}
:<code><nowiki>{{key press|Return}}</nowiki></code> produces {{key press|Return}}


:<code><nowiki>{{key press|Tab}}</nowiki></code> produces {{key press|Tab}}
:<code><nowiki>{{key press|Tab}}</nowiki></code> produces {{key press|Tab}}
Line 71: Line 59:


:<code><nowiki>{{key press|Opt}}</nowiki></code> produces {{key press|Opt}}
:<code><nowiki>{{key press|Opt}}</nowiki></code> produces {{key press|Opt}}
:<code><nowiki>{{key press|Esc}}</nowiki></code> produces {{key press|Esc}}


:<code><nowiki>{{key press|Up}}</nowiki></code> produces {{key press|Up}}
:<code><nowiki>{{key press|Up}}</nowiki></code> produces {{key press|Up}}
Line 82: Line 68:
:<code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}
:<code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}


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


:<code><nowiki>{{key press|Meta}}</nowiki></code> produces {{key press|Meta}}
There are no characters for the [[w:Windows key|Windows key]] and [[w:Menu key|Menu key]]. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:
 
:<code><nowiki>{{key press|Win}}</nowiki></code> produces {{key press|Win}}


[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]]
:<code><nowiki>{{key press|Menu}}</nowiki></code> produces {{key press|Menu}}
[[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:
====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.


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


:<code><nowiki>{{key press|Menu}}</nowiki></code> produces {{key press|Menu}}
{{clear}}
{{clear}}


Line 99: Line 95:


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.
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 ==
=== See also ===
*{{tl|Button}} – produces a similar visual effect, but without the semantic markup, e.g. {{Button|sample text}}
 
* {{tl|pskeypress}} – For PlayStation-style controllers.


<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Formatting templates]]
[[Category:Software templates]]
[[Category:Graphic templates]]
 
[[be-x-old:Шаблён:Клявіша]]
[[de:Vorlage:Taste]]
[[es:Plantilla:Tecla]]
[[eo:Ŝablono:Klavo]]
[[fr:Modèle:Touche]]
[[ko:틀:키눌림]]
[[hsb:Předłoha:Tasta]]
[[hu:Sablon:Billentyű]]
[[it:Template:Tasto]]
[[ja:Template:Keypress]]
[[pl:Szablon:Klawisz]]
[[pt:Predefinição:Tecla]]
[[ru:Шаблон:Клавиша]]
[[fi:Malline:Näppäin]]
[[vi:Tiêu bản:Keypress]]
</includeonly>
</includeonly>

Revision as of 02:41, 16 July 2020

This is the {{key press}} template, which can be used to illustrate keystrokes. Typographically it works best with examples that are separated from the normal flow of text, e.g. in table cells. It can also be used in lists (as in this page), but it may be a good idea to add an empty line between each list item, so the key borders won't overlap each other.

Example:

{{key press|A}} produces A

Keystroke combinations

To illustrate keystroke combinations, just use extra parameters:

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

This template currently handles up to 5 key name parameters; more than enough to accomodate for any possible combined key stroke. 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 "+" 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:

{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}} produces 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). This could be illustrated like this:

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

Wikilinks

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]]}} produces Alt

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 characters

Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{=}} templates:

{{key press|{{!}}}} produces |
{{key press|{{;}}}} produces ;
{{key press|{{=}}}} produces =


Alternately, {{key press|<nowiki>|</nowiki>}} 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:

{{key press|Caps Lock}} produces  Caps Lock
{{key press|Shift}} produces  Shift
{{key press|Enter}} produces  Enter
{{key press|Tab}} produces Tab 
{{key press|Backspace}} produces ← Backspace
{{key press|Cmd}} produces  Cmd
{{key press|Opt}} produces  Opt
{{key press|Up}} produces
{{key press|Down}} produces
{{key press|Left}} produces
{{key press|Right}} produces


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:

{{key press|Win}} produces  Win
{{key press|Menu}} produces  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.

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

Stick specific diagonals are also supported:

{{key press|l-nw}} produces L ↖
{{key press|c-se}} produces C ↘
{{key press|r-ne}} produces R ↗

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.

See also

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