layouts/community/ergodox/townk_osx/readme.md

   1 # Townk's Keymap
   2
   3 Trying to take care of an enjury on my arm I borrow an ergonomic keyboard from
   4 a frient ([Kinesis Advantage](http://www.kinesis-ergo.com/shop/advantage-pro-for-pc-mac/)).
   5
   6 I really enjoyed my time with it but there were some anoyancies:
   7
   8 * The curvature on the keys bothered me since I'm a Vim user and using the
   9   motion keys on my editor was awkard.
  10 * I had to spend too much time remapping the keyboard to make some symbol keys
  11   more accessible to me.
  12 * The fact that my hands had to stay close to each other was a bit stressfull
  13   to my sholders.
  14
  15 After a long research I find out that Ergodox EZ would be perfect for my needs
  16 and purchase one. Before the keyboard even got in my hands I started to think
  17 on the layout I would use on it and soon enough I planed couple adjustments
  18 from the Kinesis I was using so far.
  19
  20 ## The layout
  21
  22 Here are the layout mapping in images so you can have a glimpse on it:
  23
  24 ![Base Layout](https://i.imgur.com/m1yyQvU.png)
  25 ![fn Layout](https://i.imgur.com/AJIzrjq.png)
  26 ![Keypad & Mouse Layout](https://i.imgur.com/9I6Qr0e.png)
  27
  28 Notice that, differently from the default behavior, my layer keys are not transparent
  29 by default, which means that if you press any non-labeled white key, nothing will be
  30 handled to the OS.
  31
  32 ### One shot keys
  33
  34 It all started with the access to the function keys (F1, F2, F3...), since
  35 those keys are located on a different layer I needed a way to press them with
  36 minimal effort without disrupting my flow.
  37
  38 For me, togglihg a layer to press a button and than toggle it back is a waste
  39 of time (although I admit it's a single tap from what I have), so I decided to
  40 do it as a one shot key. I could press it and the next pressed key would be
  41 handled by the target layer which just after it delivers the key to the OS it
  42 would get back to the previous layer.
  43
  44 After setting up my layout to do just that I realized that occasionally I
  45 would stop myseld on the middle of the process and the one shot layer would be
  46 still triggered until I press any other key. So to prevent me from tapping
  47 keys I don't want I added a timeout of 3 seconds for the one shot actions.
  48
  49 Ultimately I tested the shift key as a one shot one and really like it, so
  50 here you have it, all the one shot keys on my layout.
  51
  52 ## Glossary
  53
  54 If you're not familiar with the Mac symbols used on some keys, here is a
  55 reference to them:
  56
  57 | Symbol | Description         |
  58 | :----: | ------------------- |
  59 |   ⌘    | Command             |
  60 |   ⇪    | Caps Lock           |
  61 |   ⇧    | Shift               |
  62 |   ⌥    | Option (alt)        |
  63 |   ⎋    | Esc                 |
  64 |   ⇥    | Tab forward         |
  65 |   ⇤    | Tab backward        |
  66 |   ⌃    | Control             |
  67 |   ␣    | Space               |
  68 |   ⌫    | Backspace           |
  69 |   ⌦    | Delete              |
  70 |   ⏎    | Enter               |
  71 |   ⌤    | Return              |
  72 |   ⌽    | Power on/off button |
  73 |   ↖    | Home                |
  74 |   ↘    | End                 |
  75 |   ⇞    | Page up             |
  76 |   ⇟    | Page down           |
  77 |   ⌧    | Clear               |