Difference between revisions of "Template:Keypress/doc"
From MidrangeWiki
MrDolomite (talk | contribs) m (add example for optional 2nd parameter) |
MrDolomite (talk | contribs) (improving doc for parms 1-2-3 and optional background=) |
||
| Line 1: | Line 1: | ||
<includeonly>{{Template doc page transcluded}}</includeonly><noinclude>{{Template doc page viewed directly}}</noinclude> | <includeonly>{{Template doc page transcluded}}</includeonly><noinclude>{{Template doc page viewed directly}}</noinclude> | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
| − | == | + | =Documentation= |
| − | + | {{tl|keypress}} is a standard way to display one (1) to three (3) concurrent keyboard keystrokes, connected by the {{code|+}} sign if there are two or more parameters. | |
| + | |||
| + | ==Parameters== | ||
| + | *Positional parameter {{code|1}} is required and can be a single letter or string | ||
| + | *Positional parameters {{code|2}} and {{code|3}} are optional and can be single letters or strings | ||
| + | *Named parameter {{code|background}} is optional and is in one of the following formats: | ||
| + | :Six digit hex color code, including the leading {{code|#}} symbol | ||
| + | ::or | ||
| + | :The text name of one of the sixteen colors of the HTML 4.01 specification [[wikipedia:HTML color names|HTML color names]] | ||
| + | |||
| + | <pre>{{keypress | ||
| + | | letter(s) for first key box | ||
| + | | (optional parameter) letter(s) for second key box | ||
| + | | (optional parameter) letter(s) for third key box | ||
| + | | (optional parameter) background= | ||
| + | }}</pre> | ||
| + | |||
==Examples== | ==Examples== | ||
| − | + | {| style="position:relative; margin: 0 0 0.5em 1em; border-collapse: collapse; background:white; clear:right; text-align:center;" border="1" cellpadding="7" | |
| − | + | ! Code | |
| − | + | ! Result | |
| − | + | |- | |
| − | + | | colspan=2 | Single parameter, single letter | |
| − | + | |- | |
| − | + | |<pre>{{keypress|A}}</pre> | |
| − | + | |{{keypress|A}} | |
| − | + | |- | |
| − | <includeonly> | + | | colspan=2 | Single parameter, multiple letters |
| + | |- | ||
| + | |<pre>{{keypress|Shift}}</pre> | ||
| + | |{{keypress|Shift}} | ||
| + | |- | ||
| + | | colspan=2 | Multiple parameter, multiple letters | ||
| + | |- | ||
| + | |<pre>{{keypress|Ctrl|Alt|Del}}</pre> | ||
| + | |{{keypress|Ctrl|Alt|Del}} | ||
| + | |- | ||
| + | | colspan=2 | Multiple parameter, multiple letters with {{code|background}}<code>=</code> parameter | ||
| + | |- | ||
| + | |<pre>{{keypress|Shift|F3|background=#FF00FF}}</pre> | ||
| + | |{{keypress|Shift|F3|background=#FF00FF}} | ||
| + | |- | ||
| + | |<pre>{{keypress|Shift|F3|background=aqua}}</pre> | ||
| + | |{{keypress|Shift|F3|background=aqua}} | ||
| + | |}<includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | <!-- ADD CATEGORIES BELOW THIS LINE --> | ||
[[Category:Internal formatting templates|{{PAGENAME}}]] | [[Category:Internal formatting templates|{{PAGENAME}}]] | ||
</includeonly> | </includeonly> | ||
Revision as of 20:20, 24 February 2008
|
This is the template documentation page for {{Keypress}}. It is not intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs. |
Documentation
{{keypress}} is a standard way to display one (1) to three (3) concurrent keyboard keystrokes, connected by the + sign if there are two or more parameters.
Parameters
- Positional parameter
1is required and can be a single letter or string - Positional parameters
2and3are optional and can be single letters or strings - Named parameter
backgroundis optional and is in one of the following formats:
- Six digit hex color code, including the leading
#symbol- or
- The text name of one of the sixteen colors of the HTML 4.01 specification HTML color names
{{keypress
| letter(s) for first key box
| (optional parameter) letter(s) for second key box
| (optional parameter) letter(s) for third key box
| (optional parameter) background=
}}
Examples
| Code | Result |
|---|---|
| Single parameter, single letter | |
{{keypress|A}}
|
A |
| Single parameter, multiple letters | |
{{keypress|Shift}}
|
Shift |
| Multiple parameter, multiple letters | |
{{keypress|Ctrl|Alt|Del}}
|
Ctrl+Alt+Del |
Multiple parameter, multiple letters with background= parameter
| |
{{keypress|Shift|F3|background=#FF00FF}}
|
Shift+F3 |
{{keypress|Shift|F3|background=aqua}}
|
Shift+F3 |
