keyboards/planck/keymaps/sean/readme.md

   1 # Sean Hunter's Planck Layout
   2
   3 ## Main layout
   4
   5 Inspired by my old typematrix dvorak keyboard, with escape, tab, enter and
   6 backspace in the middle.
   7
   8 ```
   9  ,-----------------------------------------------------------------------------------.
  10  |   "  |   ,  |   .  |   P  |   Y  |   /  |   =  |   F  |   G  |   C  |   R  |   L  |
  11  |------+------+------+------+------+------+------+------+------+------+------+------|
  12  |   A  |   O  |   E  |   U  |   I  | ESC  | BSPC |   D  |   H  |   T  |   N  |   S  |
  13  |------+------+------+------+------+------+------+------+------+------+------+------|
  14  |   ;  |   Q  |   J  |   K  |   X  | TAB  | ENT  |   B  |   M  |   W  |   V  |   Z  |
  15  |------+------+------+------+------+------+------+------+------+------+------+------|
  16  | Sft  | Ctl  | Alt  | Gui  |Lower |    Space    |Raise |   <  |   v  |   ^  |   >  |
  17  `-----------------------------------------------------------------------------------'
  18  ```
  19
  20 ## Lower
  21
  22 With Lower, the numbers are on the home row.  Brackets and braces are down the
  23 centre of the keyboard when holding lower, and most other special characters,
  24 can be found on the row below home.  One row up are the main function keys.
  25 The arrow keys become `Home`, `End` and `Page Up` and `Page Down`.
  26
  27  ```
  28  ,-----------------------------------------------------------------------------------.
  29  | F1   |  F2  |  F3  |  F4  |  F5  |  {   |  }   |  F6  |  F7  |  F8  |  F9  | F10  |
  30  |------+------+------+------+------+-------------+------+------+------+------+------|
  31  |  1   |   2  |   3  |   4  |   5  |  [   |  ]   |   6  |   7  |   8  |   9  |  0   |
  32  |------+------+------+------+------+------|------+------+------+------+------+------|
  33  |   ~  |   |  |   `  |   -  |   _  | INS  | DEL  |   (  |   )  |   +  |   =  |  \   |
  34  |------+------+------+------+------+------+------+------+------+------+------+------|
  35  | Sft  | Ctl  | Alt  | Gui  |Lower |             |Raise | Home | PgDn | PgUp | End  |
  36  `-----------------------------------------------------------------------------------'
  37 ```
  38
  39 ## Raise
  40
  41 With Raise, the middle row functions as though we are holding shift and typing
  42 numbers.  This makes it a little easier than trying to hold lower and shift at
  43 the same time.  The row below home is a set of keys mapped from `Gui-1` to
  44 `Gui-0`.  I use these to change virtual desktops on [i3](https://i3wm.org/).  I
  45 also include 'right' versions of the modifier keys on here.
  46
  47
  48  ```
  49  ,-----------------------------------------------------------------------------------.
  50  | F11  |  F12 |  F13 |  F14 |  F15 |      |      |  F16 |  F17 |  F18 |  F19 | F20  |
  51  |------+------+------+------+------+-------------+------+------+------+------+------|
  52  |  !   |   @  |   #  |   $  |   %  |Sleep | Wake |   ^  |   &  |   *  |   (  |  )   |
  53  |------+------+------+------+------+-------------+------+------+------+------+------|
  54  | GUI1 | GUI2 | GUI3 | GUI4 | GUI5 |      |      | GUI6 | GUI7 | GUI8 | GUI9 |GUI10 |
  55  |------+------+------+------+------+------+------+------+------+------+------+------|
  56  | Sft  | Ctl  | Alt  | Gui  |Lower |             |Raise | Gui  | Alt  | Ctl  | Sft  |
  57  `-----------------------------------------------------------------------------------'
  58
  59 ```
  60
  61 ## Adjust
  62
  63 Raise and lower at the same time give an adjustment layer, which allows
  64 changing to the numpad and movement layer, and adjusting the backlights
  65 (assuming you have them - I don't yet).  I have also added various media keys
  66 and the all-important `Reset` key for programming the keyboard.  I've got the
  67 ability to swap `Alt` and `Gui` in hardware and three special keys set up for
  68 [hammerspoon]( http://www.hammerspoon.org/) on mac.  If I ever start using this
  69 keyboard seriously on mac again (I'm using it mainly on Windows and Linux atm)
  70 I'll write a special Mac mode and redo all my hammerspoon config to be more
  71 like i3 on Linux.
  72
  73 ```
  74  Adjust (Lower + Raise)
  75  ,-----------------------------------------------------------------------------------.
  76  |      | Reset|      |      |      |AGnorm|AGswap|      |      |HRevl |HReset|HMenu |
  77  |------+------+------+------+------+-------------+------+------+------+------+------|
  78  | PWR  | EJCT | CUT  | COPY |PASTE |PrScr |SysReq| CAPS | <<   |  >>  | Mute | Stop |
  79  |------+------+------+------+------+------|------+------+------+------+------+------|
  80  |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      | Next | Vol- | Vol+ | Play |
  81  |------+------+------+------+------+------+------+------+------+------+------+------|
  82  |Brite |BToggl|      |      |             |      |      | Gui  | Alt  | Ctl  | Sft  |
  83  `-----------------------------------------------------------------------------------'
  84 ```
  85
  86 ## Numpad
  87
  88 I have added a numpad, although this is a little annoying at the moment as you
  89 have to first press `NumLock` to use.  I guess I could make a macro so as soon as
  90 you go into numpad mode it turns `NumLock` on.
  91
  92 ```
  93  ,-----------------------------------------------------------------------------------.
  94  |      |      |      |      |      |      |      |NumLck|   7  |   8  |   9  |   /  |
  95  |------+------+------+------+------+------+------+------+------+------+------+------|
  96  |      |      |      |      |      |      |      |Enter |   4  |   5  |   6  |   *  |
  97  |------+------+------+------+------+------+------+------+------+------+------+------|
  98  |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      |   3  |   2  |   1  |   -  |
  99  |------+------+------+------+------+-------------+------+------+------+------+------|
 100  |      |      |      |      |      |             |      |      |   0  |   .  |   +  |
 101  `-----------------------------------------------------------------------------------'
 102 ```
 103
 104 ## Movement
 105
 106 I have added a movement layer but at present I seldom use it.
 107
 108 ```
 109  ,-----------------------------------------------------------------------------------.
 110  |MsBut2|MsWhDn|MsWhUp|MsBut1|MsBut3|      |      |      | Home | PgDn | PgUp |  End |
 111  +------+------+------+------+------+------+------+------+------+------+------+------+
 112  |Ms Lft|Ms Dn |Ms Up |Ms Rht|      |      |      |      | Left | Down |  Up  | Right|
 113  |------+------+------+------+------+------+------+------+------+------+------+------|
 114  |DVORAK|NUMPAD| MVMT | SDRK |      |      |      |      |      |      |      |      |
 115  |------+------+------+------+------+-------------+------+------+------+------+------|
 116  | Sft  | Ctl  | Alt  | Gui  |      |             |      | Gui  | Alt  | Ctl  | Sft  |
 117  `-----------------------------------------------------------------------------------'
 118 ```
 119
 120 ## Software Dvorak mode
 121
 122 I have implemented a version of the main, lower and raise maps that works if
 123 the computer itself is in dvorak mode at the os level.  This allows me to work
 124 well on my laptop when I have to take it with me (eg to go to a meeting) and
 125 don't want the keyboard with me.  I simply set it in dvorak mode in the os and
 126 then put the keyboard into this mode.
 127
 128 ## TODO
 129
 130 1. Actually learn to use the media keys