Difference between revisions of "Template:Key"

From RimWorld Wiki
Jump to navigation Jump to search
(Created page with "<span style="font-size: small; border: 0.2em solid; border-color: #DDD #BBB #BBB #DDD; padding: 0 0.4em; background: #EEE; white-space: nowrap; border-radius: 2px;">{{ucfirst:...")
 
(Undo revision 117712 by Harakoni (talk))
Tag: Undo
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<span style="font-size: small; border: 0.2em solid; border-color: #DDD #BBB #BBB #DDD; padding: 0 0.4em; background: #EEE; white-space: nowrap; border-radius: 2px;">{{ucfirst:{{{1|Key}}}}}</span><noinclude>
+
<includeonly>{{#vardefine:console|{{#if:{{{console|}}}|{{lc:{{{console}}}}}|{{#if:{{{2|}}}|{{lc:{{{1}}}}}}}}}}}<!--
 +
-->{{#vardefine:key|{{#switch:{{lc:{{#if:{{{key|}}}|{{{key}}}|{{{2}}}}}}}
 +
| leftstick
 +
| left stick
 +
| lstick = Left Stick
 +
| rightstick
 +
| right stick
 +
| rstick = Right Stick
 +
| lt = LT
 +
| lb = LB
 +
| rt = RT
 +
| rb = RB
 +
| l = Left
 +
| r = Right
 +
| u = Up
 +
| d = Down
 +
| m = Menu
 +
| o = Circle
 +
| touchpad = Touch Pad
 +
| #default = {{ucfirst:{{#if:{{{key|}}}|{{{key}}}|{{{2}}}}}}}
 +
}}}}<!--
 +
-->{{#vardefine:keyboard|{{lc:{{#if:{{{keyboard|}}}|{{{keyboard}}}|{{#if:{{{2|}}}||{{{1|}}}}}}}}}}}<!--
  
−
== Description ==
+
-->{{#if: {{#var:console}} | [[File:{{#switch: {{#var:console}}
−
This template is used to imitate a keyboard button.
+
|ps3=PS3
 +
|ps4=PS4
 +
|psmove
 +
|move=PSMove
 +
|xbox360
 +
|360=360
 +
|gesture=Gesture
 +
|keyboard
 +
|mouse=Keyboard
 +
|oculus=Oculus
 +
|remote=Remote
 +
|steam=Steam
 +
|switch=Switch
 +
|vita=Vita
 +
|vive=Vive
 +
|wii=Wii
 +
|wiiu=WiiU
 +
|xbox
 +
|xboxone
 +
|xbone
 +
|xbox1=XboxOne
 +
|ouya=Ouya
 +
|undefined}}<!--
  
−
[[Category:Formatting templates]]
+
-->{{#ifeq:{{#var:console}}|mouse|{{#switch: {{lc:{{{variant}}}}}
−
</noinclude>
+
|dark=_White_Mouse_
 +
|light=_Black_Mouse_
 +
|#default = _Black_Mouse_
 +
}}}} {{#var:key}}.png|{{{size|20px}}}|{{{link|Controls}}}]] }}<!--
 +
 
 +
-->{{#if: {{#var:keyboard}} | <span class="key" style="display:inline-block; white-space:nowrap;">[[Controls|<kbd class="{{#switch: {{lc:{{{keyboardvariant}}}}} |dark=keysDark|light=keysLight|keysLight}}"><!--
 +
 
 +
-->{{#switch:{{#var:keyboard}}
 +
 
 +
<!--Standard keyboard values-->
 +
|caps lock = ⇪ Caps Lock
 +
|shift = ⇧ Shift
 +
|lshift
 +
|left shift = ⇧ Left Shift
 +
|rshift
 +
|right shift = ⇧ Right Shift
 +
|enter = ↵ Enter
 +
|esc = Esc
 +
|ctrl = Ctrl
 +
|lctrl
 +
|left ctrl = Left Ctrl
 +
|rctrl
 +
|right ctrl = Right Ctrl
 +
|alt = Alt
 +
|lalt
 +
|left alt = Left Alt
 +
|ralt
 +
|right alt = Right Alt
 +
|cmd = ⌘ Cmd
 +
|command = ⌘ Command
 +
|opt
 +
|option = ⌥ Option
 +
|tab = Tab ↹
 +
|backspace = ← Backspace
 +
|super = ⊞ Super
 +
|menu = ≣ Menu
 +
|windows = ⊞ Windows
 +
 
 +
|#default = {{uc:{{#var:keyboard}}}}
 +
}}</kbd>]]</span>
 +
}}</includeonly><noinclude>{{documentation}}</noinclude>

Latest revision as of 03:40, 2 February 2023

Documentation icon Template documentation[view] [edit] [history] [purge]
AncientTerminal east.png
This page has been suggested for recoding. Reason: It'd be really nice if the template actually supported the console options it claims too, specifically the ones added by Console edition and steam deck too.. You can help RimWorld Wiki by improving it.

When used, this template displays game controls, supporting both keyboard keys and controller buttons.

  • This template's display is styled using the .keysDark and .keysLight classes located in MediaWiki:Common.css.

Usage[edit]

Keyboard[edit]

{{key | keyboard = keyboard key | keyboardvariant = dark or light }}

  • The keyboard parameter is the keyboard key to be pressed.
  • The keyboardvariant parameter is the graphic style and is not required - the template defaults to dark, rendering a white key with black text. Enter dark for dark wikis, or light for light wikis.

Controller[edit]

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

  • The console parameter is used to state which console the key belongs to. The parameter is not case-sensitive. See Template:Key/library for possible values.
  • The button 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.
  • The size parameter is optional, and sizes the button image. If this parameter is not entered, the default image size is 50px.

Examples[edit]

Keyboard[edit]

The keyboardvariant 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.

⇪ Caps Lock 

{{key
| keyboard = caps lock
| keyboardvariant = dark
}}

Or for light wikis:

⇪ Caps Lock 

{{key
| keyboard = caps lock
| keyboardvariant = light
}}

Keyboard keys can be entered in shorthand like this: ⇪ Caps Lock 

{{key|caps lock}}


Retrieved from "https://rimworldwiki.com/index.php?title=Template:Key&oldid=128123"