keyboards/planck/keymaps/ajp10304/readme.md

   1 # AJP10304 Custom Planck Layout
   2 # Also available for the Atreus50 and JJ40
   3
   4 **Note:** In the tables below where there are two characters on a key,
   5 the second is the output when shift is applied.
   6
   7 **Note:** The below tables assume a UK layout.
   8
   9 ####Flashing
  10 Rev <=5: sudo make planck:ajp10304:dfu
  11 Rev 6: sudo make planck/rev6:ajp10304:dfu-util
  12
  13 ##### Main Qwerty Layer
  14
  15 * Tab: when held, operates as shift.
  16 * Enter: when held, operates as shift.
  17 * MENU: perform right-click
  18
  19 |      |      |      |      |      |      |      |      |      |      |      |      |
  20 | ---- |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| ----:|
  21 | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  22 | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |  ;:  | Enter|
  23 | Shft |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |  ,<  |  .>  |  /?  | Shft |
  24 | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Raise | Shift| MENU | Ctrl | Fn2  |
  25
  26 ##### Function Layer
  27 Activated when `fn` held in the above `qwerty` layer.
  28
  29 |       |      |      |      |      |      |      |      |      |      |      |      |
  30 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  31 |  F1   |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
  32 |  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  |  ~   |INSERT|
  33 | Shift |  \|  |  `¬  |  #~  |   *  |  -_  |  =+  |  \|  |  [{  |  ]}  |  '@  |Shift |
  34 | Fn    | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Mouse | MENU | Alt  | Ctrl | Fn2  |
  35
  36 ##### Lower Layer
  37 Activated when `Lower` is held in the above `qwerty` layer.
  38
  39 * Numbers are along the top row, their shifted counterparts are on row 2.
  40 * WrdBks: `backspace` with `ctrl` applied. I.e. delete a word.
  41 * WrdDel: `delete` with `ctrl` applied. I.e. forward delete a word.
  42
  43 |       |      |      |      |      |      |      |      |      |      |      |      |
  44 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  45 |  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  | DEL  | Bksp |
  46 |  !    |   "  |   £  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |WrdDel|WrdBks|
  47 | Shift |  \|  |  `¬  |  #~  |  '@  |  -_  |  =+  |  #~  |  [{  |  ]}  |  '@  |Shift |
  48 |       |      |      |      |Lower | Del  |Space |      | Next | Vol- | Vol+ | Play |
  49
  50  ##### Raise Layer
  51  Activated when `Raise` is held in the above `qwerty` layer.
  52
  53  * Preferred layer for typing brackets.
  54  * Allows for cursor navigation to be used solely with the right hand.
  55  * WRDSEL: Select the word where the cursor is.
  56  * |< and >|: Apply `ctrl` to `left` and `right` respectively for word jumping.
  57
  58 |       |      |      |      |      |      |       |      |      |      |       |      |
  59 | :---: |:----:| :---:| :---:| :---:| :---:| :---: | :---:| :---:| :---:| :---: | :---:|
  60 |   `   |      |WRDSEL|  [   |   ]  |      |       | PGUP | HOME |PGDOWN|       |PRNTSC|
  61 |   `   |      |      |  (   |   )  |      |       | HOME |  UP  | END  |       |ZOOM +|
  62 |       |      |      |  {   |   }  |      |&#124;<| LEFT | DOWN |RIGHT |>&#124;|ZOOM -|
  63 | Mouse |      |      |      |      |  Alt | Enter |Raise |      |      |       |      |
  64
  65 ##### Lower + Raise
  66 Activated when `Lower` and `Raise` are held together in the above `qwerty` layer.
  67
  68 * Audio controls in the same position as cursor keys from the `Raise` layer.
  69 * ????: Runs a macro for outputting a text string.  Do not use this store passwords.
  70 * Reset: Enter bootloader for flashing firmware to the keyboard.
  71 * CAPS: Toggle caps lock.
  72 * Macro functions: Allows recording of macros.  To start recording the macro, press either REC1 or REC2.
  73 To finish the recording, press STOP. To replay the macro, press either PLAY1 or PLAY2.
  74 * MAC: Toggle MAC OS extensions to layers. This allows MLWR to be enabled with LOWER,
  75 MRSE with RAISE, MFNC with FUNC and MFNC2 with FUNC2 respectively.
  76
  77 |       |      |      |      |      |      |      |      |      |      |      |      |
  78 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  79 | ????  | Reset|Qwerty|      |      | REC1 | REC2 |      |      |      |      |  Del |
  80 | CAPS  |      |      |      |      | PLAY1|PLAY2 | Mute | Vol+ | Play |      |      |
  81 | MAC   |      |      |      |      | STOP1|STOP2 | Prev | Vol- | Next |      |      |
  82 |       |      |      |      |      |      |      |      | DYN  |      |      |      |
  83
  84 ##### Function 2 Layer
  85 Activated when `fn` held in the above `qwerty` layer.
  86 * WRDSEL: Select the word where the cursor is.
  87 * LNDEL: Delete the line where the cursor is.
  88 * LNSEL: Select the line where the cursor is.
  89 * DUP: Duplicate the selected text.
  90 * LNJOIN: Join the line where the cursor is with the following line.
  91 * MODE: Print either `PC` or `OSX` depending on what layer mode is active.
  92
  93 |       |      |      |      |      |      |      |      |      |      |      |      |
  94 | :---: | :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  95 |       |      |WRDSEL|      |      |      | LNDEL|      |      |      |      |      |
  96 |       |      | LNSEL| DUP  |      |      |      |      |LNJOIN|      |      |      |
  97 |       | UNDO | CUT  | COPY | PASTE|      |      |      |      |      |      | MODE |
  98 |       |      |      |      |      |      |      |      |      |      |      |      |
  99
 100 ##### Mouse Layer
 101 Activated when `fn` and `raise` held together.
 102
 103 |       |      |      |      |      |      |      |      |      |      |      |      |
 104 | :---: | :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
 105 | ESC   |      |      |      |      |      |      |      |      |      |      |      |
 106 | ACC0  | ACC1 | ACC2 |      |      |      |      | BTN1 |  UP  | BTN2 |      |      |
 107 | ACC0  | ACC1 | ACC2 |      |      |      |      | LEFT | DOWN | RIGHT|      |      |
 108 |       |      |      |      |      |      |      |      |      |      |      |      |