keyboards/planck/keymaps/cbbrowne/readme.org

   1 * cbbrowne custom keyboard
   2
   3   Due to cbbrowne@acm.org
   4   Christopher Browne
   5
   6   This was originally based on the default keyboard map, but I have
   7   been doing sundry experimentation:
   8
   9 ** Useful Experiments
  10
  11  - It made sense to mess around some with keyboard maps.
  12    - I added a keypad, originally based on keymaps/numpad.c, but
  13      mighty substantially revised, as that one seems to be rotated 90
  14      degrees from usual conventions for number pads
  15  - The keypad layer also includes some sample "hacks" of cool things,
  16    all using actions attached in using the function action_get_macro()
  17    - Key [1][2] aka "q" types out my name, cbbrowne, as a fun example
  18      of a key generating a bunch of keystrokes.  The keystroke is
  19      sufficiently inconvenient that it isn't terribly practical for me
  20      to use it, but hey, it shows how others might use this facility
  21      in a more useful context.
  22    - Key [2][2] aka "a" uses a random number generator to select a digit 0-9 at random
  23    - Key [3][2] aka "z" uses a random number generator to select a letter a-z at random
  24    - Key [1][3] aka "e" spits out the keymap version number
  25   - Trying out sgoodwin's "hold Enter down to get Shift"
  26     - Liking this Quite Well Enough...
  27     - Applied this to both Shift and Quote
  28     - It seems likely that Alt should get a right-hand-side, akin to this...
  29     - Alt needs to move, and get a RHS
  30       - Hence ALTRIGHT, and shifted ROT_LED over
  31       - Emacs likes this!!!  :-)
  32     - I'm suspicious that I'll want to shift ROT_LED another location over,
  33       so some modifier can replace the OS/KC_LGUI key
  34   - I have added an alternate ADJUST layer that is activated via update_tri_layer()
  35     - e.g. - LOWER+RAISE simultaneously
  36     - This seems entirely more useful for handling my "special keys"
  37       like the random numbers, user name, and such, than the keypad layer
  38   - The _ADJUST layer provides a good place to have RESET
  39     - But this isn't strictly enough; I want RESET somewhat accessible from
  40       main layer lest an error hide that layer
  41     - I never use the OS/KC_LGUI key (that's Command on MacOS, Windows
  42       Key on Windows), so that's a good place to have it as a chord of
  43       some sort
  44
  45
  46 ** Some code structure ideas
  47
  48    Each layer is given a name to aid in readability, which is then
  49    used in the keymap matrix below.  The underscores do not denote
  50    anything - you can have a layer called STUFF or any other name.
  51
  52    Layer names don't all need to be of the same length, obviously, and
  53    you could also skip them entirely and just use numbers, though that
  54    means needing to manage the numbers.
  55
  56    It is preferable to keep the symbols short so that a line worth of
  57    key mappings fits compactly onto a line of code.  It might be an
  58    interesting idea to express the maps rotated 90%, so that you
  59    only need to fit 4 symbols onto each line, rather than 12.
  60
  61    I use enums to manage layer IDs and macro IDs so that I don't need
  62    to care (beyond "start at 0", and arguably even that's not needed)
  63    about their values.
  64
  65 ** Things I did not like about the default mapping
  66
  67
  68    - I found control too hard to get to.  I use it more than Tab, so
  69      switched it there.
  70    - Having dash on [lower-j] is a bit nonintuitive, but may be OK
  71    - I switched ESC/TAB/M(0) around
  72    - I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
  73      and shift ESC off the first column so KC_LCTL and KC_LALT can
  74      be on the first column.
  75    - I needed to swap ' and ENTER
  76
  77 ** Unuseful experiments
  78
  79 I have tried some things out that didn't turn out particularly well.
  80 I'll note some of these for posterity, hopefully helpful in not doing
  81 unwise things again...
  82
  83    - I tried added Workman alongside Dvorak and Colemak
  84      - Boy, oh boy, these don't help!!!
  85      - I have done 30 years of learning of Emacs key mappings, and
  86        these alternative keyboards massively mess me up
  87
  88    - Space Cadet Shift; switching L_SHIFT to KC_LSP0, so that when I
  89      just hit SHIFT, I get a left parens.  In principle, this is great
  90      for Lisping.
  91      - Unfortunately, there are times when mouse interfaces use SHIFT
  92        to allow selecting multiple items, and this really interferes
  93         with that
  94
  95 ** TODO
  96
  97   - I use tmux quite a lot; the mollat keymap seems to have some
  98     interesting helpers.  It might be interesting to add a "tmux
  99     layer," or to have a few keys in a layer oriented towards that
 100     - Keys for...
 101       - Picking windows 0 thru 8
 102       - next/prev/new window
 103   - The mollat tmux layer also suggests some thoughts about Emacs
 104     helpers.
 105   - I do not presently have anything that handles X11 screen
 106     switching, as with Control-Alt-various
 107   - I ought to probably look into KC_LEAD, to have some key combos
 108     that do not need to be concurrent
 109   - The jeebak keymap seems to have some neat ideas:
 110     - Number layer which is aggressive about having numbers in several places
 111     - TouchCursor layer seems interesting
 112       - It sets up a layer with cursor keys on the home keys
 113   - The jeremy-dev keymap has some very interesting concepts
 114     - Shift hands outwards; the special keys go in the center
 115     - Symbol layer has some compound keys for C operators like /=, *=, -=, +=, ...
 116     - This is likely what I'll use for my XD75re, and maybe I'll fork a
 117       planck keymap for similar