Skip to content

File formats

Jump to bottom
Tanamr edited this page Mar 29, 2022 · 8 revisions

Layouts

An example layout file (colemak_ca_ansi) is shown below.

fingermap: ansi_angle
q w f p b j l u y ;
a r s t g m n e i o '
x c d v z k h , . /

The keys in the layout are separated using single spaces. If multiple spaces appear, the key that would have been between the spaces will be skipped.

Additional specifications may be given on their own lines, which will not be taken as part of the layout. These options are:

  • fingermap: Specifies the name of a fingermap found in /fingermaps/, which will be used for the layout. Defaults to traditional if not given.
  • board: Specifies the name of a board found in /boards/, which will be used for the layout. Defaults to ansi if not given.
  • first_pos: Specifies the position of the first character in the layout. The format for this is first_pos: ROW col. Defaults to TOP 1 if not given. Scroll to the bottom of the page for additional information on rows and columns.

Fingermaps

An example fingermap (ansi_angle) is shown below.

first_pos: NUMBER 0
LP LP LR LM LI LI RI RI RM RR RP RP RP RP
LP LP LR LM LI LI RI RI RM RR RP RP RP RP
LP LP LR LM LI LI RI RI RM RR RP RP RP
LP LR LM LI LI LI RI RI RM RR RP RP

A finger is specified for each key. (Scroll to the bottom of the page for more information on fingers.) Keys are separated using single spaces. If multiple spaces appear, the key that would have been between the spaces will be skipped.

Additional specifications may be given on their own lines, which will not be taken as part of the fingermap. These options are:

  • fingermap: Specifies the name of a fingermap found in /fingermaps/, which will be used for the layout. Defaults to traditional if not given.
  • board: Specifies the name of a board found in /boards/, which will be used for the layout. Defaults to ansi if not given.
  • first_pos: Specifies the position of the first character in the layout. The format for this is first_pos: ROW col. Defaults to TOP 1 if not given. Scroll to the bottom of the page for additional information on rows and columns.

Boards

Constraintmaps

Additional notes

Rows and columns

Rows include NUMBER, TOP, HOME, BOTTOM, and THUMB. These can also be referred to using their associated numbers, which are 0, 1, 2, 3, 4 respectively. Columns are given as integers. 0 should correspond to keys touching the left edge of the keyboard, which on on ANSI boards means the `, tab, shift, and ctrl keys. The number increases to the right.

Fingers

Fingers include LP, LR, LM, LI, LT, RT, RI,

Clone this wiki locally