aboutsummaryrefslogtreecommitdiff
path: root/docs/ja
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja')
-rw-r--r--docs/ja/cli_commands.md14
-rw-r--r--docs/ja/cli_development.md4
-rw-r--r--docs/ja/compatible_microcontrollers.md3
-rw-r--r--docs/ja/feature_bootmagic.md2
-rw-r--r--docs/ja/feature_debounce_type.md17
-rw-r--r--docs/ja/feature_dip_switch.md16
-rw-r--r--docs/ja/feature_encoders.md10
-rw-r--r--docs/ja/feature_led_matrix.md4
-rw-r--r--docs/ja/feature_tap_dance.md2
-rw-r--r--docs/ja/hardware_avr.md38
-rw-r--r--docs/ja/reference_configurator_support.md2
-rw-r--r--docs/ja/reference_info_json.md4
12 files changed, 53 insertions, 63 deletions
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md
index 81cb03cfe..35937dbbc 100644
--- a/docs/ja/cli_commands.md
+++ b/docs/ja/cli_commands.md
@@ -211,7 +211,7 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
211 211
212# 開発者用コマンド 212# 開発者用コマンド
213 213
214## `qmk cformat` 214## `qmk format-c`
215 215
216このコマンドは clang-format を使って C コードを整形します。 216このコマンドは clang-format を使って C コードを整形します。
217 217
@@ -222,25 +222,25 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
222**指定したファイルに対する使い方**: 222**指定したファイルに対する使い方**:
223 223
224``` 224```
225qmk cformat [file1] [file2] [...] [fileN] 225qmk format-c [file1] [file2] [...] [fileN]
226``` 226```
227 227
228**全てのコアファイルに対する使い方**: 228**全てのコアファイルに対する使い方**:
229 229
230``` 230```
231qmk cformat -a 231qmk format-c -a
232``` 232```
233 233
234**origin/master で変更されたファイルのみに対する使い方**: 234**origin/master で変更されたファイルのみに対する使い方**:
235 235
236``` 236```
237qmk cformat 237qmk format-c
238``` 238```
239 239
240**branch_name で変更されたファイルのみに対する使い方**: 240**branch_name で変更されたファイルのみに対する使い方**:
241 241
242``` 242```
243qmk cformat -b branch_name 243qmk format-c -b branch_name
244``` 244```
245 245
246## `qmk docs` 246## `qmk docs`
@@ -275,14 +275,14 @@ $ qmk kle2json -f kle.txt -f
275Ψ Wrote out to info.json 275Ψ Wrote out to info.json
276``` 276```
277 277
278## `qmk pyformat` 278## `qmk format-py`
279 279
280このコマンドは `qmk_firmware` 内の python コードを整形します。 280このコマンドは `qmk_firmware` 内の python コードを整形します。
281 281
282**使用法**: 282**使用法**:
283 283
284``` 284```
285qmk pyformat 285qmk format-py
286``` 286```
287 287
288## `qmk pytest` 288## `qmk pytest`
diff --git a/docs/ja/cli_development.md b/docs/ja/cli_development.md
index 47262213a..28cdd91c1 100644
--- a/docs/ja/cli_development.md
+++ b/docs/ja/cli_development.md
@@ -192,7 +192,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou
192 192
193# テスト、リントおよびフォーマット 193# テスト、リントおよびフォーマット
194 194
195nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `pyformat` サブコマンドを使うことができます。 195nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `format-py` サブコマンドを使うことができます。
196 196
197### テストとリント 197### テストとリント
198 198
@@ -200,7 +200,7 @@ nose2、flake8 および yapf を使ってコードをテスト、リントお
200 200
201### フォーマット 201### フォーマット
202 202
203 qmk pyformat 203 qmk format-py
204 204
205## フォーマットの詳細 205## フォーマットの詳細
206 206
diff --git a/docs/ja/compatible_microcontrollers.md b/docs/ja/compatible_microcontrollers.md
index b675b038d..85b31f3f1 100644
--- a/docs/ja/compatible_microcontrollers.md
+++ b/docs/ja/compatible_microcontrollers.md
@@ -32,10 +32,13 @@ QMK は十分な容量のフラッシュメモリを備えた USB 対応 AVR ま
32* [STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html) 32* [STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)
33* [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html) 33* [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html)
34* [STM32F401](https://www.st.com/en/microcontrollers-microprocessors/stm32f401.html) 34* [STM32F401](https://www.st.com/en/microcontrollers-microprocessors/stm32f401.html)
35* [STM32F407](https://www.st.com/en/microcontrollers-microprocessors/stm32f407-417.html)
35* [STM32F411](https://www.st.com/en/microcontrollers-microprocessors/stm32f411.html) 36* [STM32F411](https://www.st.com/en/microcontrollers-microprocessors/stm32f411.html)
36* [STM32F446](https://www.st.com/en/microcontrollers-microprocessors/stm32f446.html) 37* [STM32F446](https://www.st.com/en/microcontrollers-microprocessors/stm32f446.html)
37* [STM32G431](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x1.html) 38* [STM32G431](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x1.html)
38* [STM32G474](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x4.html) 39* [STM32G474](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x4.html)
40* [STM32L412](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x2.html)
41* [STM32L422](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x2.html)
39* [STM32L433](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html) 42* [STM32L433](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html)
40* [STM32L443](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html) 43* [STM32L443](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html)
41 44
diff --git a/docs/ja/feature_bootmagic.md b/docs/ja/feature_bootmagic.md
index 20a93d5c4..2ad6fc853 100644
--- a/docs/ja/feature_bootmagic.md
+++ b/docs/ja/feature_bootmagic.md
@@ -16,7 +16,7 @@
16一部のキーボードでは、ブートマジックはデフォルトで無効になっています。その場合、`rules.mk` 内で以下のように明示的に有効にする必要があります: 16一部のキーボードでは、ブートマジックはデフォルトで無効になっています。その場合、`rules.mk` 内で以下のように明示的に有効にする必要があります:
17 17
18```make 18```make
19BOOTMAGIC_ENABLE = full 19BOOTMAGIC_ENABLE = yes
20``` 20```
21 21
22?> `full` の代わりに `yes` が使われていることがあるかもしれませんが、これは問題ありません。ただし、`yes` は非推奨で、理想的には `full` (あるいは`lite`) が使われるべきです。 22?> `full` の代わりに `yes` が使われていることがあるかもしれませんが、これは問題ありません。ただし、`yes` は非推奨で、理想的には `full` (あるいは`lite`) が使われるべきです。
diff --git a/docs/ja/feature_debounce_type.md b/docs/ja/feature_debounce_type.md
index 03f68d721..258ca194d 100644
--- a/docs/ja/feature_debounce_type.md
+++ b/docs/ja/feature_debounce_type.md
@@ -88,15 +88,6 @@ voltage +----------------------
88## QMK でサポートされるデバウンスアルゴリズム 88## QMK でサポートされるデバウンスアルゴリズム
89 89
90QMK はデバウンス API を介して複数のデバウンスアルゴリズムをサポートします。 90QMK はデバウンス API を介して複数のデバウンスアルゴリズムをサポートします。
91どのデバウンスメソッドが呼ばれるかのロジックは下記のとおりです。```rules.mk``` で設定された様々な定義をチェックします。
92
93```
94DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
95DEBOUNCE_TYPE?= sym_defer_g
96ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
97 QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
98endif
99```
100 91
101### デバウンスの選択 92### デバウンスの選択
102 93
@@ -135,11 +126,3 @@ DEBOUNCE_TYPE = <アルゴリズムの名前>
135* デバウンスは、全てのマトリクススキャンの後で発生します。 126* デバウンスは、全てのマトリクススキャンの後で発生します。
136* MATRIX_ROWS ではなく num_rows を使って、分割キーボードが正しくサポートされるようにします。 127* MATRIX_ROWS ではなく num_rows を使って、分割キーボードが正しくサポートされるようにします。
137* アルゴリズムが他のキーボードにも適用できる可能性がある場合、```quantum/debounce``` に追加することを検討してください。 128* アルゴリズムが他のキーボードにも適用できる可能性がある場合、```quantum/debounce``` に追加することを検討してください。
138
139### 古い名前
140次の既存のアルゴリズムの古い名前は引き続きサポートされますが、代わりに新しい名前を使うことを推奨します。
141
142* sym_g - sym_defer_g の古い名前
143* eager_pk - sym_eager_pk の古い名前
144* sym_pk - sym_defer_pk の古い名前
145* eager_pr - sym_eager_pr の古い名前
diff --git a/docs/ja/feature_dip_switch.md b/docs/ja/feature_dip_switch.md
index a0f6aeb00..a5436779f 100644
--- a/docs/ja/feature_dip_switch.md
+++ b/docs/ja/feature_dip_switch.md
@@ -28,8 +28,9 @@ DIP スイッチは、以下を `rules.mk` に追加することでサポート
28コールバック関数を `<keyboard>.c` に記述することができます: 28コールバック関数を `<keyboard>.c` に記述することができます:
29 29
30```c 30```c
31void dip_switch_update_kb(uint8_t index, bool active) { 31bool dip_switch_update_kb(uint8_t index, bool active) {
32 dip_switch_update_user(index, active); 32 if !(dip_switch_update_user(index, active)) { return false; }
33 return true;
33} 34}
34``` 35```
35 36
@@ -37,7 +38,7 @@ void dip_switch_update_kb(uint8_t index, bool active) {
37あるいは `keymap.c` に記述することもできます: 38あるいは `keymap.c` に記述することもできます:
38 39
39```c 40```c
40void dip_switch_update_user(uint8_t index, bool active) { 41bool dip_switch_update_user(uint8_t index, bool active) {
41 switch (index) { 42 switch (index) {
42 case 0: 43 case 0:
43 if(active) { audio_on(); } else { audio_off(); } 44 if(active) { audio_on(); } else { audio_off(); }
@@ -62,6 +63,7 @@ void dip_switch_update_user(uint8_t index, bool active) {
62 } 63 }
63 break; 64 break;
64 } 65 }
66 return true;
65} 67}
66``` 68```
67 69
@@ -69,8 +71,9 @@ void dip_switch_update_user(uint8_t index, bool active) {
69 71
70 72
71```c 73```c
72void dip_switch_update_mask_kb(uint32_t state) { 74bool dip_switch_update_mask_kb(uint32_t state) {
73 dip_switch_update_mask_user(state); 75 if (!dip_switch_update_mask_user(state)) { return false; }
76 return true;
74} 77}
75``` 78```
76 79
@@ -78,7 +81,7 @@ void dip_switch_update_mask_kb(uint32_t state) {
78あるいは `keymap.c` に記述することもできます: 81あるいは `keymap.c` に記述することもできます:
79 82
80```c 83```c
81void dip_switch_update_mask_user(uint32_t state) { 84bool dip_switch_update_mask_user(uint32_t state) {
82 if (state & (1UL<<0) && state & (1UL<<1)) { 85 if (state & (1UL<<0) && state & (1UL<<1)) {
83 layer_on(_ADJUST); // C on esc 86 layer_on(_ADJUST); // C on esc
84 } else { 87 } else {
@@ -94,6 +97,7 @@ void dip_switch_update_mask_user(uint32_t state) {
94 } else { 97 } else {
95 layer_off(_TEST_B); 98 layer_off(_TEST_B);
96 } 99 }
100 return true;
97} 101}
98``` 102```
99 103
diff --git a/docs/ja/feature_encoders.md b/docs/ja/feature_encoders.md
index 7b7f394c8..21f42d38b 100644
--- a/docs/ja/feature_encoders.md
+++ b/docs/ja/feature_encoders.md
@@ -51,15 +51,18 @@ ENCODER_ENABLE = yes
51コールバック関数を `<keyboard>.c` に記述することができます: 51コールバック関数を `<keyboard>.c` に記述することができます:
52 52
53```c 53```c
54void encoder_update_kb(uint8_t index, bool clockwise) { 54bool encoder_update_kb(uint8_t index, bool clockwise) {
55 encoder_update_user(index, clockwise); 55 if (!encoder_update_user(index, clockwise)) {
56 return false;
57 }
58
56} 59}
57``` 60```
58 61
59あるいは `keymap.c` に記述することもできます: 62あるいは `keymap.c` に記述することもできます:
60 63
61```c 64```c
62void encoder_update_user(uint8_t index, bool clockwise) { 65bool encoder_update_user(uint8_t index, bool clockwise) {
63 if (index == 0) { /* First encoder */ 66 if (index == 0) { /* First encoder */
64 if (clockwise) { 67 if (clockwise) {
65 tap_code(KC_PGDN); 68 tap_code(KC_PGDN);
@@ -73,6 +76,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
73 tap_code(KC_UP); 76 tap_code(KC_UP);
74 } 77 }
75 } 78 }
79 return true;
76} 80}
77``` 81```
78 82
diff --git a/docs/ja/feature_led_matrix.md b/docs/ja/feature_led_matrix.md
index 62e22859f..6511b2824 100644
--- a/docs/ja/feature_led_matrix.md
+++ b/docs/ja/feature_led_matrix.md
@@ -52,7 +52,7 @@ I2C IS31FL3731 RGB コントローラを使ったアドレス指定可能な LED
52 52
53`<keyboard>.c` に全ての LED を列挙する配列を定義します: 53`<keyboard>.c` に全ての LED を列挙する配列を定義します:
54 54
55 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { 55 const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
56 /* これらの位置については IS31 マニュアルを参照してください 56 /* これらの位置については IS31 マニュアルを参照してください
57 * driver 57 * driver
58 * | LED address 58 * | LED address
@@ -61,7 +61,7 @@ I2C IS31FL3731 RGB コントローラを使ったアドレス指定可能な LED
61 .... 61 ....
62 } 62 }
63 63
64ここで、`Cx_y` は[データシート](https://www.issi.com/WW/pdf/31FL3731.pdf)およびヘッダファイル `drivers/issi/is31fl3731-simple.h` で定義されるマトリックス内の LED の位置です。`driver` は `config.h` で定義したドライバのインデックス(`0`、`1`、`2`、`3`のいずれか)です。 64ここで、`Cx_y` は[データシート](https://www.issi.com/WW/pdf/31FL3731.pdf)およびヘッダファイル `drivers/led/issi/is31fl3731-simple.h` で定義されるマトリックス内の LED の位置です。`driver` は `config.h` で定義したドライバのインデックス(`0`、`1`、`2`、`3`のいずれか)です。
65 65
66## キーコード 66## キーコード
67 67
diff --git a/docs/ja/feature_tap_dance.md b/docs/ja/feature_tap_dance.md
index 082d48f1c..a6d108f1e 100644
--- a/docs/ja/feature_tap_dance.md
+++ b/docs/ja/feature_tap_dance.md
@@ -59,7 +59,7 @@
59 59
60このことは、あなたは再びキーをタップするまでの時間として `TAPPING_TERM` の時間を持っていることを意味します。そのため、あなたは1つの `TAPPING_TERM` の時間内に全てのタップを行う必要はありません。これにより、キーの反応への影響を最小限に抑えながら、より長いタップ回数を可能にします。 60このことは、あなたは再びキーをタップするまでの時間として `TAPPING_TERM` の時間を持っていることを意味します。そのため、あなたは1つの `TAPPING_TERM` の時間内に全てのタップを行う必要はありません。これにより、キーの反応への影響を最小限に抑えながら、より長いタップ回数を可能にします。
61 61
62次は `matrix_scan_tap_dance()` です。この関数はタップダンスキーのタイムアウトを制御します。 62次は `tap_dance_task()` です。この関数はタップダンスキーのタイムアウトを制御します。
63 63
64柔軟性のために、タップダンスは、キーコードの組み合わせにも、ユーザー関数にもなることができます。後者は、より高度なタップ回数の制御や、LED を点滅させたり、バックライトをいじったり、等々の制御を可能にします。これは、1つの共用体と、いくつかの賢いマクロによって成し遂げられています。 64柔軟性のために、タップダンスは、キーコードの組み合わせにも、ユーザー関数にもなることができます。後者は、より高度なタップ回数の制御や、LED を点滅させたり、バックライトをいじったり、等々の制御を可能にします。これは、1つの共用体と、いくつかの賢いマクロによって成し遂げられています。
65 65
diff --git a/docs/ja/hardware_avr.md b/docs/ja/hardware_avr.md
index 66be2f71c..cdc5f8cb8 100644
--- a/docs/ja/hardware_avr.md
+++ b/docs/ja/hardware_avr.md
@@ -12,26 +12,28 @@
12 12
13## AVR を使用したキーボードを QMK に追加する 13## AVR を使用したキーボードを QMK に追加する
14 14
15QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`util/new_keyboard.sh` スクリプトを実行します。 15QMK には AVR を使ったキーボードでの作業を簡略化するための機能が多数あります。大体のキーボードでは1行もコードを書く必要がありません。まずはじめに、`qmk new-keyboard` を実行します。
16 16
17``` 17```
18$ ./util/new_keyboard.sh 18$ qmk new-keyboard
19Generating a new QMK keyboard directory 19Ψ Generating a new QMK keyboard directory
20 20
21Keyboard Name: mycoolkb 21Keyboard Name: mycoolkeeb
22Keyboard Type [avr]: 22Keyboard Type:
23Your Name [John Smith]: 23 1. avr
24 24 2. ps2avrgb
25Copying base template files... done 25Please enter your choice: [1]
26Copying avr template files... done 26Your Name: [John Smith]
27Renaming keyboard files... done 27Ψ Copying base template files...
28Replacing %KEYBOARD% with mycoolkb... done 28Ψ Copying avr template files...
29Replacing %YOUR_NAME% with John Smith... done 29Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]...
30 30Ψ Replacing %YEAR% with 2021...
31Created a new keyboard called mycoolkb. 31Ψ Replacing %KEYBOARD% with mycoolkeeb...
32 32Ψ Replacing %YOUR_NAME% with John Smith...
33To start working on things, cd into keyboards/mycoolkb, 33
34or open the directory in your favourite text editor. 34Ψ Created a new keyboard called mycoolkeeb.
35Ψ To start working on things, `cd` into keyboards/mycoolkeeb,
36Ψ or open the directory in your preferred text editor.
35``` 37```
36 38
37これにより、新しいキーボードをサポートするために必要なすべてのファイルが作成され、デフォルト値で設定が入力されます。あとはあなたのキーボード用にカスタマイズするだけです。 39これにより、新しいキーボードをサポートするために必要なすべてのファイルが作成され、デフォルト値で設定が入力されます。あとはあなたのキーボード用にカスタマイズするだけです。
diff --git a/docs/ja/reference_configurator_support.md b/docs/ja/reference_configurator_support.md
index 4fb98fc0e..83d6d648d 100644
--- a/docs/ja/reference_configurator_support.md
+++ b/docs/ja/reference_configurator_support.md
@@ -104,8 +104,6 @@ JSON ファイルをビルドする最も簡単な方法は、[Keyboard Layout E
104 "tags": { 104 "tags": {
105 "form_factor": "numpad" 105 "form_factor": "numpad"
106 }, 106 },
107 "width": 4,
108 "height": 5,
109 "layouts": { 107 "layouts": {
110 "LAYOUT": { 108 "LAYOUT": {
111 "layout": [ 109 "layout": [
diff --git a/docs/ja/reference_info_json.md b/docs/ja/reference_info_json.md
index 5b9a1b6b6..7346a6395 100644
--- a/docs/ja/reference_info_json.md
+++ b/docs/ja/reference_info_json.md
@@ -20,10 +20,6 @@
20 * キーボードの製品ページ、[QMK.fm/keyboards](https://qmk.fm/keyboards) のページ、あるいはキーボードに関する情報を説明する他のページの URL。 20 * キーボードの製品ページ、[QMK.fm/keyboards](https://qmk.fm/keyboards) のページ、あるいはキーボードに関する情報を説明する他のページの URL。
21* `maintainer` 21* `maintainer`
22 * メンテナの GitHub のユーザ名、あるいはコミュニティが管理するキーボードの場合は `qmk` 22 * メンテナの GitHub のユーザ名、あるいはコミュニティが管理するキーボードの場合は `qmk`
23* `width`
24 * キー単位でのキーボードの幅
25* `height`
26 * キー単位でのキーボードの高さ
27* `layouts` 23* `layouts`
28 * 物理的なレイアウト表現。詳細は以下のセクションを見てください。 24 * 物理的なレイアウト表現。詳細は以下のセクションを見てください。
29 25