RMN at 17:30, 28 December 2015

2015-12-28T17:30:40Z

← Older revision		Revision as of 20:30, 28 December 2015
Line 75:		Line 75:
	''Todo:''		''Todo:''

	The template also supports lang parameter which ~~overwrites~~ {{Tc\|PageLang}}, e.g. on page with {{Tc\|PageLang\|de}} {{Tc\|Hotkey\|Ctrl\|A}} will produce {{Hotkey\|Strg\|A}} and {{Tc\|Hotkey\|lang{{=}}en\|Ctrl\|A}} will display {{Hotkey\|Ctrl\|A}}.		The template also supports lang parameter which overrides {{Tc\|PageLang}}, e.g. on page with {{Tc\|PageLang\|de}} {{Tc\|Hotkey\|Ctrl\|A}} will produce {{Hotkey\|Strg\|A}} and {{Tc\|Hotkey\|lang{{=}}en\|Ctrl\|A}} will display {{Hotkey\|Ctrl\|A}}.

	== Technical details ==		== Technical details ==

RMN: +note about "lang" parameter

2015-12-27T21:32:06Z

+note about "lang" parameter

← Older revision		Revision as of 00:32, 28 December 2015
Line 74:		Line 74:
	== Language support ==		== Language support ==
	''Todo:''		''Todo:''

			The template also supports lang parameter which overwrites {{Tc\|PageLang}}, e.g. on page with {{Tc\|PageLang\|de}} {{Tc\|Hotkey\|Ctrl\|A}} will produce {{Hotkey\|Strg\|A}} and {{Tc\|Hotkey\|lang{{=}}en\|Ctrl\|A}} will display {{Hotkey\|Ctrl\|A}}.

	== Technical details ==		== Technical details ==

Goraf: +cat.

2015-12-02T12:56:11Z

+cat.

← Older revision		Revision as of 15:56, 2 December 2015
Line 79:		Line 79:

	== See also ==		== See also ==
			''Todo:''

	<includeonly>		<includeonly>
	<!-- Categories go here -->		<!-- Categories go here -->
			[[Category:Formatting and function templates]]
	</includeonly>		</includeonly>

Goraf: partial documentation

2015-12-02T12:53:45Z

partial documentation

New page

{{Documentation subpage}}
{{Lua|Module:Keys}}
{{Todo|finish}}

This is the {{Tl|Hotkey}} 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.

Example
: {{Tc|Hotkey|A}} → {{Hotkey|A}}

== Usage ==

=== Keystroke combinations ===
To illustrate keystroke combinations, just use extra parameters:
: {{Tc|Hotkey|Alt|P}} → {{Hotkey|Alt|P}}
: {{Tc|Hotkey|Ctrl|Alt|Del}} → {{Hotkey|Ctrl|Alt|Del}}

This template has no limit of the key name parameters.

{{Todo|add line wrap ability}}
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:
: {{Tc|Hotkey|Ctrl}} + {{Tc|Hotkey|Alt}} + {{Tc|Hotkey|Del}} → {{Hotkey|Ctrl}} + {{Hotkey|Alt}} + {{Hotkey|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 <code>0177</code> (with the numeric keypad):
: {{Tc|Hotkey|Alt|0}}{{Tc|Hotkey|1}}{{Tc|Hotkey|7}}{{Tc|Hotkey|7}} → {{Hotkey|Alt|0}}{{Hotkey|1}}{{Hotkey|7}}{{Hotkey|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:
: {{Tc|Hotkey|Ctrl|Alt|Shift|Win|Menu|fn|L}} → {{Hotkey|Ctrl|Alt|Shift|Win|Menu|fn|L}}

=== Wiki markup characters ===
Only two wiki markup character, pipe symbol and the equals sign, need to be entered using the {{Tl|!}} and {{Tl|{{=}}}} templates to be dispayed correctly:
* {{Tc|Hotkey|{{Lb}}!{{Rb}}}} → {{Hotkey|{{!}}}}
* {{Tc|Hotkey|{{Lb}}={{Rb}}}} → {{Hotkey|{{=}}}}
But they can also be displayed using the aliases:
* {{Tc|Hotkey|pipe}} → {{Hotkey|pipe}}
* {{Tc|Hotkey|equals}} → {{Hotkey|equals}}

=== Key symbols ===
Some key names have a fitting Unicode character. This template automatically adds such "icons" to the following key names among others.

'''List of all supported key symbols can be found at [[Module:Keys/Symbols]].'''

* {{Tc|Hotkey|Shift}} → {{Hotkey|Shift}}
* {{Tc|Hotkey|Tab}} → {{Hotkey|Tab}}
* {{Tc|Hotkey|Enter}} → {{Hotkey|Enter}}
* {{Tc|Hotkey|Option}} → {{Hotkey|Option}}
* {{Tc|Hotkey|Opt}} → {{Hotkey|Opt}}
* {{Tc|Hotkey|Command}} → {{Hotkey|Command}}
* {{Tc|Hotkey|Cmd}} → {{Hotkey|Cmd}}
* {{Tc|Hotkey|Caps Lock}} → {{Hotkey|Caps Lock}}
* {{Tc|Hotkey|Up}} → {{Hotkey|Up}}
* {{Tc|Hotkey|Down}} → {{Hotkey|Down}}
* {{Tc|Hotkey|Left}} → {{Hotkey|Left}}
* {{Tc|Hotkey|Right}} → {{Hotkey|Right}}

There are no characters for the Windows key and Menu key. So this template shows approximate characters for them, namely the 'SQUARED PLUS' and 'STRICTLY EQUIVALENT TO' from the Mathematical Operators block:
* {{Tc|Hotkey|Win}} → {{Hotkey|Win}}
* {{Tc|Hotkey|Menu}} → {{Hotkey|Menu}}

=== Mouse key symbols ===
Mouse keys and mouse wheel can be displayed using the appropriate names:
* {{Tc|Hotkey|LMB}} → {{Hotkey|LMB}}
* {{Tc|Hotkey|MMB}} → {{Hotkey|MMB}}
* {{Tc|Hotkey|RMB}} → {{Hotkey|RMB}}
* {{Tc|Hotkey|WheelUp}} → {{Hotkey|WheelUp}}
* {{Tc|Hotkey|WheelDown}} → {{Hotkey|WheelDown}}
* {{Tc|Hotkey|Wheel}} → {{Hotkey|Wheel}}

You can also show a double clicks:
* {{Tc|Hotkey|2xLMB}} → {{Hotkey|2xLMB}}
* {{Tc|Hotkey|2xMMB}} → {{Hotkey|2xMMB}}
* {{Tc|Hotkey|2xRMB}} → {{Hotkey|2xRMB}}

== Language support ==
''Todo:''

== Technical details ==
''Todo:''

== See also ==

<includeonly>


</includeonly>

Template:Hotkey/doc - Revision history

RMN at 17:30, 28 December 2015

RMN: +note about "lang" parameter

Goraf: +cat.

Goraf: partial documentation