قالب:Key press/doc
 | هذه صفحة توثيق فرعية لـ قالب:Key press. تتضمن معلومات الاستعمال، التصنيفات وأي محتوى آخر ليس من محتويات الأصل لصفحة القالب. |
This is the {{key press}} template primarily designed to illustrate keys and keystrokes on a computer keyboard. With additional parameters, a single template can even illustrate a combination of multiple simultaneous keystrokes. A sequence of keystrokes, on the other hand, need to be demonstrated with separate templates.
Example:
{{key press|A}}→ A
Keystroke combinations
To illustrate keystroke combinations, just use extra parameters:
{{key press|Alt|P}}→ Alt+P{{key press|Ctrl|Alt|Del}}→ Ctrl+Alt+Del
This template currently handles up to 10 key name parameters, which should be more than enough to accommodate for any possible combination of simultaneous keystrokes. 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 "+" (or whatever the contents of the optional chain parameter) 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:
{{key press|Ctrl}}+{{key press|Alt}}+{{key press|Del}}→ Ctrl + Alt + Del{{key press|Ctrl|Alt|Del|chain= + }}→ Ctrl + Alt + Del
On the other hand, to illustrate Windows 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 plus-minus sign (±) can be entered by holding down the Alt key while typing 0177 (with the numeric keypad):
{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}→ Alt+0177
An example of a use case where more than 5 might be used is explaining usage of a macro (keyboard shortcut) created by a third-party application:
{{Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}}→ Ctrl+Alt+⇧ Shift+⊞ Win+≣ Menu+fn+L
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|[[Alt key|Alt]]}}→ Alt
If you are wikilinking the keys, please ensure that you are piping to the correct page (e.g. [[Control key|Ctrl]] instead of [[Ctrl]], which leads to a disambiguation page).
Wiki markup characters
Some wiki markup character, like the pipe symbol, the semicolon and the equals sign, need to be entered using the {{!}}, {{;}} and {{=}} templates or as an HTML entity |, ;, = respectively:
{{key press|→ |{{!}}}}{{key press||}}→ |{{key press|→ ;{{;}}}}{{key press|;}}→ ;{{key press|→ ={{=}}}}{{key press|=}}→ =
However, if the characters are marked as wikilinks, they can be entered as such:
Most markup characters also have aliases:
{{key press|pipe}}→ |{{key press|semicolon}}→ ;{{key press|equals}}→ ={{key press|colon}}→ :{{key press|asterisk}}→ *{{key press|hash}}→ #
Key symbols
Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others (see also Arrows exception below).
{{key press|Shift}}→ ⇧ Shift{{key press|Tab}}→ Tab ↹{{key press|Enter}}→ ↵ Enter{{key press|Option}}→ ⌥ Option{{key press|Opt}}→ ⌥ Opt{{key press|Command}}→ ⌘ Command{{key press|Cmd}}→ ⌘ Cmd{{key press|Caps Lock}}→ ⇪ Caps Lock{{key press|Scroll Lock}}→ Scroll Lock{{key press|Up}}→ ↑{{key press|Down}}→ ↓{{key press|Left}}→ ←{{key press|Right}}→ →
There are no characters for the Windows key and Menu key. Besides, the Windows logo is trademarked. So this template shows approximate characters for them in the following way:
{{key press|Win}}→ ⊞ Win{{key press|Menu}}→ ≣ Menu
Video games
Video game controllers often have specialized input labels that do not map easily. The following are mappings for various game consoles and input features.
Directional input
The following should only be used when the input sequence uses something other than the primary input or mixes input between directional devices.
{{key press|l-down}}→ L↓{{key press|c-left}}→ C←{{key press|r-up}}→ R↑
Stick specific diagonals are also supported:
{{key press|l-nw}}→ L↖{{key press|c-se}}→ C↘{{key press|r-ne}}→ R↗
PlayStation
{{key press|ex}}→ ×{{key press|circle}}→ ○{{key press|triangle}}→ △{{key press|square}}→ □
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.
TemplateData
Key press
Illustrates keys and keystrokes on a computer keyboard. Keys can include: Ctrl, Alt, Del, Opt, Menu, Left etc. console keys: ex, circle, triangle, square, and left right and center analog sticks: l-down, c-left, r-ne. The names are case insensitive.
| وسيط | وصف | نوع | حالة | |
|---|---|---|---|---|
| First key | 1 | First key | سطر | مطلوب |
| Second key | 2 | Optional key press in combination as the first. | سطر | اختياري |
| Third key | 3 | Optional key press in combination as the first. | سطر | اختياري |
| Forth key | 4 | Optional key press in combination as the first. | سطر | اختياري |
| Fifth key | 5 | Optional key press in combination as the first. | سطر | اختياري |
| Sixth key | 6 | Optional key press in combination as the first. | سطر | اختياري |
| Seventh key | 7 | Optional key press in combination as the first. | سطر | اختياري |
| Eighth key | 8 | Optional key press in combination as the first. | سطر | اختياري |
| Ninth key | 9 | Optional key press in combination as the first. | سطر | اختياري |
| Tenth key | 10 | Optional key press in combination as the first. | سطر | اختياري |
| Chaining character | chain | Character between chained key presses
| سطر | اختياري |
| Chaining character | chain first | Character between first and second key to press
| سطر | اختياري |
| Chaining character | chain second | Character between second and third key to press
| سطر | اختياري |
| Chaining character | chain third | Character between third and fourth key to press
| سطر | اختياري |
| Chaining character | chain fourth | Character between fourth and fifth key to press
| سطر | اختياري |
See also
- {{strong}} – For semantically indicating strong emphasis instead of simple typographical boldfacing.
- {{strongbad}} – Same as
{{strong}}but red like this: "Never use{{strongbad}}in articles." - {{stronggood}} – Same as
{{strongbad}}but green like this: "Only use{{stronggood}}on non-article pages." - {{em}} – Similar template for semantically indicating mild emphasis instead of simple typographical italicization.
- {{var}} – Same as {{varserif}} use for all variables (e.g. strIllustratePrefix), except for "I" (upper-case i) and "l" (lower-case L), for which use {{varserif}}.
- {{varserif}} – Same as {{var}} but uses serif font (e.g. strIllustratePrefix), especially for distinguishing between "I" (upper-case i) and "l" (lower-case L) as variables.
- {{wikivar}} – For displaying wikicode variables and magicwords as they would appear in source code, e.g.
{{PAGENAME}},{{DEFAULTSORT:Lastname, Firstname}}. - {{para}} – For displaying wiki template parameters (
|title=) or parameters and values (|year=2008). - {{tlx}} and related – For displaying entire templates (with or without parameters and values) as code.
- {{tag}} – For using HTML elements ("tags") in prose (e.g. "When coding HTML
<img>...</img>tags, always include …"). - {{code}} – For computer source code (e.g. "always include the
alt={{var}}inside, use<code>...</code>instead of{{code}}.) - {{syntaxhighlight}} or {{sxhl}} – Wrapper for
<syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text. - {{deprecated code}} or {{dc}} – For deprecated source code in template documentation, articles on HTML specs, etc.
- {{pre}} – For larger blocks of source code and other pre-formatted text.
- {{bq}} – For indented blocks of content, such as block quotations, examples, poems, etc.
- {{kbd}} – For indicating user input.
- {{key press}} – For indicating the input of specific keystrokes, e.g. CtrlX.
- {{PlayStation key press}} – For indicating PlayStation-style gamepad key presses, e.g. قالب:Pskeypress.
- {{samp}} – For example output.
Not to be confused with
- {{Button}} – Produces a similar visual effect, but without the semantic markup, e.g. sample text.