[Docs] Update Japanese translation of feature_tap_dance.md. (#9808)

* Update Japanese translation of feature_tap_dance.md. * fix original document version. * Update docs/ja/feature_tap_dance.md
2020-07-31 14:31:34 +09:00 · 2020-07-31 14:31:34 +09:00 · 3c7fc3c82e
commit 3c7fc3c82e
parent 2ec2f80bfc
1 changed files with 246 additions and 268 deletions
--- a/docs/ja/feature_tap_dance.md
+++ b/docs/ja/feature_tap_dance.md
@ -1,39 +1,28 @@
 # タップダンス: 1つのキーが3つ、5つまたは100の異なる動作をします
 <!---
-  original document: 0.9.0:docs/feature_tap_dance.md
+  original document: 0.9.44:docs/feature_tap_dance.md
-  git diff 0.9.0 HEAD -- docs/feature_tap_dance.md | cat
+  git diff 0.9.44 HEAD -- docs/feature_tap_dance.md | cat
 --> 
-## イントロダクション
+## イントロダクション :id=introduction
 セミコロンキーを1回叩くと、セミコロンが送信されます。2回素早く叩くと、コロンが送信されます。3回叩くと、あなたのキーボードのLEDが激しく踊るように明滅します。これは、タップダンスでできることの一例です。それは、コミュニティが提案したとても素敵なファームウェアの機能の1つで、[algernon](https://github.com/algernon) がプルリクエスト [#451](https://github.com/qmk/qmk_firmware/pull/451) で考えて作ったものです。algernon が述べる機能は次の通りです:
 この機能を使うと、特定のキーが、タップした回数に基づいて異なる振る舞いをします。そして、割り込みがあった時は、割り込み前に上手く処理されます。
-## `ACTION_FUNCTION_TAP` との比較について
+## タップダンスの使い方 :id=how-to-use
 `ACTION_FUNCTION_TAP` はタップダンスに似た機能を提供しますが、注目すべきいくつかの重要な違いがあります。違いを確認するため、いくつかの設定を調べてみましょう。1つのキーを1回タップすると `Space` キーが送信され、2回タップすると `Enter` キーが送信されるよう設定します。
 `ACTION_FUNCTION_TAP` では、これを設定するのはかなり大変で、キーの順番が割り込まれた時に割り込んだキーが最初に送られるという問題に直面します。例えば、`SPC a` は、もし `SPC` と `a` が `TAPPING_TERM` で設定した時間内に両方とも入力された場合、結果として `a SPC` が送信されます。タップダンス機能を使う場合、正しく `SPC a` が送信されます（`TAPPING_TERM` で設定した時間内に `SPC` と `a` を入力した場合であっても）。
 割り込みを正しくハンドリングして目的を達成するため、タップダンスの実装ではシステムの2つの部分をフックします: `process_record_quantum()` とマトリックススキャンです。この2つの部分については以下で説明しますが、今注意すべき点は、マトリックススキャンでは、キーが押されていない時でもタップのシーケンスをタイムアウトにできる必要があるということです。そうすれば、`TAPPING_TERM` の時間が経過した後、`SPC` だけがタイムアウトになって登録されます。
 ## タップダンスの使い方
 一般論は十分です。タップダンスの実際の使い方を見てみましょう！
 最初に、あなたの `rules.mk` ファイルで `TAP_DANCE_ENABLE = yes` と設定する必要があります。なぜならば、デフォルトでは無効になっているからです。これでファームウェアのサイズが1キロバイトほど増加します。
 オプションで、あなたの `config.h` ファイルに次のような設定を追加して、`TAPPING_TERM` の時間をカスタマイズしたほうが良いです。
-```
+```c
 #define TAPPING_TERM 175
 ```
 `TAPPING_TERM` の時間は、あなたのタップダンスのキーのタップとタップの間の時間として許可された最大の時間で、ミリ秒単位で計測されます。例えば、もし、あなたがこの上にある `#define` ステートメントを使い、1回タップすると `Space` が送信され、2回タップすると `Enter` が送信されるタップダンスキーをセットアップした場合、175ミリ秒以内に2回キーをタップすれば `ENT` だけが送信されるでしょう。もし、1回タップしてから175ミリ秒以上待ってからもう一度タップすると、`SPC SPC` が送信されます。
-次に、いくつかのタップダンスのキーを定義するためには、`TD()` マクロ — `F()` マクロに似ています — を使うのが最も簡単です。これは数字を受け取り、この数字は後で `tap_dance-actions` 配列のインデックスとして使われます。
+次に、いくつかのタップダンスのキーを定義するためには、`TD()` マクロを使うのが最も簡単です。これは数字を受け取り、この数字は後で `tap_dance-actions` 配列のインデックスとして使われます。
 その後、`tap_dance_actions` 配列を使って、タップダンスキーを押した時のアクションを定義します。現在は、5つの可能なオプションがあります:
@ -56,7 +45,7 @@
 最後に、5番目のオプションは、もし、タップダンスキーをコードに追加した後、非タップダンスキーが奇妙な振る舞いを始めた時に特に役に立ちます。ありうる問題は、あなたがタップダンスキーを使いやすくするために `TAPPING_TERM` の時間を変更した結果、その他のキーが割り込みを処理する方法が変わってしまったというものです。
-## 実装の詳細
+## 実装の詳細 :id=implementation
 さて、説明の大部分はここまでです！ 以下に挙げているいくつかの例に取り組むことができるようになり、あなた自身のタップダンスの機能を開発できるようになります。しかし、もし、あなたが裏側で起きていることをより深く理解したいのであれば、続けてそれが全てどのように機能するかの説明を読みましょう！
@ -72,9 +61,9 @@
 柔軟性のために、タップダンスは、キーコードの組み合わせにも、ユーザー関数にもなることができます。後者は、より高度なタップ回数の制御や、LED を点滅させたり、バックライトをいじったり、等々の制御を可能にします。これは、1つの共用体と、いくつかの賢いマクロによって成し遂げられています。
-# 実装例
+## 実装例 :id=examples
-## シンプルな実装例
+### シンプルな実装例 :id=simple-example
 ここに1つの定義のための簡単な例があります。
@ -85,21 +74,24 @@
 ```c
 // タップダンスの宣言
 enum {
-  TD_ESC_CAPS = 0
+    TD_ESC_CAPS,
 };
 // タップダンスの定義
 qk_tap_dance_action_t tap_dance_actions[] = {
    // 1回タップすると Escape キー、2回タップすると Caps Lock。
-  [TD_ESC_CAPS]  = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS)
+    [TD_ESC_CAPS]  = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),
 // ほかの宣言もカンマで区切ってここに記述します
 };
-// レイヤー定義で、キーコードの代わりにタップダンスキーを追加します
+// キーコードの代わりにタップダンスキーを追加します
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    // ...
    TD(TD_ESC_CAPS)
    // ...
 };
 ```
-## 複雑な実装例
+### 複雑な実装例 :id=complex-examples
 このセクションでは、いくつかの複雑なタップダンスの例を詳しく説明します。
 例で使われている全ての列挙型はこのように宣言します。
@ -107,20 +99,19 @@ TD(TD_ESC_CAPS)
 ```c
 // 全ての例のための列挙型定義
 enum {
- CT_SE = 0,
+    CT_SE,
    CT_CLN,
    CT_EGG,
    CT_FLSH,
    X_TAP_DANCE
 };
 ```
-### 例1: 1回タップすると `:` を送信し、2回タップすると `;` を送信する
+#### 例1: 1回タップすると `:` を送信し、2回タップすると `;` を送信する :id=example-1
 ```c
 void dance_cln_finished(qk_tap_dance_state_t *state, void *user_data) {
    if (state->count == 1) {
-    register_code (KC_RSFT);
+        register_code16(KC_COLN);
    register_code (KC_SCLN);
    } else {
        register_code(KC_SCLN);
    }
@ -128,8 +119,7 @@ void dance_cln_finished (qk_tap_dance_state_t *state, void *user_data) {
 void dance_cln_reset(qk_tap_dance_state_t *state, void *user_data) {
    if (state->count == 1) {
-    unregister_code (KC_RSFT);
+        unregister_code16(KC_COLN);
    unregister_code (KC_SCLN);
    } else {
        unregister_code(KC_SCLN);
    }
@ -137,11 +127,11 @@ void dance_cln_reset (qk_tap_dance_state_t *state, void *user_data) {
 // 全てのタップダンス関数はここに定義します。ここでは1つだけ示します。
 qk_tap_dance_action_t tap_dance_actions[] = {
- [CT_CLN] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_cln_finished, dance_cln_reset)
+    [CT_CLN] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, dance_cln_finished, dance_cln_reset),
 };
 ```
-### 例2: 100回タップした後に "Safety Dance!" を送信します
+#### 例2: 100回タップした後に "Safety Dance!" を送信します :id=example-2
 ```c
 void dance_egg(qk_tap_dance_state_t *state, void *user_data) {
@ -152,11 +142,11 @@ void dance_egg (qk_tap_dance_state_t *state, void *user_data) {
 }
 qk_tap_dance_action_t tap_dance_actions[] = {
- [CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
+    [CT_EGG] = ACTION_TAP_DANCE_FN(dance_egg),
 };
 ```
-### 例3: 1つずつ LED を点灯させてから消灯する
+#### 例3: 1つずつ LED を点灯させてから消灯する :id=example-3
 ```c
 // タップする毎に、LED を右から左に点灯します。
@ -174,9 +164,9 @@ void dance_flsh_each(qk_tap_dance_state_t *state, void *user_data) {
            break;
        case 4:
            ergodox_right_led_3_off();
-    _delay_ms(50);
+            wait_ms(50);
            ergodox_right_led_2_off();
-    _delay_ms(50);
+            wait_ms(50);
            ergodox_right_led_1_off();
    }
 }
@ -185,29 +175,28 @@ void dance_flsh_each(qk_tap_dance_state_t *state, void *user_data) {
 void dance_flsh_finished(qk_tap_dance_state_t *state, void *user_data) {
    if (state->count >= 4) {
        reset_keyboard();
    reset_tap_dance(state);
    }
 }
 // もしフラッシュ状態にならない場合、LED を左から右に消灯します。
 void dance_flsh_reset(qk_tap_dance_state_t *state, void *user_data) {
    ergodox_right_led_1_off();
-  _delay_ms(50);
+    wait_ms(50);
    ergodox_right_led_2_off();
-  _delay_ms(50);
+    wait_ms(50);
    ergodox_right_led_3_off();
 }
 // 全てのタップダンス関数を一緒に表示しています。この例3は "CT_FLASH" です。
 qk_tap_dance_action_t tap_dance_actions[] = {
-  [CT_SE]  = ACTION_TAP_DANCE_DOUBLE (KC_SPC, KC_ENT)
+    [CT_SE] = ACTION_TAP_DANCE_DOUBLE(KC_SPC, KC_ENT),
- ,[CT_CLN] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_cln_finished, dance_cln_reset)
+    [CT_CLN] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, dance_cln_finished, dance_cln_reset),
- ,[CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
+    [CT_EGG] = ACTION_TAP_DANCE_FN(dance_egg),
- ,[CT_FLSH] = ACTION_TAP_DANCE_FN_ADVANCED (dance_flsh_each, dance_flsh_finished, dance_flsh_reset)
+    [CT_FLSH] = ACTION_TAP_DANCE_FN_ADVANCED(dance_flsh_each, dance_flsh_finished, dance_flsh_reset)
 };
 ```
-### 例4: クアッドファンクションのタップダンス
+#### 例4: クアッドファンクションのタップダンス :id=example-4
 [DanielGGordon](https://github.com/danielggordon) によるもの
@ -219,8 +208,6 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 *  2回タップ = `Escape` を送信
 *  2回タップして押し続ける = `Alt` を送信
 ## 準備
 'クアッドファンクションのタップダンス' を利用できるようにするには、いくつかのものが必要になります。
 `keymap.c` ファイルの先頭、つまりキーマップの前に、以下のコードを追加します。
@ -228,31 +215,30 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 ```c
 typedef struct {
    bool is_press_action;
-  int state;
+    uint8_t state;
 } tap;
 enum {
    SINGLE_TAP = 1,
-  SINGLE_HOLD = 2,
+    SINGLE_HOLD,
-  DOUBLE_TAP = 3,
+    DOUBLE_TAP,
-  DOUBLE_HOLD = 4,
+    DOUBLE_HOLD,
-  DOUBLE_SINGLE_TAP = 5, //シングルタップを2回送信
+    DOUBLE_SINGLE_TAP, // シングルタップを2回送信
-  TRIPLE_TAP = 6,
+    TRIPLE_TAP,
-  TRIPLE_HOLD = 7
+    TRIPLE_HOLD
 };
 // タップダンスの列挙型
 enum {
-  X_CTL = 0,
+    X_CTL,
    SOME_OTHER_DANCE
 };
-int cur_dance (qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 // xタップダンスのための関数。キーマップで利用できるようにするため、ここに置きます。
 void x_finished(qk_tap_dance_state_t *state, void *user_data);
 void x_reset(qk_tap_dance_state_t *state, void *user_data);
 ```
 次に、`keymap.c` ファイルの末尾に、次のコードを追加する必要があります。
@ -288,35 +274,31 @@ void x_reset (qk_tap_dance_state_t *state, void *user_data);
 * 3つ目の点については、'DOUBLE_SINGLE_TAP' が存在しますが、これは完全にはテストされていません
 *
 */
-int cur_dance (qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
    if (state->count == 1) {
        if (state->interrupted || !state->pressed) return SINGLE_TAP;
        // キーは割り込まれていませんが、まだ押し続けられています。'HOLD' を送信することを意味します。
        else return SINGLE_HOLD;
-  }
+    } else if (state->count == 2) {
-  else if (state->count == 2) {
+        // DOUBLE_SINGLE_TAP は "pepper" と入力することと、'pp' と入力したときに実際に
-    /*
+        // ダブルタップしたい場合とを区別するためのものです。
-     * DOUBLE_SINGLE_TAP は "pepper" と入力することと、'pp' と入力したときに実際に
+        // この戻り値の推奨されるユースケースは、'ダブルタップ' 動作やマクロではなく、
-     * ダブルタップしたい場合とを区別するためのものです。
+        // そのキーの2つのキー入力を送信したい場合です。
     * この戻り値の推奨されるユースケースは、'ダブルタップ' 動作やマクロではなく、
     * そのキーの2つのキー入力を送信したい場合です。
    */
        if (state->interrupted) return DOUBLE_SINGLE_TAP;
        else if (state->pressed) return DOUBLE_HOLD;
        else return DOUBLE_TAP;
    }
    // 誰も同じ文字を3回入力しようとしていないと仮定します(少なくとも高速には)。
    // タップダンスキーが 'KC_W' で、"www." と高速に入力したい場合、ここに例外を追加して
-  //'TRIPLE_SINGLE_TAP' を返し、'DOUBLE_SINGLE_TAP' のようにその列挙型を定義する
+    // 'TRIPLE_SINGLE_TAP' を返し、'DOUBLE_SINGLE_TAP' のようにその列挙型を定義する必要があります。
  //必要があります。
    if (state->count == 3) {
        if (state->interrupted || !state->pressed) return TRIPLE_TAP;
        else return TRIPLE_HOLD;
-  }
+    } else return 8; // マジックナンバー。いつかこのメソッドはより多くの押下に対して機能するよう拡張されるでしょう
  else return 8; //マジックナンバー。いつかこのメソッドはより多くの押下に対して機能するよう拡張されるでしょう
 }
-//'x' タップダンスの 'tap' のインスタンスをインスタンス化します
+//'x' タップダンスの 'tap' のインスタンスを生成します。
 static tap xtap_state = {
    .is_press_action = true,
    .state = 0
@ -329,11 +311,11 @@ void x_finished (qk_tap_dance_state_t *state, void *user_data) {
        case SINGLE_HOLD: register_code(KC_LCTRL); break;
        case DOUBLE_TAP: register_code(KC_ESC); break;
        case DOUBLE_HOLD: register_code(KC_LALT); break;
    case DOUBLE_SINGLE_TAP: register_code(KC_X); unregister_code(KC_X); register_code(KC_X);
        // 最後の case は高速入力用です。キーが `f` であると仮定します:
        // 例えば、`buffer` という単語を入力するとき、`Esc` ではなく `ff` を送信するようにします。
        // 高速入力時に `ff` と入力するには、次の文字は `TAPPING_TERM` 以内に入力する必要があります。
        // `TAPPING_TERM` はデフォルトでは 200ms です。
        case DOUBLE_SINGLE_TAP: tap_code(KC_X); register_code(KC_X);
    }
 }
@ -359,7 +341,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 > この設定の "hold" は、タップダンスのタイムアウト（`ACTION_TAP_DANCE_FN_ADVANCED_TIME` 参照）の **後** に起こります。即座に "hold" を得るためには、条件から `state->interrupted` の確認を除きます。結果として、複数回のタップのための時間をより多く持つことで快適な長いタップの期限を使うことができ、そして、"hold" のために長く待たないようにすることができます(2倍の `TAPPING TERM` で開始してみてください)。
-### 例5: タップダンスを高度なモッドタップとレイヤータップキーに使う :id=example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys
+#### 例5: タップダンスを高度なモッドタップとレイヤータップキーに使う :id=example-5
 タップダンスは、タップされたコードが基本的なキーコード以外の場合に、 `MT()` と `LT()` マクロをエミュレートするのに利用できます。これは、通常 `Shift` を必要とする '(' や '{' のようなキーや、`Control + X` のように他の修飾されたキーコードをタップされたキーコードとして送信することに役立ちます。
@ -384,7 +366,7 @@ static td_state_t td_state;
 // タップダンス関数を宣言します:
 // 現在のタップダンスの状態を特定するための関数
-int cur_dance (qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 // それぞれのタップダンスキーコードに適用する `finished` と `reset` 関数
 void altlp_finished(qk_tap_dance_state_t *state, void *user_data);
@ -395,13 +377,14 @@ void altlp_reset (qk_tap_dance_state_t *state, void *user_data);
 ```c
 // 返却するタップダンス状態を特定します
-int cur_dance (qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
    if (state->count == 1) {
-    if (state->interrupted || !state->pressed) { return SINGLE_TAP; }
+        if (state->interrupted || !state->pressed) return SINGLE_TAP;
-    else { return SINGLE_HOLD; }
+        else return SINGLE_HOLD;
    }
-  if (state->count == 2) { return DOUBLE_SINGLE_TAP; }
+
-  else { return 3; } // 上記で返却する最大の状態の値より大きい任意の数
+    if (state->count == 2) return DOUBLE_SINGLE_TAP;
    else return 3; // 上記で返却する最大の状態の値より大きい任意の数
 }
 // 定義する各タップダンスキーコードのとりうる状態を制御します:
@ -442,7 +425,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 それぞれのタップダンスキーコードをキーマップに含めるときは、`TD()` マクロでキーコードをラップします。例: `TD(ALT_LP)`
-### 例6: タップダンスを一時的なレイヤー切り替えとレイヤートグルキーに使う
+#### 例6: タップダンスを一時的なレイヤー切り替えとレイヤートグルキーに使う :id=example-6
 タップダンスは、MO(layer) と TG(layer) 機能を模倣することにも使用できます。この例では、1回タップすると `KC_QUOT` 、1回押してそのまま押し続けたら `MO(_MY_LAYER)` 、2回タップしたときは `TG(_MY_LAYER)` として機能するキーを設定します。
@ -451,24 +434,24 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 ```c
 typedef struct {
    bool is_press_action;
-  int state;
+    uint8_t state;
 } tap;
 // 必要な数のタップダンス状態のタイプを定義します
 enum {
    SINGLE_TAP = 1,
-  SINGLE_HOLD = 2,
+    SINGLE_HOLD,
-  DOUBLE_TAP = 3
+    DOUBLE_TAP
 };
 enum {
-  QUOT_LAYR = 0  //カスタムタップダンスキー。他のタップダンスキーはこの列挙型に追加します
+    QUOT_LAYR, // カスタムタップダンスキー。他のタップダンスキーはこの列挙型に追加します
 };
 // タップダンスキーで使われる関数を宣言します
 // 全てのタップダンスに関連する関数
-int cur_dance (qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 // 個別のタップダンスに関連する関数
 void ql_finished(qk_tap_dance_state_t *state, void *user_data);
@ -479,16 +462,11 @@ void ql_reset (qk_tap_dance_state_t *state, void *user_data);
 ```c
 // 現在のタップダンスの状態を決定します
-int cur_dance (qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
    if (state->count == 1) {
-    if (!state->pressed) {
+        if (!state->pressed) return SINGLE_TAP;
-      return SINGLE_TAP;
+        else return SINGLE_HOLD;
-    } else {
+    } else if (state->count == 2) return DOUBLE_TAP;
      return SINGLE_HOLD;
    }
  } else if (state->count == 2) {
    return DOUBLE_TAP;
  }
    else return 8;
 }
@ -539,7 +517,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 `cur_dance()` と `ql_tap_state` の使い方は、上の例と似ています。
-`ql_finished` 関数における `case:SINGLE_TAP` は、上の例と似ています。`case:SINGLE_HOLD` は、`ql_reset()` と連動してタップダンスキーを押している間 `_MY_LAYER` に切り替わり、キーを離した時に `_MY_LAYER` から離れます。これは、`MO(_MY_LAYER)` に似ています。`case:DOUBLE_TAP` は、`_MY_LAYER` がアクティブレイヤーかどうかを確認することによって動きます。そして、その結果に基づいてレイヤーのオン・オフをトグルします。これは `TG(_MY_LAYER)` に似ています。
+`ql_finished` 関数における `case:SINGLE_TAP` は、上の例と似ています。`SINGLE_HOLD` の case では、`ql_reset()` と連動してタップダンスキーを押している間 `_MY_LAYER` に切り替わり、キーを離した時に `_MY_LAYER` から離れます。これは、`MO(_MY_LAYER)` に似ています。`DOUBLE_TAP` の case では、`_MY_LAYER` がアクティブレイヤーかどうかを確認することによって動きます。そして、その結果に基づいてレイヤーのオン・オフをトグルします。これは `TG(_MY_LAYER)` に似ています。
 `tap_dance_actions[]` は、上の例に似ています。 `ACTION_TAP_DANCE_FN_ADVANCED()` の代わりに `ACTION_TAP_DANCE_FN_ADVANCED_TIME()` を使ったことに注意してください。
 この理由は、私は、非タップダンスキーを使うにあたり `TAPPING_TERM` が短い(175ミリ秒以内)方が好きなのですが、タップダンスのアクションを確実に完了させるには短すぎるとわかったからです——そのため、ここでは時間を275ミリ秒に増やしています。