feat: target-specific options

[fabi1cazenave]

The current layout.metadata contains options which seem redundant, because they’re specific to different targets:

name        = "qwerty-custom"  # full layout name, displayed in the keyboard settings
name8       = "custom"         # short Windows filename: no spaces, no special chars
locale      = "us"             # locale/language id
variant     = "custom"         # layout variant id
author      = "nobody"         # author name
description = "custom QWERTY layout"

Besides, some features aren’t developed because they can’t be easily implemented on all platforms. A way de define platform-specific features would help breaking down development tasks into smaller bits.

So I think we should keep only generic options in layout.metadata, and move all target-specific options in branches:

• layout.metadata.target.ahk
• layout.metadata.target.keylayout
• layout.metadata.target.klc
• layout.metadata.target.svg
• layout.metadata.target.xkb

This would help #228 and #224, among recent tickets.

[ariasuni]

Considering one supported format is TOML, it would be nicer if alpha, base, full, 1dk and altgr were not in the root table (maybe in something called mappings), to allow using them after a heading like [target.xkb].

Edit: I remembered that in TOML, one can also just use something like target.xkb.label = "ez" directly, so it’s not really a problem in practice…

[fabi1cazenave]

We could use a keymaps section, indeed, but I don’t see how that would relate to target.xkb.label.

Could you suggest a full TOML file as an example to ease the discussion, please?

[ariasuni]

name        = "Ergo-L"
locale      = "fr"
variant     = "ergol"
description = "French (Ergo-L)"
author      = "NuclearSquid"
url         = "https://github.com/Nuclear-Squid/ergol"
geometry    = "ERGO"
version     = "1.0.0"

# I was thinking of defining things like this:

[target.xkb]

label = "er"

# oops, now base and altgr are in defined in namespace `target.xkb`.
# Maybe we should put `base` and `altgr` in its own namespace.
# Or we can do instead:

target.klc.name8 = "ergol"

# Or even:

target = {
  klc = { name8 = "ergol" },
  xkb = { label = "er" }
}


base = '''
[…]
'''

altgr = '''
[…]
'''

[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