Template:Key/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
(Created page with "'''{{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...")
 
No edit summary
Line 4: Line 4:


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==
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 can also be accepted by the template, so that keys may be represented more closely to their actual appearances on most keyboards. 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.

Revision as of 23:18, 29 September 2011

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