File: README.md

package info (click to toggle)
kalamine 0.38-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 840 kB
  • sloc: python: 2,557; javascript: 1,012; cpp: 506; makefile: 37; sh: 7
file content (188 lines) | stat: -rw-r--r-- 9,698 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
Defining a Keyboard Layout
================================================================================

Kalamine keyboard layouts are defined with TOML files including this kind of
ASCII-art layer templates:

```
full = '''
┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┲━━━━━━━━━━┓
│ ~*~ │ !   │ @   │ #   │ $   │ %   │ ^   │ &   │ *   │ (   │ )   │ _   │ +   ┃          ┃
│ `*` │ 1   │ 2   │ 3   │ 4   │ 5   │ 6*^ │ 7   │ 8   │ 9   │ 0   │ -   │ =   ┃ ⌫        ┃
┢━━━━━┷━━┱──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┺━━┯━━━━━━━┩
┃        ┃ Q   │ W   │ E   │ R   │ T   │ Y   │ U   │ I   │ O   │ P   │ {   │ }   │ |     │
┃ ↹      ┃   @ │   < │   > │   $ │   % │   ^ │   & │   * │   ' │   ` │ [   │ ]   │ \     │
┣━━━━━━━━┻┱────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┲━━━━┷━━━━━━━┪
┃         ┃ A   │ S   │ D   │ F   │ G   │ H   │ J   │ K   │ L   │ :   │ "*¨ ┃            ┃
┃ ⇬       ┃   { │   ( │   ) │   } │   = │   \ │   + │   - │   / │ ; " │ '*´ ┃ ⏎          ┃
┣━━━━━━━━━┻━━┱──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┲━━┻━━━━━━━━━━━━┫
┃            ┃ Z   │ X   │ C   │ V   │ B   │ N   │ M   │ <   │ >   │ ?   ┃               ┃
┃ ⇧          ┃   ~ │   [ │   ] │   _ │   # │   | │   ! │ , ; │ . : │ / ? ┃ ⇧             ┃
┣━━━━━━━┳━━━━┻━━┳━━┷━━━━┱┴─────┴─────┴─────┴─────┴─────┴─┲━━━┷━━━┳━┷━━━━━╋━━━━━━━┳━━━━━━━┫
┃       ┃       ┃       ┃                                ┃       ┃       ┃       ┃       ┃
┃ Ctrl  ┃ super ┃ Alt   ┃ ␣                              ┃ Alt   ┃ super ┃ menu  ┃ Ctrl  ┃
┗━━━━━━━┻━━━━━━━┻━━━━━━━┹────────────────────────────────┺━━━━━━━┻━━━━━━━┻━━━━━━━┻━━━━━━━┛
'''
```


Layers
--------------------------------------------------------------------------------

### base

The `base` layer contains the base and shifted keys:

                   +-----+
    shift -------> | ?   |
    base --------> | /   |
                   +-----+

When the base and shift keys correspond to the same character, you may only
specify the uppercase char:

                   +-----+
    shift -------> | A   |
    (base = a) --> |     |
                   +-----+


### altgr

The `altgr` layer contains the altgr and shift+altgr symbols:

                   +-----+
                   |     | <----- (altgr+shift+key is undefined)
                   |   { | <----- altgr+key = {
                   +-----+


### full

The `full` view lets you specify the `base` and `altgr` levels together:

                   +-----+
    shift -------> | A   | <----- (altgr+shift+key is undefined)
    (base = a) --> |   { | <----- altgr+key = {
                   +-----+


Dead Keys
--------------------------------------------------------------------------------

### Usage

Dead keys are preceded by a `*` sign. They can be used in the `base` layer:

                   +-----+
    shift -------> |*"   |  = dead diaeresis
    base --------> |*´   |  = dead acute accent
                   +-----+

… as well as in the `altgr` layer:

                   +-----+
                   |  *" | <----- altgr+shift+key = dead diaeresis
                   |  *´ | <----- altgr+key       = dead acute accent
                   +-----+

… and combined in the `full` layer:

                    +-----+
  shift+key = A --> | A*" | <----- altgr+shift+key = dead diaeresis
        key = a --> | a*´ | <----- altgr+key       = dead acute accent
                    +-----+


### Standard Dead Keys

The following dead keys are supported, and their behavior cannot be customized:

    id  XKB name          base -> accented chars
    ----------------------------------------------------------------------------
    *`  grave             AaEeIiNnOoUuWwYyЕеИи
                       -> ÀàÈèÌìǸǹÒòÙùẀẁỲỳЀѐЍѝ
    *‟  doublegrave       AaEeIiOoRrUuѴѴ
                       -> ȀȁȄȅȈȉȌȍȐȑȔȕѶѷ
    *´  acute             AaCcEeGgIiKkLlMmNnOoPpRrSsUuWwYyZzΑαΕεΗηΙιΟοΥυΩωГгКк
                       -> ÁáĆćÉéǴǵÍíḰḱĹĺḾḿŃńÓóṔṕŔশÚúẂẃÝýŹźΆάΈέΉήΊίΌόΎύΏώЃѓЌќ
    *”  doubleacute       OoUuУу
                       -> ŐőŰűӲӳ
    *^  circumflex        AaCcEeGgHhIiJjOoSsUuWwYyZz0123456789()+-=
                       -> ÂâĈĉÊêĜĝĤĥÎîĴĵÔôŜŝÛûŴŵŶŷẐẑ⁰¹²³⁴⁵⁶⁷⁸⁹⁽⁾⁺⁻⁼
    *ˇ  caron             AaCcDdEeGgHhIiKkLlNnOoRrSsTtUuZzƷʒ0123456789()+-=
                       -> ǍǎČčĎďĚěǦǧȞȟǏǐǨǩĽľŇňǑǒŘřŠšŤťǓǔŽžǮǯ₀₁₂₃₄₅₆₇₈₉₍₎₊₋₌
    *˘  breve             AaEeGgIiOoUuΑαΙιΥυАаЕеЖжИиУу
                       -> ĂăĔĕĞğĬĭŎŏŬŭᾸᾰῘῐῨῠӐӑӖӗӁӂЙйЎў
    *⁻  invertedbreve     AaEeIiOoUuRr
                       -> ȂȃȆȇȊȋȎȏȖȗȒȓ
    *~  tilde             AaEeIiNnOoUuVvYy<>=
                       -> ÃãẼẽĨĩÑñÕõŨũṼṽỸỹ≲≳≃
    *¯  macron            AaÆæEeGgIiOoUuYy
                       -> ĀāǢǣĒēḠḡĪīŌōŪūȲȳ
    *¨  diaeresis         AaEeHhIiOotUuWwXxYyΙιΥυАаЕеӘәЖжЗзИиІіОоӨөУуЧчЫыЭэ
                       -> ÄäËëḦḧÏïÖöẗÜüẄẅẌẍŸÿΪϊΫϋӒӓЁёӚӛӜӝӞӟӤӥЇїӦӧӪӫӰӱӴӵӸӹӬӭ
    *˚  abovering         AaUuwy
                       -> ÅåŮůẘẙ
    *¸  cedilla           CcDdEeGgHhKkLlNnRrSsTt
                       -> ÇçḐḑȨȩĢģḨḩĶķĻļŅņŖŗŞşŢţ
    *,  belowcomma        SsTt
                       -> ȘșȚț
    *˛  ogonek            AaEeIiOoUu
                       -> ĄąĘęĮįǪǫŲų
    */  stroke            AaBbCcDdEeGgHhIiJjLlOoPpRrTtUuYyZz<≤≥>=
                       -> ȺⱥɃƀȻȼĐđɆɇǤǥĦħƗɨɈɉŁłØøⱣᵽɌɍŦŧɄʉɎɏƵƶ≮≰≱≯≠
    *˙  abovedot          AaBbCcDdEeFfGgHhIijLlMmNnOoPpRrSsTtWwXxYyZz
                       -> ȦȧḂḃĊċḊḋĖėḞḟĠġḢḣİıȷĿŀṀṁṄṅȮȯṖṗṘṙṠṡṪṫẆẇẊẋẎẏŻż
    *.  belowdot          AaBbDdEeHhIiKkLlMmNnOoRrSsTtUuVvWwYyZz
                       -> ẠạḄḅḌḍẸẹḤḥỊịḲḳḶḷṂṃṆṇỌọṚṛṢṣṬṭỤụṾṿẈẉỴỵẒẓ
    *µ  greek             AaBbDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuWwXxYyZz
                       -> ΑαΒβΔδΕεΦφΓγΗηΙιΘθΚκΛλΜμΝνΟοΠπΧχΡρΣσΤτΥυΩωΞξΨψΖζ
    *¤  currency          AaBbÇCçcDdEeFfGgHhIiKkLlMmNnOoPpRrSsTtþÞUuWwYy
                       -> ₳؋₱฿₵₡₵¢₯₫₠€₣ƒ₲₲₴₴៛﷼₭₭₤£ℳ₥₦₦૱௹₧₰₨₢$₪₮৳৲৲圓元₩₩円¥

### Custom Dead Key

There is one dead key (1dk), noted `**`, that can be customized by specifying
how it modifies each character in the `base` layer:

                   +-----+
    shift -------> | ? ¿ | <----- 1dk, shift+key
    base --------> | / ÷ | <----- 1dk, key
                   +-----+

When the base and shift keys correspond to the same accented character, you may
only specify the lowercase accented char in the `base` layer:

                   +-----+
    shift -------> | A   | <----- (1dk, shift+key = À)
    (base = a) --> |   à | <----- 1dk, key = à
                   +-----+

You may also chain dead keys by specifying a dead key in the `1dk` layer:

                   +-----+
    shift -------> | G   |
    (base = g) --> |  *µ | <----- 1dk, key = dead Greek
                   +-----+

**Warning:** chained dead keys are not supported by MSKLC, and KbdEdit will be
required to build a Windows driver for such a keyboard layout.


Space Bar
--------------------------------------------------------------------------------

Kalamine descriptor files have an optional section to define specific behaviors
of the space bar in non-base layers:

    [spacebar]
    shift       = "\u202f"  # NARROW NO-BREAK SPACE
    altgr       = "\u0020"  # SPACE
    altgr_shift = "\u00a0"  # NO-BREAK SPACE
    1dk         = "\u2019"  # RIGHT SINGLE QUOTATION MARK
    1dk_shift   = "\u2019"  # RIGHT SINGLE QUOTATION MARK

Kalamine doesn’t support non-space chars on the `base` layer for the space bar.
Space characters outside of the space bar are not supported either.