Difference between revisions of "Template:Key press"

From LFS Manual
Jump to navigationJump to search
m
m
 
(2 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
-->{{#if:{{{10|}}}|{{{chain ninth|{{{chain|&nbsp;+ }}}}}}{{key press/core|{{{10}}}}}}}<!--
 
-->{{#if:{{{10|}}}|{{{chain ninth|{{{chain|&nbsp;+ }}}}}}{{key press/core|{{{10}}}}}}}<!--
 
-->{{#if:{{{11|}}}|[[Category:Wikipedia keypress template parameter needs fixing]]}}<noinclude>
 
-->{{#if:{{{11|}}}|[[Category:Wikipedia keypress template parameter needs fixing]]}}<noinclude>
<!-- add category and language links to the /doc sub-page (we don't currently have /doc subpages on lfsmanual), not here -->
+
{{documentation}}
== Template documentation ==
 
This template allows you to illustrate keyboard keystrokes or a combination of multiple simultaneous keystrokes.
 
=== Examples ===
 
For keystroke combinations, just use extra parameters:
 
<pre>{{key press|Ctrl|Shift|F}}</pre>
 
Renders as: {{key press|Ctrl|Shift|F}}
 
 
 
To illustrate keystrokes where all keys do not need to be pressed simultaneously, set "chain=" to omit multiple plus signs.
 
<pre>{{key press|Alt|0}}{{key press|1|7|7|chain=}}</pre>
 
Renders as: {{key press|Alt|0}}{{key press|1|7|7|chain=}}
 
 
 
Special characters need to be entered as HTML entities:
 
<pre>
 
{{key press|&amp;#124;}}
 
{{key press|&amp;#59;}}
 
{{key press|&amp;#61;}}
 
</pre>
 
Renders as:
 
{{key press|&#124;}}
 
{{key press|&#59;}}
 
{{key press|&#61;}}
 
 
 
or with aliases:
 
<pre>
 
{{key press|pipe}}
 
{{key press|semicolon}}
 
{{key press|equals}}
 
{{key press|colon}}
 
{{key press|asterisk}}
 
{{key press|hash}}
 
</pre>
 
Renders as:
 
{{key press|pipe}}
 
{{key press|semicolon}}
 
{{key press|equals}}
 
{{key press|colon}}
 
{{key press|asterisk}}
 
{{key press|hash}}
 
 
 
Key symbols:
 
<pre>
 
{{key press|Ctrl}}
 
{{key press|Shift}}
 
{{key press|Tab}}
 
{{key press|Enter}}
 
{{key press|Option}}
 
{{key press|Opt}}
 
{{key press|Command}}
 
{{key press|Cmd}}
 
{{key press|Caps Lock}}
 
{{key press|Up}}
 
{{key press|Down}}
 
{{key press|Left}}
 
{{key press|Right}}
 
{{key press|Win}}
 
{{key press|Menu}}
 
</pre>
 
Renders as:
 
{{key press|Ctrl}}
 
{{key press|Shift}}
 
{{key press|Tab}}
 
{{key press|Enter}}
 
{{key press|Option}}
 
{{key press|Opt}}
 
{{key press|Command}}
 
{{key press|Cmd}}
 
{{key press|Caps Lock}}
 
{{key press|Up}}
 
{{key press|Down}}
 
{{key press|Left}}
 
{{key press|Right}}
 
{{key press|Win}}
 
{{key press|Menu}}
 
 
 
 
 
Mouse buttons:
 
<pre>
 
{{key press|LMB}}
 
{{key press|RMB}}
 
{{key press|MMB}}
 
 
 
{{key press|left mouse button}}
 
{{key press|right mouse button}}
 
{{key press|scroll wheel}}
 
</pre>
 
Renders as:
 
 
 
{{key press|LMB}}
 
{{key press|RMB}}
 
{{key press|MMB}}
 
 
 
{{key press|left mouse button}}
 
{{key press|right mouse button}}
 
{{key press|scroll wheel}}
 
</noinclude>
 

Latest revision as of 01:21, 3 December 2023

Template Info-Icon.png

Template documentation

View - Edit

This template allows you to illustrate keyboard keystrokes or a combination of multiple simultaneous keystrokes.

Keystroke combinations

For keystroke combinations, just use extra parameters:

Markup Renders as
{{key press|Ctrl|Shift|F}}

Ctrl + ⇧ Shift + F

Chaining

To illustrate keystrokes where all keys do not need to be pressed simultaneously, set "chain=" to omit multiple plus signs.

Markup Renders as
{{key press|Alt|0}}{{key press|1|7|7|chain=}}

Alt + 0177

Special characters

Special characters need to be entered as HTML entities:

Markup Renders as
{{key press|&#124;}}
{{key press|&#59;}}
{{key press|&#61;}}

&#124; &#59; &#61;

or with aliases:

Markup Renders as
{{key press|pipe}}
{{key press|semicolon}}
{{key press|equals}}
{{key press|colon}}
{{key press|asterisk}}
{{key press|hash}}

| ; = : * #

Key symbols

Markup Renders as
{{key press|Ctrl}}
{{key press|Shift}}
{{key press|Tab}}
{{key press|Enter}}
{{key press|Option}}
{{key press|Opt}}
{{key press|Command}}
{{key press|Cmd}}
{{key press|Caps Lock}}
{{key press|Up}} 
{{key press|Down}}
{{key press|Left}}
{{key press|Right}}
{{key press|Win}}
{{key press|Menu}}

Ctrl ⇧ Shift Tab ↹ ↵ Enter ⌥ Option ⌥ Opt ⌘ Command ⌘ Cmd ⇪ Caps Lock ⊞ Win ≣ Menu

Mouse buttons

Markup Renders as
{{key press|LMB}}
{{key press|RMB}}
{{key press|MMB}}

{{key press|left mouse button}}
{{key press|right mouse button}}
{{key press|scroll wheel}}

LMB RMB MMB

LMB RMB MMB