Template:Key press/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>The Evil IP [email protected]
m (moved Template:Keypress/doc to Template:Key press/doc: per main page)
>The Evil IP [email protected]
(update pagename)
Line 2: Line 2:
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->


This is the {{tl|keypress}} template.
This is the {{tl|key press}} template.


It can be used to illustrate keystrokes.
It can be used to illustrate keystrokes.


Example:
Example:
:<code><nowiki>{{keypress|A}}</nowiki></code> produces {{keypress|A}}
:<code><nowiki>{{key press|A}}</nowiki></code> produces {{key press|A}}


If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:
If there is an article about the key you can wikilink the key's name like any other wiki text. Like this:
:<code><nowiki>{{keypress|[[Alt key|Alt]]}}</nowiki></code> produces {{keypress|[[Alt key|Alt]]}}
:<code><nowiki>{{key press|[[Alt key|Alt]]}}</nowiki></code> produces {{key press|[[Alt key|Alt]]}}


To illustrate keystroke combinations, just use extra parameters:
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>{{key press|[[Alt key|Alt]]|P}}</nowiki></code> produces {{key press|[[Alt key|Alt]]|P}}
:<code><nowiki>{{keypress|[[Ctrl]]|Alt|Del}}</nowiki></code> produces {{keypress|[[Ctrl]]|Alt|Del}}
:<code><nowiki>{{key press|[[Ctrl]]|Alt|Del}}</nowiki></code> produces {{key press|[[Ctrl]]|Alt|Del}}


=== Key symbols ===
=== Key symbols ===


Some key names have a fitting unicode character. This template automatically adds such "icons" to the following key names:
Some key names have a fitting unicode character. This template automatically adds such "icons" to the following key names:
:<code><nowiki>{{keypress|Shift}}</nowiki></code> produces {{keypress|Shift}}
:<code><nowiki>{{key press|Shift}}</nowiki></code> produces {{key press|Shift}}
:<code><nowiki>{{keypress|Enter}}</nowiki></code> produces {{keypress|Enter}}
:<code><nowiki>{{key press|Enter}}</nowiki></code> produces {{key press|Enter}}
:<code><nowiki>{{keypress|Cmd}}</nowiki></code> produces {{keypress|Cmd}}
:<code><nowiki>{{key press|Cmd}}</nowiki></code> produces {{key press|Cmd}}
:<code><nowiki>{{keypress|Opt}}</nowiki></code> produces {{keypress|Opt}}
:<code><nowiki>{{key press|Opt}}</nowiki></code> produces {{key press|Opt}}
:<code><nowiki>{{keypress|Tab}}</nowiki></code> produces {{keypress|Tab}}
:<code><nowiki>{{key press|Tab}}</nowiki></code> produces {{key press|Tab}}
:<code><nowiki>{{keypress|Backspace}}</nowiki></code> produces {{keypress|Backspace}}
:<code><nowiki>{{key press|Backspace}}</nowiki></code> produces {{key press|Backspace}}
:<code><nowiki>{{keypress|Eject}}</nowiki></code> produces {{keypress|Eject}}
:<code><nowiki>{{key press|Eject}}</nowiki></code> produces {{key press|Eject}}


:<code><nowiki>{{keypress|Up}}</nowiki></code> produces {{keypress|Up}}
:<code><nowiki>{{key press|Up}}</nowiki></code> produces {{key press|Up}}
:<code><nowiki>{{keypress|Down}}</nowiki></code> produces {{keypress|Down}}
:<code><nowiki>{{key press|Down}}</nowiki></code> produces {{key press|Down}}
:<code><nowiki>{{keypress|Left}}</nowiki></code> produces {{keypress|Left}}
:<code><nowiki>{{key press|Left}}</nowiki></code> produces {{key press|Left}}
:<code><nowiki>{{keypress|Right}}</nowiki></code> produces {{keypress|Right}}
:<code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}


[[File:Ctl wndws alt.jpg|thumb|100px|Windows key]]
[[File:Ctl wndws alt.jpg|thumb|100px|Windows key]]
Line 36: Line 36:
We have no characters for the [[Windows key]] and [[menu key]]. And we perhaps can't add the "real" icons for them for copyright reasons. So we usually show them the following way:
We have no characters for the [[Windows key]] and [[menu key]]. And we perhaps can't add the "real" icons for them for copyright reasons. So we usually show them the following way:


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


Line 43: Line 43:


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:
:<code><nowiki>{{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}}</nowiki></code> produces {{keypress|Ctrl}} + {{keypress|Alt}} + {{keypress|Del}}
:<code><nowiki>{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}</nowiki></code> produces {{key press|Ctrl}} + {{key press|Alt}} + {{key press|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. If it gets too many key name parameters it reports the page into [[:Category:Wikipedia key press 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.
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 ===
Line 55: Line 55:
<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Computing templates|{{PAGENAME}}]]
[[Category:Computing templates]]
[[Category:Graphic templates|{{PAGENAME}}]]
[[Category:Graphic templates]]


[[de:Vorlage:Taste]]
[[de:Vorlage:Taste]]

Revision as of 19:01, 24 May 2010


This is the {{key press}} template.

It can be used to illustrate keystrokes.

Example:

{{key press|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:

{{key press|[[Alt key|Alt]]}} produces Alt

To illustrate keystroke combinations, just use extra parameters:

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

Key symbols

Some key names have a fitting unicode character. This template automatically adds such "icons" to the following key names:

{{key press|Shift}} produces ⇧ Shift
{{key press|Enter}} produces ↵ Enter
{{key press|Cmd}} produces ⌘ Cmd
{{key press|Opt}} produces ⌥ Opt
{{key press|Tab}} produces Tab ⇆
{{key press|Backspace}} produces ← Backspace
{{key press|Eject}} produces Eject
{{key press|Up}} produces ↑
{{key press|Down}} produces ↓
{{key press|Left}} produces ←
{{key press|Right}} produces →
Windows key
Menu key

We have no characters for the Windows key and menu key. And we perhaps can't add the "real" icons for them for copyright reasons. So we usually show them the following way:

{{key press|Win}} or {{key press|Win key}} produces ⊞ Win or Win key
{{key press|Menu}} produces ≣ Menu

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:

{{key press|Ctrl}} + {{key press|Alt}} + {{key press|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 key press 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 {{key press/core}}, which holds the code that otherwise would be repeated several times in {{key press}}, thus simplifying the code.

See also

  • {{pskeypress}} – For PlayStation-style controllers.


Retrieved from "https://kodi.wiki/index.php?title=Template:Key_press/doc&oldid=47293"