diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/config_options.md | 2 | ||||
-rw-r--r-- | docs/faq_misc.md | 4 | ||||
-rw-r--r-- | docs/feature_bootmagic.md | 2 | ||||
-rw-r--r-- | docs/feature_velocikey.md | 1 | ||||
-rw-r--r-- | docs/fr-fr/faq_debug.md | 4 | ||||
-rw-r--r-- | docs/getting_started_make_guide.md | 2 | ||||
-rw-r--r-- | docs/ja/config_options.md | 2 | ||||
-rw-r--r-- | docs/ja/faq_misc.md | 4 | ||||
-rw-r--r-- | docs/ja/feature_velocikey.md | 1 | ||||
-rw-r--r-- | docs/zh-cn/faq_debug.md | 5 |
10 files changed, 3 insertions, 24 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index c4e5afb56..ece7ab8ee 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
@@ -407,7 +407,7 @@ Use these to enable or disable building certain features. The more you have enab | |||
407 | * `MAGIC_ENABLE` | 407 | * `MAGIC_ENABLE` |
408 | * MAGIC actions (BOOTMAGIC without the boot) | 408 | * MAGIC actions (BOOTMAGIC without the boot) |
409 | * `BOOTMAGIC_ENABLE` | 409 | * `BOOTMAGIC_ENABLE` |
410 | * Virtual DIP switch configuration | 410 | * Enable Bootmagic Lite |
411 | * `MOUSEKEY_ENABLE` | 411 | * `MOUSEKEY_ENABLE` |
412 | * Mouse keys | 412 | * Mouse keys |
413 | * `EXTRAKEY_ENABLE` | 413 | * `EXTRAKEY_ENABLE` |
diff --git a/docs/faq_misc.md b/docs/faq_misc.md index 41d17906b..9e34a0481 100644 --- a/docs/faq_misc.md +++ b/docs/faq_misc.md | |||
@@ -49,10 +49,6 @@ First you have to compile firmware with the build option `NKRO_ENABLE` in **Make | |||
49 | 49 | ||
50 | Try `Magic` **N** command(`LShift+RShift+N` by default) when **NKRO** still doesn't work. You can use this command to toggle between **NKRO** and **6KRO** mode temporarily. In some situations **NKRO** doesn't work and you will need to switch to **6KRO** mode, in particular when you are in BIOS. | 50 | Try `Magic` **N** command(`LShift+RShift+N` by default) when **NKRO** still doesn't work. You can use this command to toggle between **NKRO** and **6KRO** mode temporarily. In some situations **NKRO** doesn't work and you will need to switch to **6KRO** mode, in particular when you are in BIOS. |
51 | 51 | ||
52 | If your firmware was built with `BOOTMAGIC_ENABLE` you need to turn its switch on by `BootMagic` **N** command(`Space+N` by default). This setting is stored in EEPROM and kept over power cycles. | ||
53 | |||
54 | https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch | ||
55 | |||
56 | 52 | ||
57 | ## TrackPoint Needs Reset Circuit (PS/2 Mouse Support) | 53 | ## TrackPoint Needs Reset Circuit (PS/2 Mouse Support) |
58 | Without reset circuit you will have inconsistent result due to improper initialization of the hardware. See circuit schematic of TPM754: | 54 | Without reset circuit you will have inconsistent result due to improper initialization of the hardware. See circuit schematic of TPM754: |
diff --git a/docs/feature_bootmagic.md b/docs/feature_bootmagic.md index 6c66b0067..148ea92b9 100644 --- a/docs/feature_bootmagic.md +++ b/docs/feature_bootmagic.md | |||
@@ -8,8 +8,6 @@ On some keyboards Bootmagic Lite is disabled by default. If this is the case, it | |||
8 | BOOTMAGIC_ENABLE = yes | 8 | BOOTMAGIC_ENABLE = yes |
9 | ``` | 9 | ``` |
10 | 10 | ||
11 | ?> You may see `lite` being used in place of `yes`. | ||
12 | |||
13 | Additionally, you may want to specify which key to use. This is especially useful for keyboards that have unusual matrices. To do so, you need to specify the row and column of the key that you want to use. Add these entries to your `config.h` file: | 11 | Additionally, you may want to specify which key to use. This is especially useful for keyboards that have unusual matrices. To do so, you need to specify the row and column of the key that you want to use. Add these entries to your `config.h` file: |
14 | 12 | ||
15 | ```c | 13 | ```c |
diff --git a/docs/feature_velocikey.md b/docs/feature_velocikey.md index 93dd7de94..14d4be314 100644 --- a/docs/feature_velocikey.md +++ b/docs/feature_velocikey.md | |||
@@ -6,7 +6,6 @@ Velocikey is a feature that lets you control the speed of lighting effects (like | |||
6 | For Velocikey to take effect, there are two steps. First, when compiling your keyboard, you'll need to set `VELOCIKEY_ENABLE=yes` in `rules.mk`, e.g.: | 6 | For Velocikey to take effect, there are two steps. First, when compiling your keyboard, you'll need to set `VELOCIKEY_ENABLE=yes` in `rules.mk`, e.g.: |
7 | 7 | ||
8 | ``` | 8 | ``` |
9 | BOOTMAGIC_ENABLE = no | ||
10 | MOUSEKEY_ENABLE = no | 9 | MOUSEKEY_ENABLE = no |
11 | STENO_ENABLE = no | 10 | STENO_ENABLE = no |
12 | EXTRAKEY_ENABLE = yes | 11 | EXTRAKEY_ENABLE = yes |
diff --git a/docs/fr-fr/faq_debug.md b/docs/fr-fr/faq_debug.md index 3b13b96b5..8868744f7 100644 --- a/docs/fr-fr/faq_debug.md +++ b/docs/fr-fr/faq_debug.md | |||
@@ -85,10 +85,6 @@ Premièrement, vous devez compiler le firmware avec l'option de compilation `NKR | |||
85 | 85 | ||
86 | Essayez la commande `Magic` **N** (`LShift+RShift+N` par défaut) si **NKRO** ne fonctionne toujours pas. Vous pouvez utiliser cette commande pour basculer temporairement entre le mode **NKRO** et **6KRO**. Sous certaines conditions, **NKRO** ne fonctionnera pas et vous devrez basculer en **6KRO**, en particulier lorsque vous êtes dans le BIOS. | 86 | Essayez la commande `Magic` **N** (`LShift+RShift+N` par défaut) si **NKRO** ne fonctionne toujours pas. Vous pouvez utiliser cette commande pour basculer temporairement entre le mode **NKRO** et **6KRO**. Sous certaines conditions, **NKRO** ne fonctionnera pas et vous devrez basculer en **6KRO**, en particulier lorsque vous êtes dans le BIOS. |
87 | 87 | ||
88 | Si votre firmware est compilé avec `BOOTMAGIC_ENABLE` vous devrez l'activer avec la commande `BootMagic` **N** (`Espace+N` par défaut). Cette option est enregistrée dans l'EEPROM et sera gardé entre deux cycles de démarrage. | ||
89 | |||
90 | https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch | ||
91 | |||
92 | ## Le TrackPoint a besoin Circuit de réinitialisation (Support de souris PS/2) | 88 | ## Le TrackPoint a besoin Circuit de réinitialisation (Support de souris PS/2) |
93 | 89 | ||
94 | Sans circuit de réinitialisation vous allez avoir des résultats inconsistants à cause de la mauvaise initialisation du matériel. Regardez le schéma du circuit du TPM754. | 90 | Sans circuit de réinitialisation vous allez avoir des résultats inconsistants à cause de la mauvaise initialisation du matériel. Regardez le schéma du circuit du TPM754. |
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index deef7520e..a51486435 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
@@ -55,7 +55,7 @@ Set these variables to `no` to disable them, and `yes` to enable them. | |||
55 | 55 | ||
56 | `BOOTMAGIC_ENABLE` | 56 | `BOOTMAGIC_ENABLE` |
57 | 57 | ||
58 | This allows you to hold a key and the salt key (space by default) and have access to a various EEPROM settings that persist over power loss. It's advised you keep this disabled, as the settings are often changed by accident, and produce confusing results that makes it difficult to debug. It's one of the more common problems encountered in help sessions. | 58 | This allows you to hold a key (usually Escape by default) to reset the EEPROM settings that persist over power loss and ready your keyboard to accept new firmware. |
59 | 59 | ||
60 | `MOUSEKEY_ENABLE` | 60 | `MOUSEKEY_ENABLE` |
61 | 61 | ||
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md index 18fe9489b..fb43d015f 100644 --- a/docs/ja/config_options.md +++ b/docs/ja/config_options.md | |||
@@ -358,7 +358,7 @@ QMK での全ての利用可能な設定にはデフォルトがあります。 | |||
358 | これらを使って特定の機能のビルドを有効または無効にします。有効にすればするほどファームウェアが大きくなり、MCU には大きすぎるファームウェアを構築するリスクがあります。 | 358 | これらを使って特定の機能のビルドを有効または無効にします。有効にすればするほどファームウェアが大きくなり、MCU には大きすぎるファームウェアを構築するリスクがあります。 |
359 | 359 | ||
360 | * `BOOTMAGIC_ENABLE` | 360 | * `BOOTMAGIC_ENABLE` |
361 | * 仮 DIP ッ設 | 361 | * マッイトを有にします |
362 | * `MOUSEKEY_ENABLE` | 362 | * `MOUSEKEY_ENABLE` |
363 | * マウスキー | 363 | * マウスキー |
364 | * `EXTRAKEY_ENABLE` | 364 | * `EXTRAKEY_ENABLE` |
diff --git a/docs/ja/faq_misc.md b/docs/ja/faq_misc.md index e9a35ef32..38917df2e 100644 --- a/docs/ja/faq_misc.md +++ b/docs/ja/faq_misc.md | |||
@@ -39,10 +39,6 @@ Size after: | |||
39 | 39 | ||
40 | **NKRO** がまだ動作しない場合は、`Magic` **N** コマンド(デフォルトでは `LShift+RShift+N`)を試してみてください。**NKRO** モードと **6KRO** モード間を一時的に切り替えるためにこのコマンドを使うことができます。**NKRO** が機能しない状況、特に BIOS の場合は **6KRO** モードに切り替える必要があります。 | 40 | **NKRO** がまだ動作しない場合は、`Magic` **N** コマンド(デフォルトでは `LShift+RShift+N`)を試してみてください。**NKRO** モードと **6KRO** モード間を一時的に切り替えるためにこのコマンドを使うことができます。**NKRO** が機能しない状況、特に BIOS の場合は **6KRO** モードに切り替える必要があります。 |
41 | 41 | ||
42 | ファームウェアを `BOOTMAGIC_ENABLE` でビルドした場合、`ブートマジック` **N** コマンドで切り替える必要があります(デフォルトでは `Space+N`)。この設定は EEPROM に格納され、電源を入れ直しても保持されます。 | ||
43 | |||
44 | https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch | ||
45 | |||
46 | 42 | ||
47 | ## トラックポイントははリセット回路が必要です (PS/2 マウスサポート) | 43 | ## トラックポイントははリセット回路が必要です (PS/2 マウスサポート) |
48 | リセット回路が無いとハードウェアの不適切な初期化のために一貫性の無い結果になります。TPM754 の回路図を見てください: | 44 | リセット回路が無いとハードウェアの不適切な初期化のために一貫性の無い結果になります。TPM754 の回路図を見てください: |
diff --git a/docs/ja/feature_velocikey.md b/docs/ja/feature_velocikey.md index f9b6e73bd..b13969a19 100644 --- a/docs/ja/feature_velocikey.md +++ b/docs/ja/feature_velocikey.md | |||
@@ -11,7 +11,6 @@ Velocikey は入力の速度を使って(レインボー渦巻効果のような | |||
11 | Velocikey を使うためには、2つのステップがあります。最初に、キーボードをコンパイルする時に、`rules.mk` に `VELOCIKEY_ENABLE=yes` を設定する必要があります。例えば: | 11 | Velocikey を使うためには、2つのステップがあります。最初に、キーボードをコンパイルする時に、`rules.mk` に `VELOCIKEY_ENABLE=yes` を設定する必要があります。例えば: |
12 | 12 | ||
13 | ``` | 13 | ``` |
14 | BOOTMAGIC_ENABLE = no | ||
15 | MOUSEKEY_ENABLE = no | 14 | MOUSEKEY_ENABLE = no |
16 | STENO_ENABLE = no | 15 | STENO_ENABLE = no |
17 | EXTRAKEY_ENABLE = yes | 16 | EXTRAKEY_ENABLE = yes |
diff --git a/docs/zh-cn/faq_debug.md b/docs/zh-cn/faq_debug.md index 3b6a36900..4dba44c27 100644 --- a/docs/zh-cn/faq_debug.md +++ b/docs/zh-cn/faq_debug.md | |||
@@ -81,11 +81,6 @@ Size after: | |||
81 | 81 | ||
82 | 全键无冲还不好用的话试着用`Magic` **N** 命令(默认是`LShift+RShift+N`)。这个命令会在**全键无冲**和**六键无冲**之间临时切换。有些情况**全键无冲**不好用你就需要使用**六键无冲**模式,尤其是在BIOS中。 | 82 | 全键无冲还不好用的话试着用`Magic` **N** 命令(默认是`LShift+RShift+N`)。这个命令会在**全键无冲**和**六键无冲**之间临时切换。有些情况**全键无冲**不好用你就需要使用**六键无冲**模式,尤其是在BIOS中。 |
83 | 83 | ||
84 | 如果你的固件使用`BOOTMAGIC_ENABLE`编译的你要用`BootMagic` **N** 命令(默认`Space+N`)打开开关。这个设置保存在EEPROM中并保存在电源循环中。 | ||
85 | <!--翻译问题:上面这句翻译的不贴切 --> | ||
86 | |||
87 | https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch | ||
88 | |||
89 | 84 | ||
90 | ## 指点杆需要复位电路(PS/2 鼠标支持) | 85 | ## 指点杆需要复位电路(PS/2 鼠标支持) |
91 | 如果没有复位电路,由于硬件初始化不正确,您将得到不一致的结果。查看TPM754复位电路。 | 86 | 如果没有复位电路,由于硬件初始化不正确,您将得到不一致的结果。查看TPM754复位电路。 |