Skip to main content

Module layout

Module layout 

Source
Expand description

The plan: the ladder of stages from where you start to your own layout.

A plan is a TOML file (see examples/very-normal.toml). Positions run left to right, top row then home row then bottom row, ten keys a row (five per hand). Only letters and ; , . / ' live here; the outer columns never move.

Structs§

Change
Plan
Stage

Constants§

EXAMPLE
Mark’s plan, used when you haven’t made your own.
OUTER_LEFT
OUTER_RIGHT

Functions§

blurb
changed_now
changes
The keys that change when you climb from stage - 1 to stage.
common_words
find_stage
Which stage a main layer’s 30 letter keys match, if any.
focus
The characters a stage puts somewhere new, in key order.
install
Loads your plan if you have one, otherwise Mark’s. Call once at startup; says which file it used, or None for the built-in example.
keys
keys_string
last
mirror
The left-hand position that mirrors a right-hand one, and the reverse.
modifier
What a key does when held, for home row positions 10 to 19.
moved
Whether a position types something different from stage 0.
name
plan
plan_path
$VERY_NORMAL_PLAN, or ~/.config/very-normal/plan.toml.
position
stats
Home row share and same-finger pairs, both as percentages.
vim
words