]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/ajp10304/readme.md
Added ajp10304 Planck layout (#1887)
[qmk_firmware.git] / keyboards / planck / keymaps / ajp10304 / readme.md
1 # AJP10304 Custom Planck Layout
2
3 **Note:** In the tables below where there are two characters on a key, 
4 the second is the output when shift is applied.
5   
6 **Note:** The below tables assume a UK layout.
7
8 ##### Main Qwerty Layer 
9
10 * Tab: when held, operates as shift.
11 * Enter: when held, operates as shift.
12 * MENU: perform right-click
13
14 |      |      |      |      |      |      |      |      |      |      |      |      |
15 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
16 | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
17 | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |  ;:  | Enter|
18 | Shft |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |  ,<  |  .>  |  /?  | Shft |
19 | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Raise | Shift| MENU | Ctrl | Fn   |
20
21 ##### Function Layer
22 Activated when `fn` held in the above `qwerty` layer.
23
24 |      |      |      |      |      |      |      |      |      |      |      |      |
25 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
26 |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
27 |  1!  |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  |  ~   |INSERT|
28 | Shift|  \|  |  `¬  |  #~  |   *  |  -_  |  =+  |  \|  |  [{  |  ]}  |  '@  |Shift |
29 | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Raise | MENU | Alt  | Ctrl | Fn   |
30
31 ##### Lower Layer
32 Activated when `Lower` is held in the above `qwerty` layer.
33
34 * Numbers are along the top row, their shifted counterparts are on row 2.
35 * WrdBks: `backspace` with `ctrl` applied. I.e. delete a word.  
36 * WrdDel: `delete` with `ctrl` applied. I.e. forward delete a word.
37
38 |      |      |      |      |      |      |      |      |      |      |      |      |
39 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
40 |  1!  |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  | DEL  | Bksp |
41 |  !   |   "  |   £  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |WrdDel|WrdBks|
42 | Shift|  \|  |  `¬  |  #~  |  '@  |  -_  |  =+  |  #~  |  [{  |  ]}  |  '@  |Shift |
43 |      |      |      |      |Lower | Del  |Space |      | Next | Vol- | Vol+ | Play |
44  
45  ##### Raise Layer
46  Activated when `Raise` is held in the above `qwerty` layer.
47  
48  * Preferred layer for typing brackets.
49  * Allows for cursor navigation to be used solely with the right hand.
50  * WRDSEL: Select the word where the cursor is.
51  * |< and >|: Apply `ctrl` to `left` and `right` respectively for word 
52
53 |      |      |      |      |      |      |      |      |      |      |      |      |      
54 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----: 
55 |   `  |      |WRDSEL|  [   |   ]  |      |      | PGUP | HOME |PGDOWN|      |PRNTSC|
56 |   `  |      |      |  (   |   )  |      |      | HOME |  UP  | END  |      |ZOOM +|
57 |      |      |      |  {   |   }  |      |  |<  | LEFT | DOWN |RIGHT |  >|  |ZOOM -|
58 |      |      |      |      |      |  Alt | Enter|Raise |      |      |      |      |     
59  
60 ##### Lower + Raise
61 Activated when `Lower` and `Raise` are held together the above `qwerty` layer.
62
63 * Audio controls in the same position as cursor keys from the `Raise` layer.  
64 * ????: Runs a macro for outputting sensitive information.  Do not use this store passwords.
65 * Reset: Enter bootloader for flashing firmware to the keyboard.
66 * CAPS: Toggle caps lock.
67 * DYN: Enter `DYN` layer.
68
69 |      |      |      |      |      |      |      |      |      |      |      |      |      
70 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----: 
71 | ???? | Reset|Qwerty|      |      |      |      |      |      |      |      |  Del |
72 | CAPS |      |      |      |      |      |      | Mute | Vol+ | Play |      |      |
73 |      |      |      |      |      |      |      | Prev | Vol- | Next |      |      |
74 |      |      |      |      |      |             |      | DYN  |      |      |      |
75  
76 ##### DYN
77 Activated when `DYN` held along with `Lower` and `Raise`
78 Allows recording of macros.  To start recording the macro, press either REC1 or REC2. 
79 To finish the recording, press STOP. To replay the macro, press either PLAY1 or PLAY2.  
80
81 |      |      |      |      |      |      |      |      |      |      |      |      |      
82 | ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----: 
83 |      |      |      |      |      | REC1 | REC2 |      |      |      |      |      |
84 |      |      |      |      |      | PLAY1| PLAY2|      |      |      |      |      |
85 |      |      |      |      |      | STOP | STOP |      |      |      |      |      |
86 |      |      |      |      |      |             |      |      |      |      |      |