Template:Key press/doc: Difference between revisions
(Updating this /doc since I have just reworked the template. Intermediate save, more coming soon.) |
(Finishing this doc. Adding explanation that it takes up to 5 key parameters, and error logs if it gets more.) |
||
| Line 12: | Line 12: | ||
:<code><nowiki>{{keypress|[[Alt key|Alt]]}}</nowiki></code> produces {{keypress|[[Alt key|Alt]]}} | :<code><nowiki>{{keypress|[[Alt key|Alt]]}}</nowiki></code> produces {{keypress|[[Alt key|Alt]]}} | ||
To illustrate | To illustrate keystroke combinations, just use extra parameters: | ||
:<code><nowiki>{{keypress|[[Alt key|Alt]]|P}}</nowiki></code> produces {{keypress|[[Alt key|Alt]]|P}} | :<code><nowiki>{{keypress|[[Alt key|Alt]]|P}}</nowiki></code> produces {{keypress|[[Alt key|Alt]]|P}} | ||
:<code><nowiki>{{keypress|[[Ctrl]]|Alt|Del}}</nowiki></code> produces {{keypress|[[Ctrl]]|Alt|Del}} | :<code><nowiki>{{keypress|[[Ctrl]]|Alt|Del}}</nowiki></code> produces {{keypress|[[Ctrl]]|Alt|Del}} | ||
| Line 29: | Line 29: | ||
:<code><nowiki>{{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}}</nowiki></code> produces {{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}} | :<code><nowiki>{{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}}</nowiki></code> produces {{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}} | ||
This template calls {{tl|keypress/core}}, which holds the code that otherwise would be repeated several times in {{tl|keypress}}, thus simplifying the code | 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 calls {{tl|keypress/core}}, which holds the code that otherwise would be repeated several times in {{tl|keypress}}, thus simplifying the code. | |||
=== See also === | === See also === | ||
Revision as of 17:34, 23 March 2009
This is the {{keypress}} template.
It can be used to illustrate keystrokes.
Example:
{{keypress|A}}produces A
If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:
{{keypress|[[Alt key|Alt]]}}produces Alt
To illustrate keystroke combinations, just use extra parameters:
Some key names have a fitting unicode character. This template automatically adds such "icons" to the following key names:
{{keypress|Shift}}produces ⇧ Shift{{keypress|Enter}}produces ↵ Enter{{keypress|Cmd}}produces ⌘ Cmd{{keypress|Opt}}produces ⌥ Opt{{keypress|Tab}}produces Tab ⇆{{keypress|Backspace}}produces ← Backspace
Technical details
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:
{{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}}produces 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 calls {{keypress/core}}, which holds the code that otherwise would be repeated several times in {{keypress}}, thus simplifying the code.
See also
- {{pskeypress}} – For PlayStation-style controllers.