Template:Key/doc: Difference between revisions
No edit summary |
m (Robot: Cosmetic changes) |
||
| Line 1: | Line 1: | ||
'''{{tl|key}}''' is a template most useful in giving instructions about how to use the wiki. It gives the user a way to make it absolutely obvious that you're referring to a key which needs to be pressed on a computer keyboard. | '''{{tl|key}}''' is a template most useful in giving instructions about how to use the wiki. It gives the user a way to make it absolutely obvious that you're referring to a key which needs to be pressed on a computer keyboard. | ||
==Usage== | == Usage == | ||
Without any modifiers, the template defaults to presenting the "enter" key. So the following sequence:<pre>{{key}}</pre>will produce {{key}} | Without any modifiers, the template defaults to presenting the "enter" key. So the following sequence:<pre>{{key}}</pre>will produce {{key}} | ||
If you want to specify another key, you'd enter it as an optional parameter. Thus, <pre>{{key|Tab}}</pre>results in {{key|Tab}} | If you want to specify another key, you'd enter it as an optional parameter. Thus, <pre>{{key|Tab}}</pre>results in {{key|Tab}} | ||
==Known issues== | == Known issues == | ||
Line breaks are not properly accepted by the template, so some keys can't be closely represented at the present time. For instance:<pre>{{key|Page<br>Down}}</pre>will render as {{key|Page<br>Down}} | Line breaks are not properly accepted by the template, so some keys can't be closely represented at the present time. For instance:<pre>{{key|Page<br>Down}}</pre>will render as {{key|Page<br />Down}} | ||
Though undesirable, this is not deemed to be a terribly high-priority item to fix, since most instruction on this wiki would not require referencing keys that are ordinarily seen on keyboards on two lines. | Though undesirable, this is not deemed to be a terribly high-priority item to fix, since most instruction on this wiki would not require referencing keys that are ordinarily seen on keyboards on two lines. | ||
Revision as of 22:17, 30 January 2012
{{key}} is a template most useful in giving instructions about how to use the wiki. It gives the user a way to make it absolutely obvious that you're referring to a key which needs to be pressed on a computer keyboard.
Usage
Without any modifiers, the template defaults to presenting the "enter" key. So the following sequence:
{{key}}will produce Enter If you want to specify another key, you'd enter it as an optional parameter. Thus,
{{key|Tab}}results in Tab
Known issues
Line breaks are not properly accepted by the template, so some keys can't be closely represented at the present time. For instance:
{{key|Page<br>Down}}will render as Page
Down
Though undesirable, this is not deemed to be a terribly high-priority item to fix, since most instruction on this wiki would not require referencing keys that are ordinarily seen on keyboards on two lines.
