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

From Xen
(Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> __NOTOC__ This is the {{tl|key press}} template, which can be used to illustr…")
 
m
 
(2 intermediate revisions by 2 users not shown)
Line 21: Line 21:
 
:<code><nowiki>{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}</nowiki></code> produces {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
 
:<code><nowiki>{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}</nowiki></code> produces {{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
  
On the other hand, to illustrate Windows [[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 [[plus-minus sign]] (±) can be entered by holding down the Alt key while typing <code>0177</code> (with the [[numeric keypad]]). This could be illustrated like this:
+
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]]). This could be illustrated like this:
  
 
:<code><nowiki>{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}</nowiki></code> produces {{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}
 
:<code><nowiki>{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}</nowiki></code> produces {{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}
Line 27: Line 27:
 
=== Wikilinks ===
 
=== Wikilinks ===
  
If there is an article about the key you can [[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:wikilink|wikilink]] the key's name like any other wiki text. Like this:
:<code><nowiki>{{key press|[[Alt key|Alt]]}}</nowiki></code> produces {{key press|[[Alt key|Alt]]}}
+
:<code><nowiki>{{key press|[[wikipedia:Alt key|Alt]]}}</nowiki></code> produces {{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 [[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>[[wikipedia:Control key|Ctrl]]</nowiki></code> instead of <code><nowiki>[[Ctrl]]</nowiki></code>, which leads to a [[wikipedia:Disambiguation page|disambiguation page]]).
  
 
=== Wiki characters ===
 
=== Wiki characters ===
  
Some wiki markup character, like the [[pipe symbol]], the [[semicolon]] and the [[equals sign]], need to be entered using the {{tl|!}}, {{tl|;}} and {{tl|{{=}}}} templates:
+
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:
  
 
:<code><nowiki>{{key press|{{!}}}}</nowiki></tt> produces {{key press|{{!}}}}
 
:<code><nowiki>{{key press|{{!}}}}</nowiki></tt> produces {{key press|{{!}}}}
Line 78: Line 78:
 
:<code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}
 
:<code><nowiki>{{key press|Right}}</nowiki></code> produces {{key press|Right}}
  
[[File:AltGr Win Menu Ctrl key.jpg|thumb|200px|Windows key and Menu key]]
 
[[File:Ctl wndws alt.jpg|thumb|200px|Old-style Windows key]]
 
  
There are no characters for the [[Windows key]] and [[Menu key]]. Besides, the Windows logo is [[trademark]]ed. So this template shows approximate characters for them in the following way:
+
There are no characters for the [[wikipedia:Windows key]] and [[wikipedia:Menu key]]. Besides, the Windows logo is [[wikipedia:trademark]]ed. So this template shows approximate characters for them in the following way:
  
 
:<code><nowiki>{{key press|Win}}</nowiki></code> produces {{key press|Win}}
 
:<code><nowiki>{{key press|Win}}</nowiki></code> produces {{key press|Win}}

Latest revision as of 22:16, 5 December 2011


This is the {{key press}} template, which can be used to illustrate keystrokes. Typographically it works best with examples that are separated from the normal flow of text, e.g. in table cells. It can also be used in lists (as in this page), but it may be a good idea to add an empty line between each list item, so the key borders won't overlap each other.

Example:

{{key press|A}} produces A

Keystroke combinations

To illustrate keystroke combinations, just use extra parameters:

{{key press|Alt|P}} produces Alt+P
{{key press|Ctrl|Alt|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.

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

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). This could be illustrated like this:

{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}} produces Alt+0177

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]]}} produces Alt

If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[wikipedia:Control key|Ctrl]] instead of [[Ctrl]], which leads to a disambiguation page).

Wiki 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:

{{key press|{{!}}}} produces |
{{key press|{{;}}}} produces ;
{{key press|{{=}}}} produces =

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

{{key press|[[|]]}} produces |
{{key press|[[;]]}} produces ;
{{key press|[[=]]}} produces =

If you don't want to mark the characters as links, {{key press|<nowiki>|</nowiki>}} is also an option.

Key symbols

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

{{key press|Caps Lock}} produces Caps Lock
{{key press|Shift}} produces Shift
{{key press|Enter}} produces Enter
{{key press|Tab}} produces Tab
{{key press|Backspace}} produces ← Backspace
{{key press|Cmd}} produces Cmd
{{key press|Opt}} produces Opt
{{key press|Up}} produces
{{key press|Down}} produces
{{key press|Left}} produces
{{key press|Right}} produces


There are no characters for the wikipedia:Windows key and wikipedia:Menu key. Besides, the Windows logo is wikipedia:trademarked. So this template shows approximate characters for them in the following way:

{{key press|Win}} produces Win
{{key press|Menu}} produces Menu

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.