Difference between revisions of "Template:Key press"

From LFS Manual
Jump to navigationJump to search
m
(added template documentation)
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, not here -->
+
<!-- add category and language links to the /doc sub-page (we don't currently have /doc subpages on lfsmanual), not here -->
 +
== 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|F}}</pre>
 +
Renders as: {{key press|Ctrl|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|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|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}}
 
</noinclude>
 
</noinclude>

Revision as of 00:30, 14 December 2021

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: 

{{key press|Ctrl|F}}

Renders as: Ctrl + F

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

{{key press|Alt|0}}{{key press|1|7|7|chain=}}

Renders as: Alt + 0177

Special characters need to be entered as HTML entities: 

{{key press|&#124;}}
{{key press|&#59;}}
{{key press|&#61;}}

Renders as: | ; =

or with aliases: 

{{key press|pipe}}
{{key press|semicolon}}
{{key press|equals}}
{{key press|colon}}
{{key press|asterisk}}
{{key press|hash}}

Renders as: | ; = : * #

Key symbols: 

{{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}}

Renders as: ⇧ Shift Tab ↹ ↵ Enter ⌥ Option ⌥ Opt ⌘ Command ⌘ Cmd ⇪ Caps Lock ↑ ↓ ← → ⊞ Win ≣ Menu

Retrieved from "https://en.lfsmanual.net/index.php?title=Template:Key_press&oldid=5506"