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

From Wazeopedia
(Updated)
m (8 revisions imported)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Waze is a fun and sophisticated navigation app. In most developed countries Waze provides superior navigation information over commercial GPS applications. Like any developing application, there are issues and complications that are being worked to resolve. Many of them are cosmetic and do not prevent a fully gratifying experience when using Waze.
+
{{Documentation subpage}}
 +
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS LINKS AT THE END OF THIS PAGE. -->
 +
__NOTOC__
  
Temporary issues are tracked in the official [http://status.waze.com/ Waze server status and issues] page.
+
This is the {{tl|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.
  
The Waze community reports and tracks bugs and problems in the [[Bugzilla|Waze Bugzilla]] application. It it is best place to identify any currently known issues.
+
Example:
 +
:{{tlx|key press|A}} → {{key press|A}}
 +
:{{tlx|key press|A}} → {{key press|A}}
  
Some of the more common issues include:
+
=== Keystroke combinations ===
{{Current problems}}
 
  
<!-- do not include this template when transcluded -->
+
To illustrate keystroke combinations, just use extra parameters:
<noinclude>[[Category:Review Purpose]]</noinclude>
+
:{{tlx|key press|Alt|P}} → {{key press|Alt|P}}
 +
:{{tlx|key press|Ctrl|Alt|Del}} → {{key press|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: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:
 +
:{{tlx|key press|Ctrl}} + {{tlx|key press|Alt}} + {{tlx|key press|Del}} →
 +
::{{key press|Ctrl}} + {{key press|Alt}} + {{key press|Del}}
 +
:{{tlx|key press|Ctrl|Alt|Del|5=chain=&amp;#32;+&amp;#32;}} →
 +
::{{key press|Ctrl|Alt|Del|chain=&#32;+&#32;}}
 +
 
 +
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]]):
 +
:{{tlx|key press|Alt|0}}{{tlx|key press|1}}{{tlx|key press|7}}{{tlx|key press|7}} →
 +
::{{key press|Alt|0}}{{key press|1}}{{key press|7}}{{key press|7}}
 +
 
 +
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:
 +
:{{tlx|Key press|Ctrl|Alt|Shift|Win|Menu|fn|L}} →
 +
::{{Key press|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:
 +
* {{tlx|key press|<nowiki>[[Alt key|Alt]]</nowiki>}} → {{key press|[[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]]).
 +
 
 +
=== Wiki markup 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 or as an [[HTML entity]] &amp;#124;, &amp;#59;, &amp;#61; respectively:
 +
* {{tlx|key press|{{tlx|!}}}} → {{key press|{{!}}}}
 +
* {{tlx|key press|&amp;#124;}} → {{key press|&#124;}}
 +
* {{tlx|key press|{{tlx|&#59;}}}} → {{key press|{{;}}}}
 +
* {{tlx|key press|&amp;#59;}} →  {{key press|&#59;}}
 +
* {{tlx|key press|{{tlx|&#61;}}}} → {{key press|{{=}}}}
 +
* {{tlx|key press|&amp;#61;}} →  {{key press|&#61;}}
 +
 
 +
However, if the characters are marked as wikilinks, they can be entered as such:
 +
* {{tlx|key press|<nowiki>[[&#124;]]</nowiki>}} → {{key press|[[|]]}}
 +
* {{tlx|key press|<nowiki>[[;]]</nowiki>}} → {{key press|[[;]]}}
 +
* {{tlx|key press|<nowiki>[[=]]</nowiki>}} → {{key press|[[=]]}}
 +
 
 +
Most markup characters also have aliases:
 +
* {{tlx|key press|pipe}} → {{key press|pipe}}
 +
* {{tlx|key press|semicolon}} → {{key press|semicolon}}
 +
* {{tlx|key press|equals}} → {{key press|equals}}
 +
* {{tlx|key press|colon}} → {{key press|colon}}
 +
* {{tlx|key press|asterisk}} → {{key press|asterisk}}
 +
* {{tlx|key press|hash}} → {{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).
 +
* {{tlx|key press|Shift}} → {{key press|Shift}}
 +
* {{tlx|key press|Tab}} → {{key press|Tab}}
 +
* {{tlx|key press|Enter}} → {{key press|Enter}}
 +
* {{tlx|key press|Option}} → {{key press|Option}}
 +
* {{tlx|key press|Opt}} → {{key press|Opt}}
 +
* {{tlx|key press|Command}} → {{key press|Command}}
 +
* {{tlx|key press|Cmd}} → {{key press|Cmd}}
 +
* {{tlx|key press|Caps Lock}} → {{key press|Caps Lock}}
 +
* {{tlx|key press|Scroll Lock}} → {{key press|Scroll Lock}}
 +
* {{tlx|key press|Up}} → {{key press|Up}}
 +
* {{tlx|key press|Down}} → {{key press|Down}}
 +
* {{tlx|key press|Left}} → {{key press|Left}}
 +
* {{tlx|key press|Right}} → {{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 trademarked. So this template shows approximate characters for them in the following way:
 +
* {{tlx|key press|Win}} → {{key press|Win}}
 +
* {{tlx|key press|Menu}} → {{key press|Menu}}
 +
 
 +
<!-- This is for other keyboard systems as it existed in Wikipedia; kept for reference only
 +
==== 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.
 +
 
 +
* {{tlx|key press|l-down}} → {{key press|l-down}}
 +
* {{tlx|key press|c-left}} → {{key press|c-left}}
 +
* {{tlx|key press|r-up}} → {{key press|r-up}}
 +
 
 +
Stick specific diagonals are also supported:
 +
 
 +
* {{tlx|key press|l-nw}} → {{key press|l-nw}}
 +
* {{tlx|key press|c-se}} → {{key press|c-se}}
 +
* {{tlx|key press|r-ne}} → {{key press|r-ne}}
 +
 
 +
===== PlayStation =====
 +
 
 +
* {{tlx|key press|ex}} → {{key press|ex}}
 +
* {{tlx|key press|circle}} → {{key press|circle}}
 +
* {{tlx|key press|triangle}} → {{key press|triangle}}
 +
* {{tlx|key press|square}} → {{key press|square}}
 +
-->
 +
{{clear}}
 +
 
 +
=== Technical details ===
 +
 
 +
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.
 +
 
 +
=== TemplateData ===
 +
 
 +
{{TemplateDataHeader}}
 +
<templatedata>
 +
{
 +
"description": "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.",
 +
"params": {
 +
"1": {
 +
"label": "First key",
 +
"description": "First key",
 +
"type": "string/line",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Second key",
 +
"description": "Optional key press in combination as the first.",
 +
"type": "string/line",
 +
"required": false
 +
},
 +
"3": {
 +
"label": "Third key",
 +
"inherits": "2"
 +
},
 +
"4": {
 +
"label": "Forth key",
 +
"inherits": "2"
 +
},
 +
"5": {
 +
"label": "Fifth key",
 +
"inherits": "2"
 +
},
 +
"6": {
 +
"label": "Sixth key",
 +
"inherits": "2"
 +
},
 +
"7": {
 +
"label": "Seventh key",
 +
"inherits": "2"
 +
},
 +
"8": {
 +
"label": "Eighth key",
 +
"inherits": "2"
 +
},
 +
"9": {
 +
"label": "Ninth key",
 +
"inherits": "2"
 +
},
 +
"10": {
 +
"label": "Tenth key",
 +
"inherits": "2"
 +
},
 +
"chain": {
 +
"label": "Chaining character",
 +
"description": "Character between chained key presses",
 +
"default": "+",
 +
"inherits": "2"
 +
},
 +
"chain first": {
 +
"description": "Character between first and second key to press",
 +
"inherits": "chain"
 +
},
 +
"chain second": {
 +
"description": "Character between second and third key to press",
 +
"inherits": "chain"
 +
},
 +
"chain third": {
 +
"description": "Character between third and fourth key to press",
 +
"inherits": "chain"
 +
},
 +
"chain fourth": {
 +
"description": "Character between fourth and fifth key to press",
 +
"inherits": "chain"
 +
}
 +
}
 +
}
 +
</templatedata>
 +
 
 +
==== Not to be confused with ====
 +
* {{tl|Button}} – Produces a similar visual effect, but without the semantic markup, e.g. {{Button|sample text}}.
 +
 
 +
<includeonly>
 +
 
 +
<!-- CATEGORY LINKS HERE, THANKS -->
 +
 
 +
[[Category:Programming typing-aid templates]]
 +
<!-- [[Category:Graphic templates]] - Don't add this one; this isn't a graphic template, as it's all done in CSS. -->
 +
[[Category:Semantic markup templates]]
 +
[[Category:Computer keys]]
 +
[[Category:Incomplete templates]]
 +
 
 +
</includeonly>

Latest revision as of 10:56, 30 November 2015

This is a documentation subpage for Template:Key press.
It contains usage information, categories and other content that is not part of the original template page.


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
{{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: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=&#32;+&#32;}}
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:

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 &#124;, &#59;, &#61; respectively:

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

Most markup characters also have aliases:

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).

File:AltGr Win Menu Ctrl key.jpg
Windows key and Menu key
File:Ctl wndws alt.jpg
Old-style Windows key

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:

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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.

Template parameters

ParameterDescriptionTypeStatus
First key1

First key

Default
empty
Example
empty
Auto value
empty
Linerequired
Second key2

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Third key3

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Forth key4

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Fifth key5

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Sixth key6

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Seventh key7

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Eighth key8

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Ninth key9

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Tenth key10

Optional key press in combination as the first.

Default
empty
Example
empty
Auto value
empty
Lineoptional
Chaining characterchain

Character between chained key presses

Default
+
Example
empty
Auto value
empty
Lineoptional
Chaining characterchain first

Character between first and second key to press

Default
+
Example
empty
Auto value
empty
Lineoptional
Chaining characterchain second

Character between second and third key to press

Default
+
Example
empty
Auto value
empty
Lineoptional
Chaining characterchain third

Character between third and fourth key to press

Default
+
Example
empty
Auto value
empty
Lineoptional
Chaining characterchain fourth

Character between fourth and fifth key to press

Default
+
Example
empty
Auto value
empty
Lineoptional

Not to be confused with

  • {{Button}} – Produces a similar visual effect, but without the semantic markup, e.g. sample text.