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 `default_layer_set()` since this is my personal perference.
  11
  12 ## Macros
  13 ```
  14 #define ALT_TAB     M(KC_ALT_TAB)
  15 ```
  16
  17 ## Base Layers (Qwerty/Colemak/Dvorak)
  18 These base layers are mostly the same as the default mappings. The interesting
  19 changes are shown below. The `Ctrl/Esc`, mapped using `CTL_T(KC_ESC)` will emit
  20 an `Escape` when tapped, and act as a `Control` key when held. A `TODO` item is
  21 to see if it can also act as a `CapsLock` when double-tapped. The right shift
  22 key acts as `Enter` when tapped, and as a `Shift` key when held. The arrow
  23 keys, which have been moved to the
  24 [TouchCursor](http://martin-stone.github.io/touchcursor/) layer, have been
  25 replaced with the Media keys as shown. The `ML/A` key activates the Mouse layer
  26 when held, and emits an `A` when tapped.
  27 ```
  28   ,-----------------------------------------------------------------------------------------.
  29   |          |      |      |      |      |      |      |      |      |      |      |        |
  30   |----------+------+------+------+------+-------------+------+------+------+------+--------|
  31   | Ctrl/Esc | ML/A |      |      |      |      |      |      |      |      |      |        |
  32   |----------+------+------+------+------+------|------+------+------+------+------+--------|
  33   |          |      |      |      |      |      |      |      |      |      |      |Sft/Ent |
  34   |----------+------+------+------+------+------+------+------+------+------+------+--------|
  35   | PrntScrn | RGUI | Alt  | GUI  |Lower |  TC/Space   |Raise | Next | Vol- | Vol+ |  Play  |
  36   `-----------------------------------------------------------------------------------------'
  37 ```
  38
  39 ## Lower Layer (Symbols and Function Keys)
  40 The symbols and functions keys are essentially the same as the default mapping.
  41 The most notable changes are that the symbol keys from the `RAISE` layer have
  42 been moved here. The remaining Media keys replace those that are now on the
  43 base layers. The `BACKLIT` key has also been moved here.
  44 ```
  45   ,-----------------------------------------------------------------------------------.
  46   |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
  47   |------+------+------+------+------+-------------+------+------+------+------+------|
  48   |   [  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
  49   |------+------+------+------+------+------|------+------+------+------+------+------|
  50   |   ]  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |   -  |   =  |   [  |   ]  |  \   |
  51   |------+------+------+------+------+------+------+------+------+------+------+------|
  52   |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
  53   `-----------------------------------------------------------------------------------'
  54 ```
  55
  56 ## Raise Layer (Numbers and Arithmetic Operators)
  57 All of the numbers and arithmetic operators are available on this layer. Some
  58 keys are duplicated for the convenience of their positions. The `0` and `$`
  59 keys at the far left are for quick access to beginning and end of line in vim.
  60 ```
  61   ,-----------------------------------------------------------------------------------.
  62   |   0  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
  63   |------+------+------+------+------+-------------+------+------+------+------+------|
  64   |   $  |   4  |   5  |   6  |   .  |   +  |   .  |   4  |   5  |   6  |   *  |  |   |
  65   |------+------+------+------+------+------|------+------+------+------+------+------|
  66   |   =  |   7  |   8  |   9  |   0  |   -  |   .  |   1  |   2  |   3  |   /  |  \   |
  67   |------+------+------+------+------+------+------+------+------+------+------+------|
  68   |Brite |      |      |      |      |             |      | Prev | Stop | Slct | Mute |
  69   `-----------------------------------------------------------------------------------'
  70 ```
  71
  72 ## TouchCursor layer plus personal customizations
  73 [TouchCursor](http://martin-stone.github.io/touchcursor/) uses the `Space` key
  74 as the modifier, with the `IJKL` home row keys representing the inverted-T of
  75 the arrow keys. All of the default TouchCursor keymappings for the right hand
  76 are represented below. My personalizations include all of the keys shown for
  77 the left hand. Having the `Alt` and `Shift` keys (as well as the `Control` key
  78 from the base layers) readily accessible from the home row allows quick word
  79 jumps and highlighting when used in conjunction with the arrow keys. The
  80 `Alt-Tab` macro is not only useful under Windows, but also under Mac when used
  81 with alternative switchers like [HyperSwitch](https://bahoom.com/hyperswitch).
  82 The `Cmd-Tab` and `Ctrl-Tab` sequences are duplicated for easy access while in
  83 this layer. The `KC_UNDO, KC_CUT, KC_COPY, KC_PASTE, KC_FIND,` and `KC_AGAIN`
  84 keycodes do not seem to work. There are macros in place that'll "automatically"
  85 choose the correct version (`Cmd-Tab` vs. `Alt-Tab`, `Cmd-C` vs. `Ctrl-C`,
  86 etc.) depending on which layout you've currently selected (`AG_NORM` or
  87 `AG_SWAP`) in the `_ADJUST` layer. The `Desk_L` and `Desk_R` macros are what I
  88 use to switch between Virtual Desktops Left/Right.
  89 ```
  90   ,-----------------------------------------------------------------------------------.
  91   |AltTab|CmdTab|CtlTab|  GUI |Shift |  ~   |Insert| Home |  Up  | End  | Bksp |      |
  92   |------+------+------+------+------+-------------+------+------+------+------+------|
  93   |      | Alt  |Space |      | Find |Again | PgUp | Left | Down |Right |Desk_L|Desk_R|
  94   |------+------+------+------+------+------|------+------+------+------+------+------|
  95   |      | Undo | Cut  | Copy |Paste |  `   | PgDn | Del  |      |      |      |      |
  96   |------+------+------+------+------+------+------+------+------+------+------+------|
  97   |      |      |      |      |      |             |      |      |      |      |      |
  98   `-----------------------------------------------------------------------------------'
  99 ```
 100
 101 ## Mouse Layer
 102 The Mouse layer, closely mimics the layout/behaviour of the TouchCursor layer.
 103 The `D` key (on QWERTY) is used to activate this layer. All 16 keycodes for the
 104 mouse from the `doc/keycode.txt` file are represented, and logically located,
 105 IMHO. The left and right click buttons are duplicated; on the right hand side,
 106 for a quick click here and there, and again on the left hand side for when the
 107 buttons need to be held for dragging things or highlighting text, thus allowing
 108 the right hand to be free to use the up/down/left/right actions.
 109 ```
 110   ,-----------------------------------------------------------------------------------.
 111   |      |      |ACCL0 |      |      |      |      |WHL_L |  Up  |WHL_R | BTN2 |      |
 112   |------+------+------+------+------+-------------+------+------+------+------+------|
 113   |      |ACCL2 | BTN2 |      | BTN1 |ACCL1 |WHL_Up| Left | Down |Right | BTN4 | BTN5 |
 114   |------+------+------+------+------+------|------+------+------+------+------+------|
 115   |      |      |      |      | BTN3 |      |WHL_Dn| BTN1 |      |      | BTN3 |      |
 116   |------+------+------+------+------+------+------+------+------+------+------+------|
 117   |      |      |      |      |      |             |      |      |      |      |      |
 118   `-----------------------------------------------------------------------------------'
 119 ```