Wuffesan: /* Technical details */

2025-08-26T07:47:18Z

Technical details

← Older revision		Revision as of 00:47, 26 August 2025
Line 72:		Line 72:
	=== Technical details ===		=== Technical details ===

	This template calls {{tl\|~~link=~~key/core}}, which holds the code that otherwise would be repeated several times in {{tl\|key}}, thus simplifying the code.		This template calls {{tl\|key/core}}, which holds the code that otherwise would be repeated several times in {{tl\|key}}, thus simplifying the code.

	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|

Wuffesan: Created page with " ==Documentation== NOTOC This is the {{tl|key}} template, which can be used to illustrate keystrokes. This template also illustrate mouse buttons aswell. Example: :`{{key|A}}` produces {{key|A}} :`{{key|~}}` produces {{key|~}} === Keystroke combinations === To..."

2025-08-26T07:41:35Z

Created page with " ==Documentation==  __NOTOC__ This is the {{tl|key}} template, which can be used to illustrate keystrokes. This template also illustrate mouse buttons aswell. Example: :<code><nowiki>{{key|A}}</nowiki></code> produces {{key|A}} :<code><nowiki>{{key|~}}</nowiki></code> produces {{key|~}} === Keystroke combinations === To..."

New page

==Documentation==

__NOTOC__

This is the {{tl|key}} template, which can be used to illustrate keystrokes. This template also illustrate mouse buttons aswell.

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

=== Keystroke combinations ===

To illustrate keystroke combinations, just use extra parameters:
:<code><nowiki>{{key|Alt|P}}</nowiki></code> produces {{key|Alt|P}}

:<code><nowiki>{{key|Ctrl|Alt|Del}}</nowiki></code> produces {{key|Ctrl|Alt|Del}}

This template currently handles up to 5 key name 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:

:<code><nowiki>{{key|Ctrl}} + {{key|Alt}} + {{key|Del}}</nowiki></code> produces {{key|Ctrl}} + {{key|Alt}} + {{key|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 [[Wikipedia:plus-minus sign|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:

:<code><nowiki>{{key|Alt|0}}{{key|1}}{{key|7}}{{key|7}}</nowiki></code> produces {{key|Alt|0}}{{key|1}}{{key|7}}{{key|7}}

=== Wikilinks ===

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

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

:<code><nowiki>{{key|{{!}}}}</nowiki></code> produces {{key|{{!}}}}

:<code><nowiki>{{key|{{;}}}}</nowiki></code> produces {{key|{{;}}}}

:<code><nowiki>{{key|{{=}}}}</nowiki></code> produces {{key|{{=}}}}

=== Key symbols ===

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

:<code><nowiki>{{key|Caps Lock}}</nowiki></code> produces {{key|Caps Lock}}
:<code><nowiki>{{key|Shift}}</nowiki></code> produces {{key|Shift}}
:<code><nowiki>{{key|Enter}}</nowiki></code> produces {{key|Enter}}
:<code><nowiki>{{key|Tab}}</nowiki></code> produces {{key|Tab}}
:<code><nowiki>{{key|Backspace}}</nowiki></code> produces {{key|Backspace}}
:<code><nowiki>{{key|Cmd}}</nowiki></code> produces {{key|Cmd}}
:<code><nowiki>{{key|Opt}}</nowiki></code> produces {{key|Opt}}
:<code><nowiki>{{key|Up}}</nowiki></code> produces {{key|Up}}
:<code><nowiki>{{key|Down}}</nowiki></code> produces {{key|Down}}
:<code><nowiki>{{key|Left}}</nowiki></code> produces {{key|Left}}
:<code><nowiki>{{key|Right}}</nowiki></code> produces {{key|Right}}

There are no characters for the Windows key and Menu key. So this template shows approximate characters for them in the following way:

:<code><nowiki>{{key|Win}}</nowiki></code> produces {{key|Win}}
:<code><nowiki>{{key|Menu}}</nowiki></code> produces {{key|Menu}}

=== Mouse icons ===
:<code><nowiki>{{key|LMB}}</nowiki> or <nowiki>{{key|MOUSE1}}</nowiki></code> produces {{key|LMB}}
:<code><nowiki>{{key|RMB}}</nowiki> or <nowiki>{{key|MOUSE2}}</nowiki></code> produces {{key|RMB}}
:<code><nowiki>{{key|MMB}}</nowiki> or <nowiki>{{key|MOUSE3}}</nowiki></code> produces {{key|MMB}}
:<code><nowiki>{{key|MOUSE4}}</nowiki></code> produces {{key|MOUSE4}}
:<code><nowiki>{{key|MOUSE5}}</nowiki></code> produces {{key|MOUSE5}}

=== Technical details ===

This template calls {{tl|link=key/core}}, which holds the code that otherwise would be repeated several times in {{tl|key}}, thus simplifying the code.

<includeonly>{{sandbox other||


}}</includeonly>

Template:Key/doc - Revision history

Wuffesan: /* Technical details */

Wuffesan: Created page with " ==Documentation== __NOTOC__ This is the {{tl|key}} template, which can be used to illustrate keystrokes. This template also illustrate mouse buttons aswell. Example: :{{key|A}} produces {{key|A}} :{{key|~}} produces {{key|~}} === Keystroke combinations === To..."

Wuffesan: Created page with " ==Documentation== NOTOC This is the {{tl|key}} template, which can be used to illustrate keystrokes. This template also illustrate mouse buttons aswell. Example: :`{{key|A}}` produces {{key|A}} :`{{key|~}}` produces {{key|~}} === Keystroke combinations === To..."