Difference between revisions of "Template:Key press/doc"

From relax wiki
Jump to navigation Jump to search
(More clean up.)
m (Switch from the imported {{informative template}} to the relax {{template info}} template)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{template info|1=
 
This is the {{tl|key press}} template primarily designed to illustrate keys and keystrokes on a [[wikipedia: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 [[wikipedia: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
−
: {{tc|key press|A}} → {{key press|A}}
+
: <code>{{obr}}key press{{!}}A{{cbr}}</code> → {{key press|A}}
  
 
===Keystroke combinations===
 
===Keystroke combinations===
 
To illustrate keystroke combinations, just use extra parameters:
 
To illustrate keystroke combinations, just use extra parameters:
−
: {{tc|key press|Alt|P}} → {{key press|Alt|P}}
+
: <code>{{obr}}key press{{!}}Alt{{!}}P{{cbr}}</code> → {{key press|Alt|P}}
−
: {{tc|key press|Ctrl|Alt|Del}} → {{key press|Ctrl|Alt|Del}}
+
: <code>{{obr}}key press{{!}}Ctrl{{!}}Alt{{!}}Del{{cbr}}</code> → {{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: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 "+" (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:
−
: {{tc|key press|Ctrl}} + {{tlc|key press|Alt}} + {{tlc|key press|Del}} → {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
+
: <code>{{obr}}key press{{!}}Ctrl{{cbr}}</code> + <code>{{obr}}key press{{!}}Alt{{cbr}}</code> + <code>{{obr}}key press{{!}}Del{{cbr}}</code> → {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
−
: {{tc|key press|Ctrl|Alt|Del|5=chain=&amp;#32;+&amp;#32;}} → {{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}
+
: <code>{{obr}}key press{{!}}Ctrl{{!}}Alt{{!}}Del{{!}}5=chain=&amp;#32;+&amp;#32;{{cbr}}</code> → {{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}
  
 
On the other hand, to illustrate Windows [[wikipedia: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 [[wikipedia:plus-minus sign]] (±) can be entered by holding down the Alt key while typing <code>0177</code> (with the [[wikipedia:numeric keypad]]):
 
On the other hand, to illustrate Windows [[wikipedia: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 [[wikipedia:plus-minus sign]] (±) can be entered by holding down the Alt key while typing <code>0177</code> (with the [[wikipedia:numeric keypad]]):
−
: {{tc|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}}
+
: <code>{{obr}}key press{{!}}Alt{{!}}0{{cbr}}{{obr}}key press{{!}}1{{cbr}}{{obr}}key press{{!}}7{{cbr}}{{obr}}key press{{!}}7{{cbr}}</code> → {{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:
−
: {{tc|Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} → {{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}
+
: <code>{{obr}}key press{{!}}Ctrl{{!}}Alt{{!}}Shift{{!}}Win{{!}}Menu{{!}}fn{{!}}L{{cbr}}</code> → {{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}
  
 
===Wikilinks===
 
===Wikilinks===
 
If there is an article about the key you can [[wikipedia:WP:wikilink|wikilink]] the key's name like any other wiki text. Like this:
 
If there is an article about the key you can [[wikipedia:WP:wikilink|wikilink]] the key's name like any other wiki text. Like this:
−
* {{tc|key press|<nowiki>[[wikipedia:Alt key|Alt]]</nowiki>}} → {{key press|[[wikipedia:Alt key|Alt]]}}
+
* <code>{{obr}}key press{{!}}<nowiki>[[wikipedia:Alt key|Alt]]</nowiki>{{cbr}}</code> → {{key press|[[wikipedia: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 [[wikipedia: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 [[wikipedia:WP:Disambiguation page|disambiguation page]]).
Line 29: Line 30:
 
===Wiki markup characters===
 
===Wiki markup characters===
 
Some wiki markup character, like the [[wikipedia:pipe symbol]], the [[wikipedia:semicolon]] and the [[wikipedia:equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates or as an [[wikipedia:HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
 
Some wiki markup character, like the [[wikipedia:pipe symbol]], the [[wikipedia:semicolon]] and the [[wikipedia:equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates or as an [[wikipedia:HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
−
* {{tc|key press|{{tc|!}}}} → {{key press|{{!}}}}
+
* <code>{{obr}}key press{{!}}{{obr}}pipe{{cbr}}{{cbr}}</code> → {{key press|{{!}}}}
−
* {{tc|key press|&amp;#124;}} → {{key press|&#124;}}
+
* <code>{{obr}}key press{{!}}&amp;#124;{{cbr}}</code> → {{key press|&#124;}}
−
* {{tc|key press|{{tc|&#59;}}}} → {{key press|{{;}}}}
+
* <code>{{obr}}key press{{!}}{{obr}}&#59;{{cbr}}{{cbr}}</code> → {{key press|{{;}}}}
−
* {{tc|key press|&amp;#59;}} →  {{key press|&#59;}}
+
* <code>{{obr}}key press{{!}}&amp;#59;{{cbr}}</code> →  {{key press|&#59;}}
−
* {{tc|key press|{{tc|&#61;}}}} → {{key press|{{=}}}}
+
* <code>{{obr}}key press{{!}}{{obr}}&#61;{{cbr}}{{cbr}}</code> → {{key press|{{=}}}}
−
* {{tc|key press|&amp;#61;}} →  {{key press|&#61;}}
+
* <code>{{obr}}key press{{!}}&amp;#61;{{cbr}}</code> →  {{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:
−
* {{tc|key press|<nowiki>[[wikipedia:&#124;]]</nowiki>}} → {{key press|[[wikipedia:|wikipedia:]]}}
+
* <code>{{obr}}key press{{!}}<nowiki>[[wikipedia:&#124;]]</nowiki>{{cbr}}</code> → {{key press|[[wikipedia:|wikipedia:]]}}
−
* {{tc|key press|<nowiki>[[wikipedia:;]]</nowiki>}} → {{key press|[[wikipedia:;]]}}
+
* <code>{{obr}}key press{{!}}<nowiki>[[wikipedia:;]]</nowiki>{{cbr}}</code> → {{key press|[[wikipedia:;]]}}
−
* {{tc|key press|<nowiki>[[wikipedia:=]]</nowiki>}} → {{key press|[[wikipedia:=]]}}
+
* <code>{{obr}}key press{{!}}<nowiki>[[wikipedia:=]]</nowiki>{{cbr}}</code> → {{key press|[[wikipedia:=]]}}
  
 
Most markup characters also have aliases:
 
Most markup characters also have aliases:
−
* {{tc|key press|pipe}} → {{key press|pipe}}
+
* <code>{{obr}}key press{{!}}pipe{{cbr}}</code> → {{key press|pipe}}
−
* {{tc|key press|semicolon}} → {{key press|semicolon}}
+
* <code>{{obr}}key press{{!}}semicolon{{cbr}}</code> → {{key press|semicolon}}
−
* {{tc|key press|equals}} → {{key press|equals}}
+
* <code>{{obr}}key press{{!}}equals{{cbr}}</code> → {{key press|equals}}
−
* {{tc|key press|colon}} → {{key press|colon}}
+
* <code>{{obr}}key press{{!}}colon{{cbr}}</code> → {{key press|colon}}
−
* {{tc|key press|asterisk}} → {{key press|asterisk}}
+
* <code>{{obr}}key press{{!}}asterisk{{cbr}}</code> → {{key press|asterisk}}
−
* {{tc|key press|hash}} → {{key press|hash}}
+
* <code>{{obr}}key press{{!}}hash{{cbr}}</code> → {{key press|hash}}
  
 
===Key symbols===
 
===Key symbols===
 
Some key names have a fitting [[wikipedia:Unicode]] character. This template automatically adds such "icons" to the following key names among others.
 
Some key names have a fitting [[wikipedia:Unicode]] character. This template automatically adds such "icons" to the following key names among others.
−
* {{tc|key press|Shift}} → {{key press|Shift}}
+
* <code>{{obr}}key press{{!}}Shift{{cbr}}</code> → {{key press|Shift}}
−
* {{tc|key press|Tab}} → {{key press|Tab}}
+
* <code>{{obr}}key press{{!}}Tab{{cbr}}</code> → {{key press|Tab}}
−
* {{tc|key press|Enter}} → {{key press|Enter}}
+
* <code>{{obr}}key press{{!}}Enter{{cbr}}</code> → {{key press|Enter}}
−
* {{tc|key press|Option}} → {{key press|Option}}
+
* <code>{{obr}}key press{{!}}Option{{cbr}}</code> → {{key press|Option}}
−
* {{tc|key press|Opt}} → {{key press|Opt}}
+
* <code>{{obr}}key press{{!}}Opt{{cbr}}</code> → {{key press|Opt}}
−
* {{tc|key press|Command}} → {{key press|Command}}
+
* <code>{{obr}}key press{{!}}Command{{cbr}}</code> → {{key press|Command}}
−
* {{tc|key press|Cmd}} → {{key press|Cmd}}
+
* <code>{{obr}}key press{{!}}Cmd{{cbr}}</code> → {{key press|Cmd}}
−
* {{tc|key press|Caps Lock}} → {{key press|Caps Lock}}
+
* <code>{{obr}}key press{{!}}Caps Lock{{cbr}}</code> → {{key press|Caps Lock}}
−
* {{tc|key press|Scroll Lock}} → {{key press|Scroll Lock}}
+
* <code>{{obr}}key press{{!}}Scroll Lock{{cbr}}</code> → {{key press|Scroll Lock}}
−
* {{tc|key press|Up}} → {{key press|Up}}
+
* <code>{{obr}}key press{{!}}Up{{cbr}}</code> → {{key press|Up}}
−
* {{tc|key press|Down}} → {{key press|Down}}
+
* <code>{{obr}}key press{{!}}Down{{cbr}}</code> → {{key press|Down}}
−
* {{tc|key press|Left}} → {{key press|Left}}
+
* <code>{{obr}}key press{{!}}Left{{cbr}}</code> → {{key press|Left}}
−
* {{tc|key press|Right}} → {{key press|Right}}
+
* <code>{{obr}}key press{{!}}Right{{cbr}}</code> → {{key press|Right}}
 
There are no characters for the [[wikipedia:Windows key]] and [[wikipedia:Menu key]]. So this template shows approximate characters for them, namely the 'SQUARED PLUS' and 'STRICTLY EQUIVALENT TO' from the [[wikipedia:Mathematical Operators]] block:
 
There are no characters for the [[wikipedia:Windows key]] and [[wikipedia:Menu key]]. So this template shows approximate characters for them, namely the 'SQUARED PLUS' and 'STRICTLY EQUIVALENT TO' from the [[wikipedia:Mathematical Operators]] block:
−
* {{tc|key press|Win}} → {{key press|Win}}
+
* <code>{{obr}}key press{{!}}Win{{cbr}}</code> → {{key press|Win}}
−
* {{tc|key press|Menu}} → {{key press|Menu}}
+
* <code>{{obr}}key press{{!}}Menu{{cbr}}</code> → {{key press|Menu}}
  
 
====Video games====
 
====Video games====
Line 73: Line 74:
 
=====Directional input=====
 
=====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.
 
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.
−
* {{tc|key press|l-down}} → {{key press|l-down}}
+
* <code>{{obr}}key press{{!}}l-down{{cbr}}</code> → {{key press|l-down}}
−
* {{tc|key press|c-left}} → {{key press|c-left}}
+
* <code>{{obr}}key press{{!}}c-left{{cbr}}</code> → {{key press|c-left}}
−
* {{tc|key press|r-up}} → {{key press|r-up}}
+
* <code>{{obr}}key press{{!}}r-up{{cbr}}</code> → {{key press|r-up}}
  
 
Stick specific diagonals are also supported:
 
Stick specific diagonals are also supported:
−
* {{tc|key press|l-nw}} → {{key press|l-nw}}
+
* <code>{{obr}}key press{{!}}l-nw{{cbr}}</code> → {{key press|l-nw}}
−
* {{tc|key press|c-se}} → {{key press|c-se}}
+
* <code>{{obr}}key press{{!}}c-se{{cbr}}</code> → {{key press|c-se}}
−
* {{tc|key press|r-ne}} → {{key press|r-ne}}
+
* <code>{{obr}}key press{{!}}r-ne{{cbr}}</code> → {{key press|r-ne}}
  
 
=====PlayStation=====
 
=====PlayStation=====
−
* {{tc|key press|ex}} → {{key press|ex}}
+
* <code>{{obr}}key press{{!}}ex{{cbr}}</code> → {{key press|ex}}
−
* {{tc|key press|circle}} → {{key press|circle}}
+
* <code>{{obr}}key press{{!}}circle{{cbr}}</code> → {{key press|circle}}
−
* {{tc|key press|triangle}} → {{key press|triangle}}
+
* <code>{{obr}}key press{{!}}triangle{{cbr}}</code> → {{key press|triangle}}
−
* {{tc|key press|square}} → {{key press|square}}
+
* <code>{{obr}}key press{{!}}square{{cbr}}</code> → {{key press|square}}
 
{{clear}}
 
{{clear}}
  
Line 95: Line 96:
 
===See also===
 
===See also===
 
* {{tl|Button}}, which produces a similar visual effect but without the semantic markup (e.g. {{Button|sample text}}).
 
* {{tl|Button}}, which produces a similar visual effect but without the semantic markup (e.g. {{Button|sample text}}).
 +
}}
  
 
<includeonly>
 
<includeonly>
 
[[Category:Software templates]]
 
[[Category:Software templates]]
 
</includeonly>
 
</includeonly>

Latest revision as of 13:37, 23 October 2020

Template documentation

This is the {{key press}} template primarily designed to illustrate keys and keystrokes on a wikipedia: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

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: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 "+" (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|5=chain=&#32;+&#32;}} → Ctrl + Alt + Del

On the other hand, to illustrate Windows wikipedia: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 wikipedia:plus-minus sign (±) can be entered by holding down the Alt key while typing 0177 (with the wikipedia: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:

  • {{key press|[[wikipedia:Alt key|Alt]]}} → 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 markup characters

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

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

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

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

Some key names have a fitting wikipedia: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}} → →

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

  • {{key press|Win}} → ⊞ Win
  • {{key press|Menu}} → ≣ 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}} → 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
  • {{key press|ex}} → ×
  • {{key press|circle}} → ○
  • {{key press|triangle}} → △
  • {{key press|square}} → □

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}}, which produces a similar visual effect but without the semantic markup (e.g. sample text).


Retrieved from "http://wiki.nmr-relax.com/wiki/index.php?title=Template:Key_press/doc&oldid=7861"