aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Keene <git@nicholaskeene.com>2017-02-14 22:47:11 -0600
committerNicholas Keene <git@nicholaskeene.com>2017-02-14 22:47:11 -0600
commit54785c1976590dc3081f06ca49747dfcb6ecd3b3 (patch)
tree67b2ae7c4dce2482b486988ee026075763795386
parente006b4a600379e30918235c4cdf58f7678ccd1d4 (diff)
downloadqmk_firmware-54785c1976590dc3081f06ca49747dfcb6ecd3b3.tar.gz
qmk_firmware-54785c1976590dc3081f06ca49747dfcb6ecd3b3.zip
The Ordinary Layout is boring, normal, typical, expected.
-rw-r--r--keyboards/ergodox/keymaps/ordinary/keymap.c146
-rw-r--r--keyboards/ergodox/keymaps/ordinary/readme.md33
2 files changed, 125 insertions, 54 deletions
diff --git a/keyboards/ergodox/keymaps/ordinary/keymap.c b/keyboards/ergodox/keymaps/ordinary/keymap.c
index 5c01d9678..b79f0f064 100644
--- a/keyboards/ergodox/keymaps/ordinary/keymap.c
+++ b/keyboards/ergodox/keymaps/ordinary/keymap.c
@@ -9,6 +9,7 @@
9#define SYMB 1 // symbols layer 9#define SYMB 1 // symbols layer
10#define MDIA 2 // media layer 10#define MDIA 2 // media layer
11#define SPEC 3 // special layer 11#define SPEC 3 // special layer
12#define RBASE 4 // reverse default layer
12 13
13#define LSymb 10 // left symbol-shift key 14#define LSymb 10 // left symbol-shift key
14#define LMdia 11 // left media-shift key 15#define LMdia 11 // left media-shift key
@@ -17,15 +18,21 @@
17#define RMdia 14 // right media-shift key 18#define RMdia 14 // right media-shift key
18#define RSpec 15 // right special-shift key 19#define RSpec 15 // right special-shift key
19 20
21#define NotEq 16 // != macro
22#define Point 17 // -> macro
23
20#define MUL 20 // mouse up left 24#define MUL 20 // mouse up left
21#define MUR 21 // mouse up right 25#define MUR 21 // mouse up right
22#define MDL 22 // mouse down left 26#define MDL 22 // mouse down left
23#define MDR 23 // mouse down right 27#define MDR 23 // mouse down right
24 28
29
30
25/* 31/*
26 * The Ordinary Layout for the Ergodox EZ keyboard, v4.20 32 * The Ordinary Layout for the Ergodox EZ keyboard, v5
27 * 33 *
28 * Modifications from default by Nicholas Keene ergodoxez@nicholaskeene.com 34 * Modifications from the default Ergodox EZ layout
35 * by Nicholas Keene ergodoxez@nicholaskeene.com
29 * 36 *
30 * No rights reserved. This software is in the public domain. 37 * No rights reserved. This software is in the public domain.
31 * Credit me if you are friendly but if you're a jerk don't bother. 38 * Credit me if you are friendly but if you're a jerk don't bother.
@@ -44,7 +51,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
44 * |------------+------+------+------+------+-------------| |------+------+------+------+------+------+------------| 51 * |------------+------+------+------+------+-------------| |------+------+------+------+------+------+------------|
45 * | Media Tab | Q | W | E | R | T | [ | | ] | Y | U | I | O | P | \| Media | 52 * | Media Tab | Q | W | E | R | T | [ | | ] | Y | U | I | O | P | \| Media |
46 * |------------+------+------+------+------+------| | | |------+------+------+------+------+------------| 53 * |------------+------+------+------+------+------| | | |------+------+------+------+------+------------|
47 * | Symbol | A | S | D | F | G |------| |------| H | J | K | L | ; | '" Symbol | 54 * | Symbol | ^A | S | D | ^F | G |------| |------| H | ^J | K | L | ^; | '" Symbol |
48 * |------------+------+------+------+------+------|Shift | | Tab |------+------+------+------+------+------------| 55 * |------------+------+------+------+------+------|Shift | | Tab |------+------+------+------+------+------------|
49 * | Capitals | Z | X | C | V | B | -Tab | | | N | M | , | . | / | Capitals | 56 * | Capitals | Z | X | C | V | B | -Tab | | | N | M | , | . | / | Capitals |
50 * `------------+------+------+------+------+-------------' `-------------+------+------+------+------+------------' 57 * `------------+------+------+------+------+-------------' `-------------+------+------+------+------+------------'
@@ -60,24 +67,24 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
60 */ 67 */
61[BASE] = KEYMAP( 68[BASE] = KEYMAP(
62// left hand 69// left hand
63 F(LSpec) ,KC_1 ,KC_2 ,KC_3 ,KC_4 ,KC_5 ,KC_ESC 70 F(LSpec) ,KC_1 ,KC_2 ,KC_3 ,KC_4 ,KC_5 ,KC_ESC
64,F(LMdia) ,KC_Q ,KC_W ,KC_E ,KC_R ,KC_T ,KC_LBRC 71,F(LMdia) ,KC_Q ,KC_W ,KC_E ,KC_R ,KC_T ,KC_LBRC
65,M(LSymb) ,KC_A ,KC_S ,KC_D ,KC_F ,KC_G 72,M(LSymb) ,LT(RBASE, KC_A),KC_S ,KC_D ,LT(RBASE, KC_F) ,KC_G
66,KC_LSFT ,KC_Z ,KC_X ,KC_C ,KC_V ,KC_B ,LSFT(KC_TAB) 73,KC_LSFT ,KC_Z ,KC_X ,KC_C ,KC_V ,KC_B ,LSFT(KC_TAB)
67,KC_LCTL ,KC_MEH ,KC_HYPR,KC_LALT,KC_LGUI 74,KC_SCLN ,MEH_T(KC_NO) ,ALL_T(KC_NO),KC_LALT,KC_LGUI
68 ,KC_HOME,KC_END 75 ,KC_HOME,KC_END
69 ,KC_PGUP 76 ,KC_PGUP
70 ,KC_BSPC,KC_DEL ,KC_PGDN 77 ,KC_BSPC,KC_DEL ,KC_PGDN
71 // right hand 78 // right hand
72 ,KC_MINS ,KC_6 ,KC_7 ,KC_8 ,KC_9 ,KC_0 ,F(RSpec) 79 ,KC_MINS ,KC_6 ,KC_7 ,KC_8 ,KC_9 ,KC_0 ,F(RSpec)
73 ,KC_RBRC ,KC_Y ,KC_U ,KC_I ,KC_O ,KC_P ,F(RMdia) 80 ,KC_RBRC ,KC_Y ,KC_U ,KC_I ,KC_O ,KC_P ,F(RMdia)
74 ,KC_H ,KC_J ,KC_K ,KC_L ,KC_SCLN ,F(RSymb) 81 ,KC_H ,LT(RBASE, KC_J),KC_K ,KC_L ,LT(RBASE,KC_SCLN),F(RSymb)
75 ,KC_TAB ,KC_N ,KC_M ,KC_COMM,KC_DOT ,KC_SLSH ,KC_RSFT 82 ,KC_TAB ,KC_N ,KC_M ,KC_COMM,KC_DOT ,KC_SLSH ,KC_RSFT
76 ,KC_RGUI,KC_RALT,KC_HYPR ,KC_MEH ,KC_RCTL 83 ,KC_RGUI ,KC_RALT,KC_HYPR,KC_MEH ,KC_RCTL
77 ,KC_LEFT ,KC_RGHT 84 ,KC_LEFT ,KC_RGHT
78 ,KC_UP 85 ,KC_UP
79 ,KC_DOWN ,KC_ENT ,KC_SPC 86 ,KC_DOWN ,KC_ENT ,KC_SPC
80 ), 87),
81 88
82/******* Symbols Layer ************************************************************************************************* 89/******* Symbols Layer *************************************************************************************************
83 * 90 *
@@ -90,35 +97,35 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
90 * |-----------+------+------+------+------+------| Tab | | Shift|------+------+------+------+------+-----------| 97 * |-----------+------+------+------+------+------| Tab | | Shift|------+------+------+------+------+-----------|
91 * | | % | ^ | [ | ] | ~ | | | -Tab| \ | 1 | 2 | 3 | - | | 98 * | | % | ^ | [ | ] | ~ | | | -Tab| \ | 1 | 2 | 3 | - | |
92 * `-----------+------+------+------+------+-------------' `-------------+------+------+------+------+-----------' 99 * `-----------+------+------+------+------+-------------' `-------------+------+------+------+------+-----------'
93 * | LCtrl | Meh |Hyper | LAlt | LGui | | 0 | . | = | + | Ent | 100 * | ; | & | * | < | > | | 0 | . | = | + | Enter |
94 * `-----------------------------------' `-----------------------------------' 101 * `-----------------------------------' `-----------------------------------'
95 * ,-------------. ,-------------. 102 * ,-------------. ,-------------.
96 * | Left | Right| | Home | End | 103 * ||||||||||||||| |||||||||||||||
97 * ,------|------|------| |------+------+------. 104 * ,------|------|------| |------+------+------.
98 * | | | Up | | PgUp | | | 105 * | Plus | Equal|||||||| |||||||| Under| Dash |
99 * |Space |Enter |------| |------|BackSp| Del | 106 * | | |------| |------| Score| |
100 * | | | Down | | PgDn | | | 107 * | + | = | != | | -> | _ | - |
101 * `--------------------' `--------------------' 108 * `--------------------' `--------------------'
102 */ 109 */
103[SYMB] = KEYMAP( 110[SYMB] = KEYMAP(
104// left hand 111// left hand
105 KC_TRNS ,KC_F1 ,KC_F2 ,KC_F3 ,KC_F4 ,KC_F5 ,KC_ESC 112 KC_TRNS ,KC_F1 ,KC_F2 ,KC_F3 ,KC_F4 ,KC_F5 ,KC_ESC
106,KC_TRNS ,KC_EXLM ,KC_AT ,KC_LCBR ,KC_RCBR ,KC_AMPR ,LSFT(KC_COMM) 113,KC_TRNS ,KC_EXLM ,KC_AT ,KC_LCBR ,KC_RCBR ,KC_AMPR ,LSFT(KC_COMM)
107,KC_TRNS ,KC_HASH ,KC_DLR ,KC_LPRN ,KC_RPRN ,KC_GRV 114,KC_TRNS ,KC_HASH ,KC_DLR ,KC_LPRN ,KC_RPRN ,KC_GRV
108,KC_TRNS ,KC_PERC ,KC_CIRC ,KC_LBRC ,KC_RBRC ,KC_TILD ,KC_TAB 115,KC_TRNS ,KC_PERC ,KC_CIRC ,KC_LBRC ,KC_RBRC ,KC_TILD ,KC_TAB
109,KC_LCTL ,KC_MEH ,KC_HYPR ,KC_LALT ,KC_LGUI 116,KC_LCTL ,KC_AMPR ,KC_ASTR ,LSFT(KC_COMM),LSFT(KC_DOT)
110 ,KC_LEFT ,KC_RGHT 117 ,KC_NO ,KC_NO
111 ,KC_UP 118 ,KC_NO
112 ,KC_SPC ,KC_ENT ,KC_DOWN 119 ,KC_PLUS ,KC_EQL ,M(NotEq)
113 // right hand 120 // right hand
114 ,KC_MINS ,KC_F6 ,KC_F7 ,KC_F8 ,KC_F9 ,KC_F10 ,KC_TRNS 121 ,KC_MINS ,KC_F6 ,KC_F7 ,KC_F8 ,KC_F9 ,KC_F10 ,KC_TRNS
115 ,LSFT(KC_DOT),KC_PIPE ,KC_7 ,KC_8 ,KC_9 ,KC_SLSH ,KC_TRNS 122 ,LSFT(KC_DOT),KC_PIPE ,KC_7 ,KC_8 ,KC_9 ,KC_SLSH ,KC_TRNS
116 ,KC_SLSH ,KC_4 ,KC_5 ,KC_6 ,KC_ASTR ,KC_TRNS 123 ,KC_SLSH ,KC_4 ,KC_5 ,KC_6 ,KC_ASTR ,KC_TRNS
117 ,LSFT(KC_TAB),KC_BSLS ,KC_1 ,KC_2 ,KC_3 ,KC_MINS ,KC_TRNS 124 ,LSFT(KC_TAB),KC_BSLS ,KC_1 ,KC_2 ,KC_3 ,KC_MINS ,KC_TRNS
118 ,KC_0 ,KC_DOT ,KC_EQL,KC_PLUS ,KC_ENT 125 ,KC_0 ,KC_DOT ,KC_EQL,KC_PLUS ,KC_ENT
119 ,KC_HOME ,KC_END 126 ,KC_NO ,KC_NO
120 ,KC_PGUP 127 ,KC_NO
121 ,KC_PGDN ,KC_BSPC ,KC_DEL 128 ,M(Point) ,LSFT(KC_MINS),KC_MINS
122), 129),
123 130
124/******* Media Layer ******************************************************************************************************* 131/******* Media Layer *******************************************************************************************************
@@ -132,7 +139,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
132 * |------+---------+---------+---------+---------+---------|Scroll| |Scroll|---------+---------+---------+---------+---------+------| 139 * |------+---------+---------+---------+---------+---------|Scroll| |Scroll|---------+---------+---------+---------+---------+------|
133 * | | |MouseDnLf|MouseDown|MouseDnRg| Mute | Down | | Down | | End | Down | PgDn | | | 140 * | | |MouseDnLf|MouseDown|MouseDnRg| Mute | Down | | Down | | End | Down | PgDn | | |
134 * `------+---------+---------+---------+---------+----------------' `----------------+---------+---------+---------+---------+------' 141 * `------+---------+---------+---------+---------+----------------' `----------------+---------+---------+---------+---------+------'
135 * |LCtrl| Meh | MClick | LClick | R Click| |Cmd/Insrt|Optn/Del | Hyper | Meh |RCtrl| 142 * | | | MClick | LClick | R Click| | Insert | Del | | | |
136 * `---------------------------------------------' `---------------------------------------------' 143 * `---------------------------------------------' `---------------------------------------------'
137 * ,-------------. ,-------------. 144 * ,-------------. ,-------------.
138 * | Stop |Refrsh| | Prev | Next | 145 * | Stop |Refrsh| | Prev | Next |
@@ -148,7 +155,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
148,KC_TRNS ,KC_POWER ,M(MUL) ,KC_MS_U ,M(MUR) ,KC_VOLU ,KC_WH_U 155,KC_TRNS ,KC_POWER ,M(MUL) ,KC_MS_U ,M(MUR) ,KC_VOLU ,KC_WH_U
149,KC_TRNS ,KC_SLEP ,KC_MS_L ,KC_MS_D ,KC_MS_R ,KC_VOLD 156,KC_TRNS ,KC_SLEP ,KC_MS_L ,KC_MS_D ,KC_MS_R ,KC_VOLD
150,KC_TRNS ,KC_NO ,M(MDL) ,KC_MS_D ,M(MDR) ,KC_MUTE ,KC_WH_D 157,KC_TRNS ,KC_NO ,M(MDL) ,KC_MS_D ,M(MDR) ,KC_MUTE ,KC_WH_D
151,KC_LCTL ,KC_MEH ,KC_BTN3 ,KC_BTN1 ,KC_BTN2 158,KC_NO ,KC_NO ,KC_BTN3 ,KC_BTN1 ,KC_BTN2
152 ,KC_WSTP ,KC_WREF 159 ,KC_WSTP ,KC_WREF
153 ,KC_WSCH 160 ,KC_WSCH
154 ,KC_WBAK ,KC_NO ,KC_WHOM 161 ,KC_WBAK ,KC_NO ,KC_WHOM
@@ -157,7 +164,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
157 ,KC_WH_U ,KC_PSCR ,KC_HOME ,KC_UP ,KC_PGUP ,KC_MAIL ,KC_TRNS 164 ,KC_WH_U ,KC_PSCR ,KC_HOME ,KC_UP ,KC_PGUP ,KC_MAIL ,KC_TRNS
158 ,KC_NLCK ,KC_LEFT ,KC_DOWN ,KC_RIGHT,KC_MYCM ,KC_TRNS 165 ,KC_NLCK ,KC_LEFT ,KC_DOWN ,KC_RIGHT,KC_MYCM ,KC_TRNS
159 ,KC_WH_D ,KC_NO ,KC_END ,KC_DOWN ,KC_PGDN ,KC_NO ,KC_TRNS 166 ,KC_WH_D ,KC_NO ,KC_END ,KC_DOWN ,KC_PGDN ,KC_NO ,KC_TRNS
160 ,GUI_T(KC_INS),ALT_T(KC_DEL),KC_HYPR ,KC_MEH ,KC_RCTL 167 ,KC_INS ,KC_DEL ,KC_NO ,KC_NO ,KC_NO
161 ,KC_MPRV ,KC_MNXT 168 ,KC_MPRV ,KC_MNXT
162 ,KC_VOLU 169 ,KC_VOLU
163 ,KC_VOLD ,KC_MSTP ,KC_MPLY 170 ,KC_VOLD ,KC_MSTP ,KC_MPLY
@@ -203,7 +210,49 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
203 ,KC_TRNS ,KC_TRNS 210 ,KC_TRNS ,KC_TRNS
204 ,KC_TRNS 211 ,KC_TRNS
205 ,KC_TRNS ,KC_TRNS ,KC_TRNS 212 ,KC_TRNS ,KC_TRNS ,KC_TRNS
206 ) 213),
214
215/******* Reverse Base Layer *********************************************************************************************
216 *
217 * ,------------------------------------------------------. ,------------------------------------------------------.
218 * | =+ | 0 | 9 | 8 | 7 | 6 | - | | Esc | 5 | 4 | 3 | 2 | 1 | `~ |
219 * |------------+------+------+------+------+-------------| |------+------+------+------+------+------+------------|
220 * | \| | P | O | I | U | Y | ] | | [ | T | R | E | W | Q | Tab |
221 * |------------+------+------+------+------+------| | | |------+------+------+------+------+------------|
222 * | | ; | L | K | J | H |------| |------| G | F | D | S | A | '" |
223 * |------------+------+------+------+------+------| Tab | |Shift |------+------+------+------+------+------------|
224 * | Capitals | / | . | , | M | N | | | -Tab | B | V | C | X | Z | Capitals |
225 * `------------+------+------+------+------+-------------' `-------------+------+------+------+------+------------'
226 * | LCtrl | Meh |Hyper | LAlt | LGui | | RGui | RAlt | Hyper| Meh | RCtrl |
227 * `-----------------------------------' `-----------------------------------'
228 * ,-------------. ,-------------.
229 * | Left | Right| | Home | End |
230 * ,------|------|------| |------+------+------.
231 * | | | Up | | PgUp | | |
232 * |Space |Enter |------| |------|BackSp| Del |
233 * | | | Down | | PgDn | | |
234 * `--------------------' `--------------------'
235 */
236[RBASE] = KEYMAP(
237// left hand
238 KC_EQL ,KC_0 ,KC_9 ,KC_8 ,KC_7 ,KC_6 ,KC_MINS
239,KC_BSLS ,KC_P ,KC_O ,KC_I ,KC_U ,KC_Y ,KC_RBRC
240,KC_NO ,LT(RBASE, KC_SCLN) ,KC_L ,KC_K ,LT(RBASE, KC_J) ,KC_H
241,KC_RSFT ,KC_SLSH ,KC_DOT ,KC_COMM,KC_M ,KC_N ,KC_TAB
242,KC_RCTL ,MEH_T(KC_NO),ALL_T(KC_NO),KC_RALT,KC_RGUI
243 ,KC_LEFT ,KC_RGHT
244 ,KC_UP
245 ,KC_SPC ,KC_ENT ,KC_DOWN
246 // right hand
247 ,KC_ESC ,KC_5 ,KC_4 ,KC_3 ,KC_2 ,KC_1 ,KC_GRV
248 ,KC_LBRC ,KC_T ,KC_R ,KC_E ,KC_W ,KC_Q ,KC_TAB
249 ,KC_G ,LT(RBASE, KC_F),KC_D ,KC_S ,LT(RBASE, KC_A) ,F(LSymb)
250 ,LSFT(KC_TAB),KC_B ,KC_V ,KC_C ,KC_X ,KC_Z ,KC_LSFT
251 ,KC_LGUI,KC_LALT,KC_HYPR ,KC_MEH,KC_LCTL
252 ,KC_HOME ,KC_END
253 ,KC_PGUP
254 ,KC_PGDN ,KC_BSPC ,KC_DEL
255)
207}; 256};
208 257
209const uint16_t PROGMEM fn_actions[] = { 258const uint16_t PROGMEM fn_actions[] = {
@@ -227,14 +276,13 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
227{ 276{
228 switch(id) { 277 switch(id) {
229 // There are two shift keys for each layer so we increment a layer_shift var when one 278 // There are two shift keys for each layer so we increment a layer_shift var when one
230 // is pressed and decrement when one is released. If both are pressed at the same time 279 // is pressed and decrement when one is released. The shift counts are bound between 0 and 2
231 // then the layer is locked (or unlocked). The shift counts are bound between 0 and 2
232 // only because sometimes rapid pressing led to irregular events; this way the states 280 // only because sometimes rapid pressing led to irregular events; this way the states
233 // are self healing during use. 281 // are self healing during use.
234 282
235 case LSymb: // 283 case LSymb: //
236 if (record->event.pressed) { // when the LSymb button is pressed 284 if (record->event.pressed) { // when the LSymb button is pressed
237 if(++symb_shift > 2) mdia_shift = 2; // increment the symb shift count, max two 285 if(++symb_shift > 2) symb_shift = 2; // increment the symb shift count, max two
238 if(spec_shift) symb_lock = !symb_lock; // if the Special layer is on, toggle the shift lock 286 if(spec_shift) symb_lock = !symb_lock; // if the Special layer is on, toggle the shift lock
239 layer_on(SYMB); // in any case, turn on the Symbols layer 287 layer_on(SYMB); // in any case, turn on the Symbols layer
240 } else { // when the LSymb button is released 288 } else { // when the LSymb button is released
@@ -264,7 +312,7 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
264 312
265 case LSpec: 313 case LSpec:
266 if (record->event.pressed) { // when the LSpec button is pressed 314 if (record->event.pressed) { // when the LSpec button is pressed
267 if(symb_shift) symb_lock == !symb_lock; // if another layer button is engaged, then 315 if(symb_shift) symb_lock = !symb_lock; // if another layer button is engaged, then
268 else if(mdia_shift) mdia_lock = !mdia_lock; // lock that layer, be it caps or symb or mdia 316 else if(mdia_shift) mdia_lock = !mdia_lock; // lock that layer, be it caps or symb or mdia
269 else if (record->tap.count && !record->tap.interrupted && (!spec_shift)) { 317 else if (record->tap.count && !record->tap.interrupted && (!spec_shift)) {
270 register_code(KC_GRV); // otherwise, if it's an uninterrupted tap, emit a char 318 register_code(KC_GRV); // otherwise, if it's an uninterrupted tap, emit a char
@@ -340,6 +388,18 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
340 } 388 }
341 break; 389 break;
342 390
391 case NotEq:
392 if (record->event.pressed) {
393 return MACRO( I(30), T(EXLM), T(EQL), END ); //
394 }
395 break;
396
397 case Point:
398 if (record->event.pressed) {
399 return MACRO( I(30), T(MINS), T(DOT), END ); //
400 }
401 break;
402
343 // mouse diagonals 403 // mouse diagonals
344 404
345 case MUL: // mouse up left 405 case MUL: // mouse up left
diff --git a/keyboards/ergodox/keymaps/ordinary/readme.md b/keyboards/ergodox/keymaps/ordinary/readme.md
index 820b80b45..313b726ba 100644
--- a/keyboards/ergodox/keymaps/ordinary/readme.md
+++ b/keyboards/ergodox/keymaps/ordinary/readme.md
@@ -11,10 +11,11 @@ no rights reserved, use for any purposes, credit me if you are a nice person
11## The Base Layout ## 11## The Base Layout ##
12 12
13* *White Keys* are all the normal characters and symbols in all the normal locations (except for the brackets). 13* *White Keys* are all the normal characters and symbols in all the normal locations (except for the brackets).
14* *Modifier Keys* are light yellow and in the traditional location: Control, Option, Command, plus Hyper and Meh. 14* *Modifier Keys* are light yellow and in the traditional locationn at the bottom of the keyboard: Control, Option, Command, plus Hyper and Meh.
15* *Shift Keys* are dark yellow, found on the outsides of the keyboard. Capitals Shift (traditional shift) is found in the usual place and above that is found Symbol Shift, Media Shift, and Special Shift (Shift Lock). 15* *Shift Keys* are dark yellow, found on the outsides of the keyboard. Capitals Shift (traditional shift) is found in the usual place and above that is found Symbol Shift, Media Shift, and Special Shift (Shift Lock).
16* Several of the shift keys double for entry of characters which would typically be in those locations. 16* Several of the shift keys double for entry of characters which would typically be in those locations.
17* *Thumb Keys* shown in orange are for text navigation and manipulation. 17* *Thumb Keys* shown in orange are for text navigation and manipulation.
18* The keys under pinky fingers and index fingers will *reverse* the keyboard layout.
18* *Escape* is red and it is always found in that location no matter what. 19* *Escape* is red and it is always found in that location no matter what.
19 20
20![Ordinary base layout](ordinary-base.png) 21![Ordinary base layout](ordinary-base.png)
@@ -23,16 +24,20 @@ The four big orange keys are arranged differently than in the default Ergodox EZ
23 24
24The Forward Tab and Backward Tab keys are in their locations mostly because I ended up with two extra buttons and needed something to do with them. My muscle memory from using the Truly Ergonomic Keyboard makes me look for the Tab key with my right index finger, so it is handy to have this redundant Tab, and the idea with the Backward Tab key is that it becomes easy to navigate text fields in forms, or to indent/unindent code. 25The Forward Tab and Backward Tab keys are in their locations mostly because I ended up with two extra buttons and needed something to do with them. My muscle memory from using the Truly Ergonomic Keyboard makes me look for the Tab key with my right index finger, so it is handy to have this redundant Tab, and the idea with the Backward Tab key is that it becomes easy to navigate text fields in forms, or to indent/unindent code.
25 26
27#### Reversing The Base Layout ####
28
29The Ordinary Layout can be used to perform one-handed chorded text input. If you hold down the key under either index finger or either pinky finger (A, F, J and Semicolon), the whole base layout reverses order. Most keys are _mirrored_ but the delete keys are merely *translated* to preserve directionality. Pro-tip: This feature is particularly handly for bringing the Enter key to the left hand when the right hand is using the mouse.
30
26## The Symbols Layer ## 31## The Symbols Layer ##
27 32
28* *Symbols* shown in light green. All kinds of brackets are available on this layer. Ampersand and Pipe justapose each other. Pipe, slash, and backslash are arranged in a column. 33* *Symbols* shown in light green. All kinds of brackets are available on this layer. Ampersand and Pipe justapose each other. Pipe, slash, and backslash are arranged in a column.
29* *F-Keys* are bright green and overlay the row of numerals. 34* *F-Keys* are bright green and overlay the row of numerals. This layer has F1-F10, higher *F-Keys* are on the Symbols layer.
30* *Number pad* in dark green under the right hand includes all four arithmetic operations in the same order found on most number pads and features an Enter key. The keycodes emitted here are normal numeric keycodes, not the number-pad specific keycodes emitted by most number pads so that NumLock is not needed. 35* *Number pad* in dark green under the right hand includes all four arithmetic operations in the same order found on most number pads and features an Enter key. The keycodes emitted here are normal numeric keycodes, not the number-pad specific keycodes emitted by most number pads so that NumLock is not needed.
31* *Thumb keys* on this layer are the *reverse* of the orange keys on the base layer, with the keys either mirrored or shifted. This is powerful! Often I find myself using the mouse with my right hand, and the left hand needs to press Enter. Instead of reaching the left hand over to the right side of the keyboard, now I simply tap Symbols to reverse the turquoise keys, and Enter is right where it should be.
32 36
33![Ordinary symbol layout](ordinary-symbol.png) 37![Ordinary symbol layout](ordinary-symbol.png)
34 38
35The Symbols Layer is based on the Coder Layer from the default Ergodox EZ layout. I slightly rearranged the symbols, added some symbols, expanded the number pad, and straightened out the F-Keys. It's very handy to have the symbols directly underneath the normal typing keys. 39The Symbols Layer is based on the Coder Layer from the default Ergodox EZ layout. I slightly rearranged the symbols, added some symbols, expanded the number pad, and straightened out the F-Keys. It's very handy to have the symbols directly underneath the normal typing keys.
40* The dark gray keys do nothing in case you bump them by accident.
36 41
37## The Media Layer ## 42## The Media Layer ##
38 43
@@ -42,7 +47,7 @@ The Symbols Layer is based on the Coder Layer from the default Ergodox EZ layout
42* Higher-order *F-Keys* are shown in bright green overylaying the numerals. 47* Higher-order *F-Keys* are shown in bright green overylaying the numerals.
43* *Application Keys* to control web browsers and audio players are dark purple but don't get too excited because these have weak support on operating systems I've looked at. Good luck. 48* *Application Keys* to control web browsers and audio players are dark purple but don't get too excited because these have weak support on operating systems I've looked at. Good luck.
44* The light purple keys are various operating system keys such as NumLock and Mute and a button to navigate to My Computer (usually your home dir). 49* The light purple keys are various operating system keys such as NumLock and Mute and a button to navigate to My Computer (usually your home dir).
45* The dark gray keys do nothing in case you bump them by accident 50* The dark gray keys do nothing in case you bump them by accident.
46 51
47![Ordinary media layout](ordinary-media.png) 52![Ordinary media layout](ordinary-media.png)
48 53
@@ -64,27 +69,33 @@ Multiple layers can be turned on at once. The Capitals layer will affect charact
64 69
65The Special Shift layer is mostly used to lock the shift keys but in order to make this layout more _ordinary_ there are a few special sequences which put some keys near their most common traditional locations. 70The Special Shift layer is mostly used to lock the shift keys but in order to make this layout more _ordinary_ there are a few special sequences which put some keys near their most common traditional locations.
66 71
67### Escape ### 72#### Escape ####
68 73
69The One True Location for the Escape key is segregated way up on the top left of the keyboard. The Ergodox does not have a physical button in such a location and the nearest one is home to the tilde (er, grave) which is commonly found there. In the Ordinary layout the Escape key is found on all layers in the prominent location in the corner next to the 5, which is easy to remember, and yet it isn't natural for those of us with muscle memory flicking our wrists up and to the left looking for Escape. 74The One True Location for an Escape key is separated from the rest of the keys, way up on the top left of the keyboard. The Ergodox does not have a physical button in such a location, however, and the nearest one is home to the tilde (er, *grave*) which is commonly found there. In the Ordinary layout the Escape key is found on all layers in the prominent location in the corner next to the 5, which is easy to remember, and yet it isn't natural for those of us with muscle memory flicking our wrists up and to the left looking for Escape.
70 75
71The Ordinary layout offers as a consolation prize a Special sequence for Escape: Special Shift + 1. This is natural so you can tap the top left button, then the button next to it and get Escape. This gesture works in all layers. 76The Ordinary layout offers as a consolation prize, a Special sequence for Escape: **Special Shift + 1**. This is natural so you can tap the top left button, then the button next to it and get Escape. This gesture works in all layers.
72 77
73### Backspace ### 78#### Backspace ####
74 79
75At the top right corner of the Ergodox EZ you can a gesture similar to the special Escape sequence using the 0 key to produce a Backspace. Users of this keyboard and this layout are well advised to learn to use their thumbs for deleting text, but sometimes you are doing other computery things and just want to flick your digits up to the right and press backspace a bunch times. 80At the top right corner of the Ergodox EZ you can do **Special Shift + 0** to produce a Backspace. Users of this keyboard and this layout are well advised to learn to use their thumbs for deleting text, but sometimes you are doing other computery things and just want to flick your digits up to the right and press backspace a bunch times.
76 81
77### Other Characters ### 82#### Other Characters ####
78 83
79The Escape and Backspace special sequences are so useful why not have a few more? You can find dash under 9, left bracket under o, and right bracket under p. That's pretty much all the characters from the top right corner of the keyboard which moved to make room for the columnar layout. 84The Escape and Backspace special sequences are so useful why not have a few more? You can find dash under 9, left bracket under o, and right bracket under p. That's pretty much all the characters from the top right corner of the keyboard which moved to make room for the columnar layout.
80 85
86## Errata ##
87
88Some of the symbols on the Symbols layer are produced by the keyboard by "capitalizing" another symbol (such as *!* from *1*) so when you type that key you will notice the Capitals Shift red LED turn on.
89
81**** 90****
82 91
83The Ordinary Layout for the Ergodox EZ keyboard, v4.20 92The Ordinary Layout for the Ergodox EZ keyboard, v5
84 93
85Modifications from default by Nicholas Keene ergodoxez@nicholaskeene.com 94Modifications from default by Nicholas Keene ergodoxez@nicholaskeene.com
86 95
87No rights reserved. This software is in the public domain. Credit me if you are friendly but if you're a jerk don't bother. 96No rights reserved. This software is in the public domain. Credit me if you are friendly but if you're a jerk don't bother.
88 97
98Keyboard layout images were created with http://www.keyboard-layout-editor.com/ by Ian Prest my thanks to that free service
99
89Details: readme.md 100Details: readme.md
90 https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary 101 https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary