Template:Kbdchart/Documentation: Difference between revisions

From StrategyWiki, the video game walkthrough and strategy guide wiki
update docs
m (→‎Usage: update colors)
(update docs)
Line 1: Line 1:
==Description==
{{SPW|is not on|name=Kbdchart}}<!-- DO NOT COPY this line when copying this documentation. -->
;Description


This is a 104-key PC keyboard command chart based on [http://isometricland.com/keyboard/keyboard.php Video Game Keyboard Charts] (LGPL) which [[User:Posfan12|Posfan12]] authored. There are two sub-templates, [[Template:Kbdlegend]] and [[Template:Kbdchartkey]], used in rendering the chart legend and individual keys.
This is a 104-key PC keyboard command chart based on [https://web.archive.org/web/20100729172551/http://isometricland.com/keyboard/keyboard.php Video Game Keyboard Charts] (LGPL, CC BY-SA 3.0) which [http://strategywiki.org/w/index.php?title=User:Posfan12 Posfan12] at [http://strategywiki.org Strategy Wiki] authored. There are three sub-templates, [[Template:Kbdlegend]], [[Template:Kbdchartleg]] and [[Template:Kbdchartkey]], used in rendering the chart legend and individual keys.


==Usage==
;Origin
:From http://strategywiki.org/w/index.php?title=Template:Kbdchart


Keys are numbered from 000 to 105, with two of the keys reserved for European keyboards. Each key has four main parameters:
;Dependencies
* [[Template:Kbdchartkey]]
* [[Template:Kbdlegend]]
* [[Template:Kbdchartleg]]
 
;Example
You can find an usage example [http://templates.wikia.com/wiki/Template:Kbdchart here].
 
;Usage
Keys are numbered from 000 to 105, with two of the keys reserved for European keyboards. Each key has five main parameters:


*'''<code>NNNb</code>''' - the background color code for the key.
*'''<code>NNNb</code>''' - the background color code for the key.
Line 35: Line 46:
|}
|}


Key groupings (which appear in the [[Template:Kbdlegend|chart legend]]) are numbered from 0 to 9. There are two main parameters:
Key groupings (which appear in the [[Template:Kbdlegend|chart legend]]) are numbered from 00 to 11. There are two main parameters:


*'''<code>Nlgb</code>''' - the background color code for the key grouping.
*'''<code>NNlgb</code>''' - the background color code for the key grouping.
*'''<code>Nlgt</code>''' - the text description of the key grouping (for instance "Combat Controls").
*'''<code>NNlgt</code>''' - the text description of the key grouping (for instance "Combat Controls").


Here's a set of conventions with regard to group colors that works pretty well:
Here's a set of conventions with regard to group colors that works pretty well:


*<span style="font-family:monospace;background:#f99;border:1px solid #200;color:#200;">red</span> Combat/Actions
*<span style="font-family:monospace;background:#f99;border:1px solid #200;color:#200;">red</span> Combat/Actions
*<span style="font-family:monospace;background:#ff9;border:1px solid #220;color:#220;">yel</span> Targeting/Unit selection
*<span style="font-family:monospace;background:#ff9;border:1px solid #220;color:#220;">yel</span> Targeting/Unit selection/Inventory
*<span style="font-family:monospace;background:#9f9;border:1px solid #020;color:#020;">grn</span> Movement/Navigation
*<span style="font-family:monospace;background:#9f9;border:1px solid #020;color:#020;">grn</span> Movement/Navigation
*<span style="font-family:monospace;background:#9ff;border:1px solid #022;color:#022;">cyn</span> Communication/Chat
*<span style="font-family:monospace;background:#9ff;border:1px solid #022;color:#022;">cyn</span> Communication/Chat
Line 59: Line 70:
*The order in which the keys are numbered are based on their scan codes on typical IBM-compatible keyboards.
*The order in which the keys are numbered are based on their scan codes on typical IBM-compatible keyboards.


==Reference chart==
;Reference chart
I've also uploaded an Excel sheet [http://www.mediafire.com/file/ymnggnaybny/strategywiki_kbdchart_template_20100528.zip here] to assist you in filling in the template parameters.
I've also uploaded an Excel sheet [http://www.mediafire.com/file/ymnggnaybny/strategywiki_kbdchart_template_20100528.zip here] to assist you in filling in the template parameters.


Line 303: Line 314:
Legend 8
Legend 8
Legend 9
Legend 9
Legend 10
Legend 11
...
...
</pre>
</pre>
Line 308: Line 321:
<pre>
<pre>
{{kbdlegend
{{kbdlegend
|0lgb= |0lgt=  
|00lgb= |00lgt=  
|1lgb= |1lgt=  
|01lgb= |01lgt=  
|2lgb= |2lgt=  
|02lgb= |02lgt=  
|3lgb= |3lgt=  
|03lgb= |03lgt=  
|4lgb= |4lgt=  
|04lgb= |04lgt=  
|5lgb= |5lgt=  
|05lgb= |05lgt=  
|6lgb= |6lgt=  
|06lgb= |06lgt=  
|7lgb= |7lgt=  
|07lgb= |07lgt=  
|8lgb= |8lgt=  
|08lgb= |08lgt=  
|9lgb= |9lgt=  
|09lgb= |09lgt=
|10lgb= |10lgt=
|11lgb= |11lgt=  
}}
}}
</pre>
</pre>
430

edits