Template:Key/doc: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
m (Removed some stray syntax at the end)
(Simplifying. Removing all mention of the named console, keyboard, and key parameters because they're not necessary and only seem to cause confusion. Added improved examples and made some corrections.)
Line 8: Line 8:


=== Keyboard ===
=== Keyboard ===
If using the template for keyboard keys, there is only one required input. For mouse usage, see the [[#Consoles and controllers]], using "mouse" as the console.
'''<code><nowiki>{{</nowiki>key | keyboard = ''keyboard key'' | keyboardvariant = ''dark or light'' <nowiki>}}</nowiki></code>'''
'''<code><nowiki>{{</nowiki>key | ''button'' <nowiki>}}</nowiki></code>'''
* <code>button</code> is the keyboard key to be pressed. Some key inputs, such as Shift or Tab will automatically add symbols or other formatting. Any other inputs will be output as they are with the first letter capitalized.
* ''Optional'': there is an additional parameter, <code>keyboardvariant</code> which determines whether the key is dark text on a light key (default) or the inverse. This will likely never be used, and if a wiki would prefer light on dark, it should be changed as the default.


====Example====
* The <code>keyboard</code> parameter is the keyboard key to be pressed.
<pre>Press {{Key|Shift}} and {{Key|F}} at the same time.</pre>
* The <code>keyboardvariant</code> parameter is the graphic style and is not required - the template defaults to <code>dark</code>, rendering a white key with black text. Enter <code>dark</code> for dark wikis, or <code>light</code> for light wikis.
produces:<br/>
Press {{Key|Shift}} and {{Key|F}} at the same time.


=== Controller ===
=== Consoles and controllers ===
'''<code><nowiki>{{</nowiki>key | console = ''console type'' | key = ''controller button'' | size = ''optional size'' <nowiki>}}</nowiki></code>'''
'''<code><nowiki>{{</nowiki>key | ''console'' | ''button'' | size = ''optional size'' <nowiki>}}</nowiki></code>'''


* The <code>console</code> parameter is used to state which console the key belongs to. The parameter is '''not''' case-sensitive. See [[Template:Key/library]] for possible values.
* <code>console</code> is the console the key belongs to. The parameter is '''not''' case-sensitive and supports many possible consoles. See [[Template:Key/library]] for possible values.
* The <code>button</code> parameter is the button to be pressed, such as "A" or "Cross". Note that this template uses the registered trademark names, i.e. "cross" instead of "X" for Playstation buttons, but the template has alternative spellings and entries included. See [[Template:Key/library]] for possible values.
* <code>button</code> is the button to be pressed, such as "A" or "Right Trigger". While the template tries to be intuitive such that the correct input for a button is whatever you think it is, if your attempt at a button isn't working, see [[Template:Key/library]] for possible values.
* The <code>size</code> parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 50px.
* The <code>size</code> parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 20px.


== Examples ==
====Example====
<pre>Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}}</pre>
=== Keyboard ===
produces:<br/>
The <code>keyboardvariant</code> parameter does not usually need to be entered explicitly. A default is generally set during a wiki's spinup. The parameter is used here to illustrate the two available versions.
Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}}


⚫
== Changing the default color ==
{{key
⚫
The default color for the keyboard and mouse is suitable for dark-skinned wikis. To change the default settings so it fits for a light-skinned wiki, without having to use <code>keyboardvariant = light</code> each time, you can search for and change these sections in the template:
| keyboard = caps lock
| keyboardvariant = dark
}}
<pre style="width: 450px;">
{{key
| keyboard = caps lock
| keyboardvariant = dark
}}
</pre>

Or for light wikis:

{{key
| keyboard = caps lock
| keyboardvariant = light
}}
<pre style="width: 450px;">
{{key
| keyboard = caps lock
| keyboardvariant = light
}}
</pre>

Keyboard keys can be entered in shorthand like this:
{{key|caps lock}}
<pre style="width: 450px;">
{{key|caps lock}}
</pre>

=== Controller ===
<hr>
{{key
| console = 360
| key = A
| size = 50px
}}
<pre style="width: 450px;">
{{key
| console = 360
| key = A
| size = 50px
}}
</pre>

⚫
== Change the default colour ==
⚫
The default colour for the keyboard and mouse is suitable for dark-skinned wikis. To change the default settings so it fits for a light-skinned wiki, without having to use <code>keyboardvariant = light</code> each time, you can search for and change these sections in the template:




Revision as of 19:33, 22 August 2019

Template:Doc/start When used, this template displays game controls, supporting both keyboard keys and controller buttons.

Usage

Keyboard

If using the template for keyboard keys, there is only one required input. For mouse usage, see the #Consoles and controllers, using "mouse" as the console. {{key | button }}

  • button is the keyboard key to be pressed. Some key inputs, such as Shift or Tab will automatically add symbols or other formatting. Any other inputs will be output as they are with the first letter capitalized.
  • Optional: there is an additional parameter, keyboardvariant which determines whether the key is dark text on a light key (default) or the inverse. This will likely never be used, and if a wiki would prefer light on dark, it should be changed as the default.

Example

Press {{Key|Shift}} and {{Key|F}} at the same time.

produces:
Press {{#vardefine:console|}}{{#vardefine:key|{{{2}}}}}{{#vardefine:keyboard|shift}}Template:!((File:undefined {{#var:key}}.png|alt={{#var:key}}|20px|link=|{{#var:key}}Template:))!{{#var:keyboard}} and {{#vardefine:console|}}{{#vardefine:key|{{{2}}}}}{{#vardefine:keyboard|f}}Template:!((File:undefined {{#var:key}}.png|alt={{#var:key}}|20px|link=|{{#var:key}}Template:))!{{#var:keyboard}} at the same time.

Consoles and controllers

{{key | console | button | size = optional size }}

  • console is the console the key belongs to. The parameter is not case-sensitive and supports many possible consoles. See Template:Key/library for possible values.
  • button is the button to be pressed, such as "A" or "Right Trigger". While the template tries to be intuitive such that the correct input for a button is whatever you think it is, if your attempt at a button isn't working, see Template:Key/library for possible values.
  • The size parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 20px.

Example

Press {{Key|Xbox|RT}} to open your inventory wheel and select the item with {{Key|Xbox|A}}

produces:
Press {{#vardefine:console|xbox}}{{#vardefine:key|RT}}{{#vardefine:keyboard|}}Template:!((File:undefined {{#var:key}}.png|alt={{#var:key}}|20px|link=|{{#var:key}}Template:))!{{#var:keyboard}} to open your inventory wheel and select the item with {{#vardefine:console|xbox}}{{#vardefine:key|A}}{{#vardefine:keyboard|}}Template:!((File:undefined {{#var:key}}.png|alt={{#var:key}}|20px|link=|{{#var:key}}Template:))!{{#var:keyboard}}

Changing the default color

The default color for the keyboard and mouse is suitable for dark-skinned wikis. To change the default settings so it fits for a light-skinned wiki, without having to use keyboardvariant = light each time, you can search for and change these sections in the template:


Search for: |#default = _White_Mouse_
...and change it to: |#default = _Black_Mouse_


Search for: <kbd class="{{#switch: {{lc:{{{keyboardvariant}}}}} |dark=keysDark|light=keysLight|

keysDark

}}">

...and change keysDark at the end of the line to keysLight.

Template:Doc/end

Retrieved from "https://dpl3.wikitide.org/wiki/Template:Key/doc?oldid=1201"