layouts/community/ergodox/meagerfindings/README.md

   1 ![Base](https://meagerfindings.com/assets/img/ergodox/base.png)
   2
   3 # Meagerfinding's ErgoDox Layout
   4
   5 <!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
   6
   7 - [Overview](#overview)
   8 - [Credit where credit is due](#credit-where-credit-is-due)
   9 - [Features](#features)
  10         - [Tap/Hold Macro Keys](#taphold-macro-keys)
  11         - [TapDance Keys](#tapdance-keys)
  12 - [Base Layer](#base-layer)
  13         - [Things to note:](#things-to-note)
  14 - [Old Base Layer](#old-base-layer)
  15 - [Symbols Layer](#symbols-layer)
  16 - [Mouse & Media Keys Layer](#mouse-media-keys-layer)
  17 - [Markdown Layer](#markdown-layer)
  18 - [Arrow/Movements Layer](#arrowmovements-layer)
  19 - [Numpad Layer](#numpad-layer)
  20
  21 <!-- /TOC -->
  22
  23 ## Overview
  24
  25 The overall goals of this layout are to:
  26 1. Use the Ergodox thumb clusters to eliminate pinky reach.
  27 2. Place as many useful keys under the home rows as possible.
  28
  29 I first decided to build an ErgoDox as I wanted to use my thumbs for more with the added ergonomic benefits of a split board and ortholinear layout. I knew my hands were hurting from the weird contortions of copying and pasting constantly on my Mac, but I had no idea how strained I really was until I started moving as many modifier keys to the thumb clusters.
  30
  31 ## Credit where credit is due
  32
  33 The initial layout used created on the [ErgoDox EZ Configurator](https://ergodox-ez.com/pages/graphical-configurator). I went through 26+ iterations within the configurator prior to beginning my journey with QMK itself. Much of the dual function/layer keys are influenced by and adapted from the EZ Configurator.
  34
  35 Many features in this layout are either directly inspired by or are adaptations of [Algernon's incredible ErgoDox layout](https://github.com/algernon/ergodox-layout). Specifically: TapDance and its usage, and the brilliant idea of using TapDance to pair down the four keys for parens, brackets, and curly braces into just 2 keys.
  36
  37 ## Features
  38
  39 ### Tap/Hold Macro Keys
  40 * `Paste/Paste Special` key sends Paste on tap and Paste Special when held.
  41 * `Screen/Video` key sends `||scrn` when tapped and `||video` when held
  42   - [Typinator](http://www.ergonis.com/products/typinator/) expands `||scrn` into `(Screenshot: <CLIPBOARD CONTENTS>)`, and `||video` into `(Video: <CLIPBOARD CONTENTS>)`, the QMK macro then moves back to before the last paren, inserts a space and removes a space to create a hyperlink for use in Zendesk.
  43 * When tapped, `Todoist` toggles quick add window for a new Todoist task (`CMD + Shift + A`) and switches to Todoist when held
  44 * The RubyMine key opens RubyMine by triggering spotlight, typing out `Rubymine`, and submitting the enter key.
  45 * `Zendesk` triggers spotlight and then calls Typinator expansion to open my Zendesk Agent dashboard in Chrome.
  46
  47
  48 ### TapDance Keys
  49 * `Copy/Cut` key copies on tap, cut's on two taps.
  50 * One tap on `Snagit` key = sends `Ctrl + Shift + C` which is Snagit's selector and two taps on `Snagit` key = `Cmd + Shift + Opt + 4`, OS X cropping screenshot that is copied to the clipboard only.
  51 * Tapping the `[{(`/`)}]` keys once yields `[` or `{` when the shift key is engaged, tapping them twice yields `(`.
  52
  53 ## Base Layer
  54
  55 ![Base](https://meagerfindings.com/assets/img/ergodox/base.png)
  56
  57 The base layer retains the alphas from the QWERTY layout without any modifications.
  58
  59 ### Things to note:
  60
  61 - The shift key is a One Shot Modifier key, meaning shift is not submitted when the key is tapped, instead, it only submits when you either tap it again, or on the next key press.
  62   - There is no CAPSLOCK key designated as it is pretty comfortable to simply hold down shift in this layout and continue typing.
  63 - There is only one layer that you can fully switch to on this layout, the [Old Base layer](#old-base-layer). All other layers require holding a key to reach them. For the most part, the key that toggles a layer, will be on the opposite hand that will be typing with that layer.
  64   - For example: the symbols layer is reached by holding down the enter key with your right thumb, and most of the symbols are located on the left hand board.
  65
  66
  67 ## Old Base Layer
  68
  69 ![Old Base](https://meagerfindings.com/assets/img/ergodox/old_base.png)
  70
  71 I am moving into a new position (software engineering) at work from a Support position. My hope is to use my F keys more often and write fewer emails. This is my old base layer, still easily accessible, as I'm not used to having F key's on my top row quite yet.
  72
  73 ## Symbols Layer
  74
  75 ![Symbols](https://meagerfindings.com/assets/img/ergodox/symbols.png)
  76
  77 Holding down the `enter` key with your right thumb toggles the symbol layer.
  78
  79 I've placed my most used symbols under the homerow. Granted, right now I mainly right emails/support ticket responses, so this home row may need to change as I transition to software engineering.
  80
  81 ## Mouse & Media Keys Layer
  82
  83 ![Mouse & Media](https://meagerfindings.com/assets/img/ergodox/mouse_media.png)
  84
  85 Holding down the `:` key on with your right pinky toggles the mouse and media layer. Your left hand controls the mouse directions just in a similar fashion to the keys used in the [movement layer](#arrowmovements-layer).
  86
  87 The right hand has a media controls under the homerow for quick muting/pausing.
  88
  89 * `XKCD #1319` Key that ironically partially-automates accessing the link to [XKCD #1319](https://xkcd.com/1319/).
  90
  91 ## Markdown Layer
  92
  93 ![Markdown](https://meagerfindings.com/assets/img/ergodox/markdown.png)
  94
  95 This layer places most common markdown symbols under the right hand. You can reach this layer by holding down the `F` key on your left hand.
  96
  97 ## Arrow/Movements Layer
  98
  99 ![Movement](https://meagerfindings.com/assets/img/ergodox/movement_arrows.png)
 100
 101 Toggled by holding down the space key with the right thumb. This isn't vim like movement, nope, it's `WASD` but over one column. So I guess it's actually `ESDF` on the left hand and `IJKL` on the right hand to better line up with the columns offset/staggered columns on the Dox.
 102
 103 ## Numpad Layer
 104
 105 ![Numpad](https://meagerfindings.com/assets/img/ergodox/numpad.png)
 106
 107 My right hand is pretty comfortable with tenkey number input so this is easily accessible by holding down backspace with the left thumb.
 108
 109 Also, on the left hand, there is a tap to copy and hold to cut macro under the `D` key, and a tap to paste and a hold to paste special macro on the `F` key. I guess I'm to too lazy to move my fingers when copying/pasting...