Update shipped layout files to use the new layout syntax

tkna91 · Aug 11, 2022 · 2ec886b · 2ec886b
1 parent 768de57
commit 2ec886b
Show file tree

Hide file tree

Showing 103 changed files with 243 additions and 13 deletions.
diff --git a/data/keyd-application-mapper.1.gz b/data/keyd-application-mapper.1.gz
diff --git a/data/keyd.1.gz b/data/keyd.1.gz
diff --git a/docs/keyd.scdoc b/docs/keyd.scdoc
@@ -262,6 +262,39 @@ and not
 [layer2]
 ```
 
+## Layouts
+
+A layout is a special kind of layer intended for modifying alpha keys. Unlike
+layers, layouts cannot have any associated modifiers, and only one layout may
+be active at a given time. The current layout can be set using the _setlayout_
+action.
+
+For convenience, keyd ships with a number of common letter layouts in
+/usr/share/keyd/layouts. Before including these, it is instructive to inspect them.
+Non-english layouts include a dedicated shift layer (making order of inclusion
+important) and *require the use of keyd's compose definitions* (see *Unicode
+Support*)
+
+E.G
+
+```
+# Include the shipped colemak layout.
+include layouts/colemak
+
+[global]
+default_layout = mylayout
+
+[mylayout:layout]
+a = b
+b = c
+#etc...
+
+[control]
+1 = setlayout(customlayout)
+2 = setlayout(colemak)
+```
+
+
 ## Unicode Support
 
 If keyd encounters a valid UTF8 sequence as a right hand value, it will try and
@@ -361,17 +394,17 @@ E.G
 	[ids]
 	*
 
+	# Add our shared custom bindings.
 	include common
 
 	# Appends bindings to the main layer
 	# defined in /etc/keyd/common (order matters)
 	[main]
-	include layouts/dvorak
-	f11 = toggle(colemak)
+	capslock = layer(capslock)
 
-	[colemak]
-	include layouts/colemak
-	capslock = backspace
+	[capslock]
+	1 = setlayout(colemak)
+	2 = setlayout(dvorak)
 
 /etc/keyd/common:
 	[main]
@@ -385,7 +418,7 @@ E.G
 	k = up
 	l = right
 
-/etc/keyd/layouts/dvorak:
+/usr/share/keyd/layouts/dvorak:
 	a = a
 	s = o
 	...
@@ -400,12 +433,6 @@ Limitations:
 	- Included files should not end in .conf.
 
 
-For convenience, keyd ships with a number of common letter layouts in
-/usr/share/keyd/layouts. Before including these, it is instructive to inspect them.
-Non-english layouts include a dedicated shift layer (making order of inclusion
-important) and *require the use of keyd's compose definitions* (see *Unicode
-Support*)
-
 # GLOBALS
 
 A special section called _[global]_ may be defined in the file
@@ -464,7 +491,10 @@ arguments.
 	corresponding modifiers while held.
 
 *layer(<layer>)*
-	Activates the given layer for the duration of the keypress.
+	Activate the given layer for the duration of the keypress.
+
+*setlayout(<layout>)*
+	Set the current layout.
 
 *toggle(<layer>)*
 	Permanently toggle the state of the given layer.

diff --git a/layouts/af b/layouts/af
@@ -1,3 +1,5 @@
+[af:layout]
+
 ' = گ
 , = و
 . = .

diff --git a/layouts/al b/layouts/al
@@ -1,3 +1,5 @@
+[al:layout]
+
 ' = [
 , = ,
 . = .

diff --git a/layouts/am b/layouts/am
@@ -1,3 +1,5 @@
+[am:layout]
+
 ' = ր
 , = խ
 . = շ

diff --git a/layouts/ara b/layouts/ara
@@ -1,3 +1,5 @@
+[ara:layout]
+
 ' = ط
 , = و
 . = ز

diff --git a/layouts/at b/layouts/at
@@ -1,3 +1,5 @@
+[at:layout]
+
 ' = ä
 , = ,
 . = .

diff --git a/layouts/au b/layouts/au
@@ -1,3 +1,5 @@
+[au:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/az b/layouts/az
@@ -1,3 +1,5 @@
+[az:layout]
+
 ' = ə
 , = ç
 . = ş

diff --git a/layouts/ba b/layouts/ba
@@ -1,3 +1,5 @@
+[ba:layout]
+
 ' = ć
 , = ,
 . = .

diff --git a/layouts/bd b/layouts/bd
@@ -1,3 +1,5 @@
+[bd:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/be b/layouts/be
@@ -1,3 +1,5 @@
+[be:layout]
+
 ' = ù
 , = ;
 . = :

diff --git a/layouts/bg b/layouts/bg
@@ -1,3 +1,5 @@
+[bg:layout]
+
 ' = ч
 , = р
 . = л

diff --git a/layouts/br b/layouts/br
@@ -1,3 +1,5 @@
+[br:layout]
+
 , = ,
 . = .
 / = ;

diff --git a/layouts/brai b/layouts/brai
@@ -1,3 +1,5 @@
+[brai:layout]
+
 shift = layer(brai_shift)
 
 [brai_shift:S]
diff --git a/layouts/bt b/layouts/bt
@@ -1,3 +1,5 @@
+[bt:layout]
+
 ' = ཛ
 , = ས
 . = ཧ

diff --git a/layouts/bw b/layouts/bw
@@ -1,3 +1,5 @@
+[bw:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/by b/layouts/by
@@ -1,3 +1,5 @@
+[by:layout]
+
 ' = э
 , = б
 . = ю

diff --git a/layouts/ca b/layouts/ca
@@ -1,3 +1,5 @@
+[ca:layout]
+
 , = ,
 . = .
 / = é

diff --git a/layouts/cd b/layouts/cd
@@ -1,3 +1,5 @@
+[cd:layout]
+
 ' = ɔ
 , = ;
 . = :

diff --git a/layouts/ch b/layouts/ch
@@ -1,3 +1,5 @@
+[ch:layout]
+
 ' = ä
 , = ,
 . = .

diff --git a/layouts/cm b/layouts/cm
@@ -1,3 +1,5 @@
+[cm:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/cn b/layouts/cn
@@ -1,3 +1,5 @@
+[cn:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/colemak b/layouts/colemak
@@ -1,3 +1,5 @@
+[colemak:layout]
+
 w = w
 , = ,
 s = r

diff --git a/layouts/cz b/layouts/cz
@@ -1,3 +1,5 @@
+[cz:layout]
+
 ' = §
 , = ,
 . = .

diff --git a/layouts/de b/layouts/de
@@ -1,3 +1,5 @@
+[de:layout]
+
 ' = ä
 , = ,
 . = .

diff --git a/layouts/dk b/layouts/dk
@@ -1,3 +1,5 @@
+[dk:layout]
+
 ' = ø
 , = ,
 . = .

diff --git a/layouts/dvorak b/layouts/dvorak
@@ -1,3 +1,5 @@
+[dvorak:layout]
+
 t = y
 h = d
 a = a

diff --git a/layouts/dz b/layouts/dz
@@ -1,3 +1,5 @@
+[dz:layout]
+
 ' = ù
 , = ;
 . = :

diff --git a/layouts/ee b/layouts/ee
@@ -1,3 +1,5 @@
+[ee:layout]
+
 ' = ä
 , = ,
 . = .

diff --git a/layouts/epo b/layouts/epo
@@ -1,3 +1,5 @@
+[epo:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/es b/layouts/es
@@ -1,3 +1,5 @@
+[es:layout]
+
 , = ,
 . = .
 / = -

diff --git a/layouts/et b/layouts/et
@@ -1,3 +1,5 @@
+[et:layout]
+
 ' = ፦
 , = ፣
 . = ፤

diff --git a/layouts/fi b/layouts/fi
@@ -1,3 +1,5 @@
+[fi:layout]
+
 ' = ä
 , = ,
 . = .

diff --git a/layouts/fo b/layouts/fo
@@ -1,3 +1,5 @@
+[fo:layout]
+
 ' = ø
 , = ,
 . = .

diff --git a/layouts/fr b/layouts/fr
@@ -1,3 +1,5 @@
+[fr:layout]
+
 ' = ù
 , = ;
 . = :

diff --git a/layouts/gb b/layouts/gb
@@ -1,3 +1,5 @@
+[gb:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/ge b/layouts/ge
@@ -1,3 +1,5 @@
+[ge:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/gh b/layouts/gh
@@ -1,3 +1,5 @@
+[gh:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/gn b/layouts/gn
@@ -1,3 +1,5 @@
+[gn:layout]
+
 ' = ߯
 , = ؛
 . = ،

diff --git a/layouts/gr b/layouts/gr
@@ -1,3 +1,5 @@
+[gr:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/hr b/layouts/hr
@@ -1,3 +1,5 @@
+[hr:layout]
+
 ' = ć
 , = ,
 . = .

diff --git a/layouts/hu b/layouts/hu
@@ -1,3 +1,5 @@
+[hu:layout]
+
 ' = á
 , = ,
 . = .

diff --git a/layouts/id b/layouts/id
@@ -1,3 +1,5 @@
+[id:layout]
+
 , = ،
 . = .
 / = /

diff --git a/layouts/ie b/layouts/ie
@@ -1,3 +1,5 @@
+[ie:layout]
+
 ' = '
 , = ,
 . = .

diff --git a/layouts/il b/layouts/il
@@ -1,3 +1,5 @@
+[il:layout]
+
 ' = ,
 , = ת
 . = ץ

diff --git a/layouts/in b/layouts/in
@@ -1,3 +1,5 @@
+[in:layout]
+
 ' = ट
 , = ,
 . = .

diff --git a/layouts/iq b/layouts/iq
@@ -1,3 +1,5 @@
+[iq:layout]
+
 ' = ط
 , = و
 . = ز

diff --git a/layouts/ir b/layouts/ir
@@ -1,3 +1,5 @@
+[ir:layout]
+
 ' = گ
 , = و
 . = .

diff --git a/layouts/is b/layouts/is
@@ -1,3 +1,5 @@
+[is:layout]
+
 , = ,
 . = .
 / = þ

diff --git a/layouts/it b/layouts/it
@@ -1,3 +1,5 @@
+[it:layout]
+
 ' = à
 , = ,
 . = .

diff --git a/layouts/jp b/layouts/jp
@@ -1,3 +1,5 @@
+[jp:layout]
+
 ' = :
 , = ,
 . = .
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    [af:layout]
     ' = گ
     , = و
     . = .
@@ Expand Down @@