keyboards/planck/keymaps/jeebak/readme.md

   1 jeebak's layout
   2 =======================
   3 This WIP keymap attempts to minimize fingers straying away from the home row.
   4 To aid in this endeavor, when additional modifyer keys to switch layers are
   5 needed, they will be mapped to home row keys. The `keymap.c` file will contain
   6 the exact changes. The diagrams in this README shows the highlights of the
   7 changes from the default mappings.
   8
   9 I also decided to change all calls to `persistant_default_layer_set()` to
  10 `update_tri_layer()` since this is my personal perference.
  11
  12 ## Base Layers (Qwerty/Colemak/Dvorak)
  13 These base layers are mostly the same as the default mappings. The interesting
  14 changes are shown below. The `Ctrl/Esc`, mapped using `CTL_T(KC_ESC)` will emit
  15 an `Escape` when tapped, and act as a `Control` key when held. A `TODO` item is
  16 to see if it can also act as a `CapsLock` when double-tapped. The right shift
  17 key acts as `Enter` when tapped, and as a `Shift` key when held. The arrow
  18 keys, which have been moved to the
  19 [TouchCursor](http://martin-stone.github.io/touchcursor/) layer, have been
  20 replaced with the Media keys as shown. The `ML/A` key activates the Mouse layer
  21 when held, and emits an `A` when tapped.
  22 ```
  23   ,-----------------------------------------------------------------------------------------.
  24   |          |      |      |      |      |      |      |      |      |      |      |        |
  25   |----------+------+------+------+------+-------------+------+------+------+------+--------|
  26   | Ctrl/Esc | ML/A |      |      |      |      |      |      |      |      |      |        |
  27   |----------+------+------+------+------+------|------+------+------+------+------+--------|
  28   |          |      |      |      |      |      |      |      |      |      |      |Sft/Ent |
  29   |----------+------+------+------+------+------+------+------+------+------+------+--------|
  30   | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
  31   `-----------------------------------------------------------------------------------------'
  32 ```
  33
  34 ## Lower Layer (Symbols and Function Keys)
  35 The symbols and functions keys are essentially the same as the default mapping.
  36 The most notable changes are that the symbol keys from the `RAISE` layer have
  37 been moved here. The remaining Media keys replace those that are now on the
  38 base layers. The `BACKLIT` key has also been moved here.
  39 ```
  40   ,-----------------------------------------------------------------------------------.
  41   |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  42   |------+------+------+------+------+-------------+------+------+------+------+------|
  43   |   [  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  44   |------+------+------+------+------+------|------+------+------+------+------+------|
  45   |   ]  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
  46   |------+------+------+------+------+------+------+------+------+------+------+------|
  47   |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
  48   `-----------------------------------------------------------------------------------'
  49 ```
  50
  51 ## Raise Layer (Numbers and Arithmetic Operators)
  52 All of the numbers and arithmetic operators are available on this layer. Some
  53 keys are duplicated for the convenience of their positions. The `0` and `$`
  54 keys at the far left are for quick access to beginning and end of line in vim.
  55 ```
  56   ,-----------------------------------------------------------------------------------.
  57   |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  58   |------+------+------+------+------+-------------+------+------+------+------+------|
  59   |   $  |   4  |   5  |   6  |   .  |   +  |   *  |   4  |   5  |   6  |   -  |  |   |
  60   |------+------+------+------+------+------|------+------+------+------+------+------|
  61   |   =  |   7  |   8  |   9  |   0  |   -  |   /  |   1  |   2  |   3  |   .  |  \   |
  62   |------+------+------+------+------+------+------+------+------+------+------+------|
  63   |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
  64   `-----------------------------------------------------------------------------------'
  65 ```
  66
  67 ## TouchCursor layer plus personal customizations
  68 [TouchCursor](http://martin-stone.github.io/touchcursor/) uses the `Space` key
  69 as the modifier, with the `IJKL` home row keys representing the inverted-T of
  70 the arrow keys. All of the default TouchCursor keymappings for the right hand
  71 are represented below. My personalizations include all of the keys shown for
  72 the left hand. Having the `Alt` and `Shift` keys readily accessible from the
  73 home row allows quick word jumps and highlighting when used in conjunction with
  74 the arrow keys. The `KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND,` and
  75 `KC_AGAIN` keycodes have been mapped but they don't seem to work on Mac.
  76 Presumably they'll work under Windows.
  77 ```
  78   ,-----------------------------------------------------------------------------------.
  79   |      |      |      |Shift | GUI  |  ~   |Insert| Home |  Up  | End  | Bksp |      |
  80   |------+------+------+------+------+-------------+------+------+------+------+------|
  81   |      | Alt  |Space |      | Find |Again | PgUp | Left | Down |Right |      |      |
  82   |------+------+------+------+------+------|------+------+------+------+------+------|
  83   |      | Undo | Cut  | Copy |Paste |  `   | PgDn | Del  |      |      |      |      |
  84   |------+------+------+------+------+------+------+------+------+------+------+------|
  85   |      |      |      |      |      |             |      |      |      |      |      |
  86   `-----------------------------------------------------------------------------------'
  87 ```
  88
  89 ## Mouse Layer
  90 The Mouse layer, closely mimics the layout/behaviour of the TouchCursor layer.
  91 The `A` key is used to activate this layer. All 16 keycodes for the mouse from
  92 the `doc/keycode.txt` file are represented, and logically located, IMHO. The
  93 left and right click buttons are duplicated; on the right hand side, for a
  94 quick click here and there, and again on the left hand side for when the
  95 buttons need to be held for dragging things or highlighting text, thus allowing
  96 the right hand to be free to use the up/down/left/right actions.
  97 ```
  98   ,-----------------------------------------------------------------------------------.
  99   |      |      |ACCL0 |ACCL1 |ACCL2 |ACCL2 |      |WHL_L |  Up  |WHL_R | BTN2 |      |
 100   |------+------+------+------+------+-------------+------+------+------+------+------|
 101   |      |      |      | BTN3 | BTN1 | BTN4 |WHL_Up| Left | Down |Right |      |      |
 102   |------+------+------+------+------+------|------+------+------+------+------+------|
 103   |      |      |      |      | BTN2 | BTN5 |WHL_Dn| BTN1 |      |      |      |      |
 104   |------+------+------+------+------+------+------+------+------+------+------+------|
 105   |      |      |      |      |      |             |      |      |      |      |      |
 106   `-----------------------------------------------------------------------------------'
 107 ```