users/edvorakjp/readme.md

   1 # edvorakjp
   2
   3 epaew's Enhanced Dvorak layout for Japanese Programmer
   4
   5 ## Layout overview
   6 This is a sample. You can swap any symbol keys and modifier keys.
   7
   8 - Base layer (for ansi layout)
   9 ```
  10   //+----+----+----+----+----+----+----+----+----+----+----+----+----+---------+
  11       `  , !  , @  , #  , $  , %  , ^  , &  , *  , (  , )  , [  , ]  ,  BSPC   ,
  12   //+----+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+-------+
  13       TAB  , '  , ,  , .  , Y  , P  , F  , G  , R  , W  , Q  , /  , =  ,   \   ,
  14   //+------++---++---++---++---++---++---++---++---++---++---++---++---+-------+
  15       CAPS  , A  , O  , E  , I  , U  , D  , T  , N  , S  , M  , -  ,    ENT    ,
  16   //+-------+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-----------+
  17        LSFT   , ;  , X  , C  , V  , Z  , B  , H  , J  , K  , L  ,     RSFT     ,
  18   //+------+--+---++----++---+----+----+----+----+-+--+---++----++------+------+
  19       LCTL , LGUI , LALT ,          SPACE          , RALT , RGUI , MENU , RCTL
  20   //+------+------+------+-------------------------+------+------+------+------+
  21 ```
  22 - Base layer (for iso layout)
  23   - Two C keys are placed, it's on purpose.
  24 ```
  25   //+----+----+----+----+----+----+----+----+----+----+----+----+----+---------+
  26       `  , !  , @  , #  , $  , %  , ^  , &  , *  , (  , )  , [  , ]  ,  BSPC   ,
  27   //+----+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+-------+
  28       TAB  , '  , ,  , .  , Y  , P  , F  , G  , R  , W  , C  , /  , =  ,
  29   //+------++---++---++---++---++---++---++---++---++---++---++---++---++
  30       CAPS  , A  , O  , E  , I  , U  , D  , T  , N  , S  , M  , ;  , -  , ENT  ,
  31   //+-------+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+------+
  32        LSFT   , Q  , X  , C  , V  , Z  , B  , H  , J  , K  , L  , \  ,  RSFT   ,
  33   //+------+--+---++----++---+----+----+----+----+-+--+---++----++---+--+------+
  34       LCTL , LGUI , LALT ,          SPACE          , RALT , RGUI , MENU , RCTL
  35   //+------+------+------+-------------------------+------+------+------+------+
  36 ```
  37 - Additional layer (common, blanks are transparent)
  38 ```
  39   //+----+----+----+----+----+----+----+----+----+----+----+----+----+---------+
  40          ,    ,    ,    ,    ,    ,    ,    ,    ,    ,    ,    ,    ,         ,
  41   //+----+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+-------+
  42            , AI , OU , EI ,    ,    ,    ,    ,    ,    ,    ,    ,    ,       ,
  43   //+------++---++---++---++---++---++---++---++---++---++---++---++---+-------+
  44             , A  , O  , E  , I  , U  ,    , Y1 , N  , Y2 ,    ,    ,           ,
  45   //+-------+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-----------+
  46               ,ANN ,ONN ,ENN ,INN ,UNN ,    ,    ,    ,    ,    ,              ,
  47   //+------+--+---++----++---+----+----+----+----+-+--+---++----++------+------+
  48            ,      ,      ,                         ,      ,      ,      ,
  49   //+------+------+------+-------------------------+------+------+------+------+
  50 ```
  51
  52  And you can see [my iris keyboard layout](../../keyboards/iris/keymaps/edvorakjp/keymap.c) for sample implementation, too.
  53
  54 ## for Japanese
  55
  56 - 日本語入力用のキーを追加
  57   - IME 切り替えキー
  58     - 長押しでレイヤー切り替え、短押しでIME切り替え
  59     - macOS(かな/英数)、Windows(Alt+\`)の両方に対応
  60   - DvorakJP(<http://www7.plala.or.jp/dvorakjp/>)を参考にした日本語入力用キーの導入
  61     - 拗音入力用のYキーを追加配置
  62     - 二重母音入力用のキー(AI, OU, EI)
  63     - 撥音入力用のキー(ANN, ONN, ENN, INN, UNN)
  64     - いずれかの子音を押下することで Additional layer が出現し、いずれかの母音を押下することで Base layer に戻ります（※1※2）
  65       - ※1促音の入力に使うため、また連続で同じ指での打鍵を減らすために、
  66         FGRDTNBHJ を押下した場合はy1が、それ以外の子音を押下した場合はy2が出現しません
  67       - ※2撥音の入力のため、nを2連打すると、Base layerに戻ります
  68 - Define some custom keys for typing Japanese
  69   - IME switching
  70     - act as LOWER/RAISE when hold, act as IME switching when tapped
  71     - for macOS(かな/英数), for Windows(Alt+\`)
  72   - oneshot combination keys, inspired from DvorakJP (<http://www7.plala.or.jp/dvorakjp/>)
  73     - additional Y key to enter a contracted sound
  74     - diphthong keys (AI, OU, EI)
  75     - syllabic nasal (ANN, ONN, ENN, INN, UNN)
  76     - Additional layer is appeared when you taps any consonant keys, and disappeared when you taps any diphthong keys.
  77
  78 ## for Programmer
  79
  80 - Dvorak 配列をベースに、ショートカットでよく利用される XCV は QWERTY 配列の位置を維持
  81 - 一部にVimユーザ用のキー配置を実施
  82     - HJKL キーを横並びで配置
  83     - Shift押下時と非押下時で、";"キーの挙動を入れ替え（`config.h` 内で `#define SWAP_SCLN` の宣言が必要です）
  84 - デフォルトレイヤーには、数字キーの代わりに記号 `!@#$%^&*()` を配置
  85
  86 - mainly based on Dvorak layout, but XCV is available in the same position of QWERTY layout
  87 - for Vim users
  88     - HJKL is lining side by side
  89     - swap the ";" key behavior. i.e. send ":" normally and send ";" when you hold shift. (need `#define SWAP_SCLN` in your `config.h`)
  90 - we can type `!@#$%^&*()` keys without shift keys in base layer
  91
  92 ## License
  93
  94 Copyright 2018 Ryo Maeda epaew.333@gmail.com @epaew
  95
  96 This program is free software: you can redistribute it and/or modify
  97 it under the terms of the GNU General Public License as published by
  98 the Free Software Foundation, either version 2 of the License, or
  99 (at your option) any later version.
 100
 101 This program is distributed in the hope that it will be useful,
 102 but WITHOUT ANY WARRANTY; without even the implied warranty of
 103 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 104 GNU General Public License for more details.
 105
 106 You should have received a copy of the GNU General Public License
 107 along with this program.  If not, see <http://www.gnu.org/licenses/>.