From 90bb7db48e658624c6c4609c832ac1451e4db98b Mon Sep 17 00:00:00 2001 From: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Date: Thu, 21 Nov 2019 19:36:38 +0900 Subject: [PATCH] [Docs] Update japanese translation of newbs.md and related documents. (#7431) * Update japanese translation of newbs.md and related documents. * document link id change * add `ja/` in each link `[xxx](yyy.md)` --> `[xxx](ja/yyy.md)` * copy docs/ja/_summary.md from umi-umi's #7248 and fix it --- docs/ja/_summary.md | 121 ++++++++++++++++++ docs/ja/newbs.md | 16 +-- docs/ja/newbs_best_practices.md | 4 +- docs/ja/newbs_building_firmware.md | 8 +- .../newbs_building_firmware_configurator.md | 2 +- docs/ja/newbs_flashing.md | 10 +- docs/ja/newbs_getting_started.md | 12 +- docs/ja/newbs_learn_more_resources.md | 4 +- docs/ja/newbs_testing_debugging.md | 6 +- 9 files changed, 152 insertions(+), 31 deletions(-) create mode 100644 docs/ja/_summary.md diff --git a/docs/ja/_summary.md b/docs/ja/_summary.md new file mode 100644 index 0000000000..22db3a7fe1 --- /dev/null +++ b/docs/ja/_summary.md @@ -0,0 +1,121 @@ +* [完全な初心者のガイド](ja/newbs.md) + * [はじめに](ja/newbs_getting_started.md) + * [初めてのファームウェアの構築](ja/newbs_building_firmware.md) + * [ファームウェアのフラッシュ](ja/newbs_flashing.md) + * [テストとデバッグ](ja/newbs_testing_debugging.md) + * [Gitのベストプラクティス](ja/newbs_best_practices.md) + * [学習リソース](ja/newbs_learn_more_resources.md) + +* [QMKの基本](ja/README.md) + * [QMKの導入](ja/getting_started_introduction.md) + * [QMK CLI](ja/cli.md) + * [QMK CLI 設定](ja/cli_configuration.md) + * [QMKへの貢献](ja/contributing.md) + * [Githubの使い方](ja/getting_started_github.md) + * [ヘルプ](ja/getting_started_getting_help.md) + +* [破壊的な変更](ja/breaking_changes.md) + * [2019年8月30日](ja/ChangeLog/20190830.md) + +* [FAQ](ja/faq.md) + * [一般的なFAQ](ja/faq_general.md) + * [QMKのビルド/コンパイル](ja/faq_build.md) + * [QMKのデバッグ/トラブルシューティング](ja/faq_debug.md) + * [キーマップ](ja/faq_keymap.md) + * [Zadigを使ったドライバのインストール](ja/driver_installation_zadig.md) + +* 詳細なガイド + * [ビルドツールのインストール](ja/getting_started_build_tools.md) + * [Vagrantのガイド](ja/getting_started_vagrant.md) + * [ビルド/コンパイルの説明](ja/getting_started_make_guide.md) + * [ファームウェアのフラッシュ](ja/flashing.md) + * [機能のカスタマイズ](ja/custom_quantum_functions.md) + * [キーマップの概要](ja/keymap.md) + +* [ハードウェア](ja/hardware.md) + * [AVR プロセッサ](ja/hardware_avr.md) + * [ドライバ](ja/hardware_drivers.md) + +* リファレンス + * [キーボード ガイドライン](ja/hardware_keyboard_guidelines.md) + * [設定オプション](ja/config_options.md) + * [キーコード](ja/keycodes.md) + * [コーディング規約 - C](ja/coding_conventions_c.md) + * [コーディング規約 - Python](ja/coding_conventions_python.md) + * [ドキュメント ベストプラクティス](ja/documentation_best_practices.md) + * [ドキュメント テンプレート](ja/documentation_templates.md) + * [用語](ja/reference_glossary.md) + * [ユニットテスト](ja/unit_testing.md) + * [便利な関数](ja/ref_functions.md) + * [Configurator サポート](ja/reference_configurator_support.md) + * [info.json 形式](ja/reference_info_json.md) + * [Python CLI 開発](ja/cli_development.md) + +* [機能](ja/features.md) + * [基本的なキーコード](ja/keycodes_basic.md) + * [US ANSI シフトキー](ja/keycodes_us_ansi_shifted.md) + * [Quantum キーコード](ja/quantum_keycodes.md) + * [Advanced キーコード](ja/feature_advanced_keycodes.md) + * [オーディオ](ja/feature_audio.md) + * [自動シフト](ja/feature_auto_shift.md) + * [バックライト](ja/feature_backlight.md) + * [ブルートゥース](ja/feature_bluetooth.md) + * [ブートマジック](ja/feature_bootmagic.md) + * [コンボ](ja/feature_combo.md) + * [コマンド](ja/feature_command.md) + * [Debounce API](ja/feature_debounce_type.md) + * [DIP スイッチ](ja/feature_dip_switch.md) + * [動的マクロ](ja/feature_dynamic_macros.md) + * [エンコーダ](ja/feature_encoders.md) + * [グレイブ エスケープ](ja/feature_grave_esc.md) + * [触覚フィードバック](ja/feature_haptic_feedback.md) + * [HD44780 LCD コントローラ](ja/feature_hd44780.md) + * [キーロック](ja/feature_key_lock.md) + * [レイアウト](ja/feature_layouts.md) + * [リーダー キー](ja/feature_leader_key.md) + * [LED マトリクス](ja/feature_led_matrix.md) + * [マクロ](ja/feature_macros.md) + * [マウスキー](ja/feature_mouse_keys.md) + * [OLED ドライバ](ja/feature_oled_driver.md) + * [One Shot Keys](ja/feature_advanced_keycodes.md#one-shot-keys) + * [ポインティング デバイス](ja/feature_pointing_device.md) + * [PS/2 マウス](ja/feature_ps2_mouse.md) + * [RGB ライト](ja/feature_rgblight.md) + * [RGB マトリクス](ja/feature_rgb_matrix.md) + * [Space Cadet](ja/feature_space_cadet.md) + * [分割キーボード](ja/feature_split_keyboard.md) + * [Stenography](ja/feature_stenography.md) + * [Swap Hands](ja/feature_swap_hands.md) + * [タップ ダンス](ja/feature_tap_dance.md) + * [Terminal](ja/feature_terminal.md) + * [感熱式プリンタ](ja/feature_thermal_printer.md) + * [ユニコード](ja/feature_unicode.md) + * [Userspace](ja/feature_userspace.md) + * [Velocikey](ja/feature_velocikey.md) + +* メーカーおよびモッダーのために + * [Hand Wiring Guide](ja/hand_wire.md) + * [ISP Flashing Guide](ja/isp_flashing_guide.md) + * [ARM デバッグ ガイド](ja/arm_debugging.md) + * [I2C ドライバ](ja/i2c_driver.md) + * [GPIO コントロール](ja/internals_gpio_control.md) + * [Proton C 規約](ja/proton_c_conversion.md) + +* より深く知るために + * [キーボードがどのように動作するか](ja/how_keyboards_work.md) + * [QMKの理解](ja/understanding_qmk.md) + +* 他の話題 + * [EclipseでQMKを使用](ja/other_eclipse.md) + * [VSCodeでQMKを使用](ja/other_vscode.md) + * [サポート](ja/support.md) + * [翻訳を追加する方法](ja/translating.md) + +* QMK の内部詳細(作成中) + * [定義](ja/internals_defines.md) + * [Input Callback Reg](ja/internals_input_callback_reg.md) + * [Midi ドライバ](ja/internals_midi_device.md) + * [Midi デバイスのセットアップ手順](ja/internals_midi_device_setup_process.md) + * [Midi ユーティリティ](ja/internals_midi_util.md) + * [Send Functions](ja/internals_send_functions.md) + * [Sysex Tools](ja/internals_sysex_tools.md) diff --git a/docs/ja/newbs.md b/docs/ja/newbs.md index d1043a4a16..54189cce48 100644 --- a/docs/ja/newbs.md +++ b/docs/ja/newbs.md @@ -19,18 +19,18 @@ QMK は[多くの趣味のキーボード](http://qmk.fm/keyboards/)をサポー このガイドには7つの主要なセクションがあります。 -* [はじめに](newbs_getting_started.md) -* [コマンドラインを使用して初めてのファームウェアを構築する](newbs_building_firmware.md) -* [オンライン GUI を使用して初めてのファームウェアを構築する](newbs_building_firmware_configurator.md) -* [ファームウェアを書きこむ](newbs_flashing.md) -* [テストとデバッグ](newbs_testing_debugging.md) -* [QMK における Git 運用作法](newbs_best_practices.md) -* [さらに学ぶための学習リソース](newbs_learn_more_resources.md) +* [はじめに](ja/newbs_getting_started.md) +* [コマンドラインを使用して初めてのファームウェアを構築する](ja/newbs_building_firmware.md) +* [オンライン GUI を使用して初めてのファームウェアを構築する](ja/newbs_building_firmware_configurator.md) +* [ファームウェアを書きこむ](ja/newbs_flashing.md) +* [テストとデバッグ](ja/newbs_testing_debugging.md) +* [QMK における Git 運用作法](ja/newbs_best_practices.md) +* [さらに学ぶための学習リソース](ja/newbs_learn_more_resources.md) このガイドは、これまでソフトウェアをコンパイルしたことがない人を支援することに特化しています。 その観点から選択と推奨を行います。 これらの手順の多くには代替方法があり、これらの代替方法のほとんどをサポートしています。 -タスクを達成する方法について疑問がある場合は、[案内を求めることができます](getting_started_getting_help.md)。 +タスクを達成する方法について疑問がある場合は、[案内を求めることができます](ja/getting_started_getting_help.md)。 ## 追加のリソース(英語) diff --git a/docs/ja/newbs_best_practices.md b/docs/ja/newbs_best_practices.md index 2e90ffcabe..3c87d53d46 100644 --- a/docs/ja/newbs_best_practices.md +++ b/docs/ja/newbs_best_practices.md @@ -24,8 +24,8 @@ QMK に貢献するプロセスを順を追って説明し、この作業を簡 -1. あなたは GitHub アカウントがあり、アカウントに [qmk_firmware リポジトリをフォーク](getting_started_github.md) している。 -2. あなたは、[環境構築](newbs_getting_started.md#環境構築) と [QMK の設定](newbs_getting_started.md#qmk-の設定) を両方とも完了している。 +1. あなたは GitHub アカウントがあり、アカウントに [qmk_firmware リポジトリをフォーク](ja/getting_started_github.md) している。 +2. あなたは、[環境構築](ja/newbs_getting_started.md#set-up-your-environment) と [QMK の設定](ja/newbs_getting_started.md#set-up-qmk) を両方とも完了している。 ## あなたのフォークの master ブランチ: 更新は頻繁に、コミットはしないこと diff --git a/docs/ja/newbs_building_firmware.md b/docs/ja/newbs_building_firmware.md index 5fb10d4243..f9a847f4d2 100644 --- a/docs/ja/newbs_building_firmware.md +++ b/docs/ja/newbs_building_firmware.md @@ -67,9 +67,9 @@ macOS または Windows を使用している場合は、キーマップフォ あるレイヤー全体が必要ない場合はレイヤーを削除することもでき、必要があれば、合計 32 個までレイヤーを追加することもできます。 ここで定義できる内容については、次のドキュメントを参照してください。 -* [キーコード](keycodes.md) -* [機能](features.md) -* [FAQ](faq.md) +* [キーコード](ja/keycodes.md) +* [機能](ja/features.md) +* [FAQ](ja/faq.md) ?> キーマップがどのように機能するかを感じながら、各変更を小さくしてください。大きな変更は、発生する問題のデバッグを困難にします。 @@ -96,4 +96,4 @@ Checking file size of planck_rev5_xyverz.hex ## ファームウェアを書きこむ -[「ファームウェアを書きこむ」](newbs_flashing.md) に移動して、キーボードに新しいファームウェアを書き込む方法を学習します。 +[「ファームウェアを書きこむ」](ja/newbs_flashing.md) に移動して、キーボードに新しいファームウェアを書き込む方法を学習します。 diff --git a/docs/ja/newbs_building_firmware_configurator.md b/docs/ja/newbs_building_firmware_configurator.md index b44504ade4..228269b34e 100644 --- a/docs/ja/newbs_building_firmware_configurator.md +++ b/docs/ja/newbs_building_firmware_configurator.md @@ -83,7 +83,7 @@ QMK Configurator は Chrome/Firefox で最適に動作します。 ## キーボードに書き込む(フラッシュする) -[ファームウェアを書きこむ](newbs_flashing.md) を参照してください。 +[ファームウェアを書きこむ](ja/newbs_flashing.md) を参照してください。 ## トラブルシューティング diff --git a/docs/ja/newbs_flashing.md b/docs/ja/newbs_flashing.md index 0c85514cf5..3407b46253 100644 --- a/docs/ja/newbs_flashing.md +++ b/docs/ja/newbs_flashing.md @@ -13,7 +13,7 @@ キーボードに書き込む最も簡単な方法は [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) を使うことです。 ただし、QMK Toolbox は、現在は Windows と macOS でしか使えません。 -Linuxを使用している場合(および、コマンドラインでファームウェアを書き込みたい場合)は、下の方で概説する[方法](newbs_flashing.md#コマンドラインでファームウェアを書き込む)で行なう必要があります。 +Linuxを使用している場合(および、コマンドラインでファームウェアを書き込みたい場合)は、下の方で概説する[方法](ja/newbs_flashing.md#flash-your-keyboard-from-the-command-line)で行なう必要があります。 ### QMK Toolbox にファイルをロードする @@ -98,7 +98,7 @@ QMK Toolbox の `Flash` ボタンをクリックします。 *** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390 ``` -## コマンドラインでファームウェアを書き込む +## コマンドラインでファームウェアを書き込む :id=flash-your-keyboard-from-the-command-line これは、以前のものと比較して非常に単純になりました。 ファームウェアをコンパイルして書き込む準備ができたら、ターミナルウィンドウを開いてビルドコマンドを実行します。 @@ -123,7 +123,7 @@ QMK Toolbox の `Flash` ボタンをクリックします。 ブートローダは主に 5 種類のものが使われています。 Pro Micro とそのクローンは Caterina を、Teensy は HalfKay を、OLKBの AVR ボードは QMK-DFU を、その他の ATmega32U4 ボードは DFU を、そして多くの ARM ボードは ARM DFU を使います。 -より詳しいブートローダの情報は、[Flashing Instructions and Bootloader Information](flashing.md) にあります。 +より詳しいブートローダの情報は、[Flashing Instructions and Bootloader Information](ja/flashing.md) にあります。 使用しているブートローダがわかっているならば、ファームウェアをコンパイルするときに、実は `make` コマンドにブートローダを指定するテキストを追加して、書き込みプロセスを自動化できます。 @@ -172,7 +172,7 @@ Checking file size of planck_rev5_xyverz.hex >>> dfu-programmer atmega32u4 reset ``` -?> `dfu-programmer：no device present` など、これに関する問題がある場合は、[よくある質問](faq_build.md) を参照してください。 +?> `dfu-programmer：no device present` など、これに関する問題がある場合は、[よくある質問](ja/faq_build.md) を参照してください。 #### DFU コマンド @@ -397,4 +397,4 @@ Uploading 22016 (0x5600) bytes starting at 0 (0x0) おめでとうございます！ カスタムファームウェアがキーボードにプログラムされました！ 使ってみて、すべてがあなたの望むように動作するかどうか確認してください。 -この初心者ガイドを完全なものにするために [テストとデバッグ](newbs_testing_debugging.md) を書いたので、カスタム機能のトラブルシューティング方法については、こちらをご覧ください。 +この初心者ガイドを完全なものにするために [テストとデバッグ](ja/newbs_testing_debugging.md) を書いたので、カスタム機能のトラブルシューティング方法については、こちらをご覧ください。 diff --git a/docs/ja/newbs_getting_started.md b/docs/ja/newbs_getting_started.md index a57e6e054b..865ed162a7 100644 --- a/docs/ja/newbs_getting_started.md +++ b/docs/ja/newbs_getting_started.md @@ -20,7 +20,7 @@ QMK は、簡単なことは簡単に、そして、難しいことを可能な ファームウェアをコンパイルするキーボードの数に関わらず、この作業を一度だけ実行する必要があります。 もし、GUI で作業をしたい場合、オンラインで作業できる [QMK Configurator](https://config.qmk.fm) を使ってください。 -使い方は [Building Your First Firmware using the online GUI](newbs_building_firmware_configurator.md) を参照してください。 +使い方は [オンライン GUI を使用して初めてのファームウェアを構築する](ja/newbs_building_firmware_configurator.md) を参照してください。 ## ソフトウェアのダウンロード @@ -45,7 +45,7 @@ QMK Toolbox は、Windows と macOS で使える GUI を備えたプログラム * Windows 版: `qmk_toolbox.exe` (portable) または `qmk_toolbox_install.exe` (installer) * macOS 版: `QMK.Toolbox.app.zip` (portable) または `QMK.Toolbox.pkg` (installer) -## 環境構築 +## 環境構築 :id=set-up-your-environment 私たちは、QMK を可能な限り簡単に構築できるように努力しています。 Linux か Unix 環境を用意するだけで、QMK に残りをインストールさせることができます。 @@ -77,9 +77,9 @@ Git のインストールが必要です。既にインストールされてい * Fedora / Red Hat / CentOS: `yum install git` * Arch: `pacman -S git` -?> 全てのプラットフォームにおいて、Docker を使うことも可能です。[詳細はこちらをクリックしてください](getting_started_build_tools.md#docker)。 +?> 全てのプラットフォームにおいて、Docker を使うことも可能です。[詳細はこちらをクリックしてください](ja/getting_started_build_tools.md#docker)。 -## QMK の設定 +## QMK の設定 :id=set-up-qmk Linux/Unix 環境が準備できたら QMK のダウンロードの準備は完了です。Git を使用して QMK のリポジトリを「クローン」することで QMK をダウンロードします。ターミナルか MSYS2 MinGW ウィンドウを開いて、このガイドの残りの部分では開いたままにします。そのウィンドウ内で、次の2つのコマンドを実行します。 @@ -88,7 +88,7 @@ git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git cd qmk_firmware ``` -?> 既に [GitHub の使いかた](getting_started_github.md)を知っているなら、clone ではなく fork を勧めます。この一文の意味が分からない場合、このメッセージは無視してかまいません。 +?> 既に [GitHub の使いかた](ja/getting_started_github.md)を知っているなら、clone ではなく fork を勧めます。この一文の意味が分からない場合、このメッセージは無視してかまいません。 QMK には、必要な残りの設定を手助けするスクリプトが含まれています。 セットアップ作業を完了させるため、次のコマンドを実行します。 @@ -119,4 +119,4 @@ Checking file size of clueboard_66_rev3_default.hex # キーマップの作成 これであなた専用のキーマップを作成する準備ができました！ -次は [Building Your First Firmware](newbs_building_firmware.md) で専用のキーマップを作成します。 +次は [Building Your First Firmware](ja/newbs_building_firmware.md) で専用のキーマップを作成します。 diff --git a/docs/ja/newbs_learn_more_resources.md b/docs/ja/newbs_learn_more_resources.md index 632cd9100a..14feb61b32 100644 --- a/docs/ja/newbs_learn_more_resources.md +++ b/docs/ja/newbs_learn_more_resources.md @@ -14,8 +14,8 @@ * [Great General Tutorial](https://www.codecademy.com/learn/learn-git) * [Git Game To Learn From Examples](https://learngitbranching.js.org/) -* [Git Resources to Learn More About Github](getting_started_github.md) -* [Git Resources Aimed Specifically toward QMK](contributing.md) +* [Git Resources to Learn More About Github](ja/getting_started_github.md) +* [Git Resources Aimed Specifically toward QMK](ja/contributing.md) ### 日本語 diff --git a/docs/ja/newbs_testing_debugging.md b/docs/ja/newbs_testing_debugging.md index a96406187b..9cf5c65200 100644 --- a/docs/ja/newbs_testing_debugging.md +++ b/docs/ja/newbs_testing_debugging.md @@ -22,7 +22,7 @@ ## デバッグ -`rules.mk`へ`CONSOLE_ENABLE = yes`の設定をするとキーボードはデバッグ情報を出力します。デフォルトの出力は非常に限られたものですが、デバッグモードをオンにすることでデバッグ情報の量を増やすことが出来ます。キーマップの`DEBUG`キーコードを使用するか、デバッグモードを有効にする [Command](feature_command.md) 機能を使用するか、以下のコードをキーマップに追加します。 +`rules.mk`へ`CONSOLE_ENABLE = yes`の設定をするとキーボードはデバッグ情報を出力します。デフォルトの出力は非常に限られたものですが、デバッグモードをオンにすることでデバッグ情報の量を増やすことが出来ます。キーマップの`DEBUG`キーコードを使用するか、デバッグモードを有効にする [Command](ja/feature_command.md) 機能を使用するか、以下のコードをキーマップに追加します。 ```c void keyboard_post_init_user(void) { @@ -46,7 +46,7 @@ void keyboard_post_init_user(void) { ## 独自のデバッグメッセージを送信する -[custom code](custom_quantum_functions.md)内からデバッグメッセージを出力すると便利な場合があります。それはとても簡単です。ファイルの先頭に`print.h`のインクルードを追加します: +[custom code](ja/custom_quantum_functions.md)内からデバッグメッセージを出力すると便利な場合があります。それはとても簡単です。ファイルの先頭に`print.h`のインクルードを追加します: #include @@ -59,7 +59,7 @@ void keyboard_post_init_user(void) { ## デバッグの例 -以下は現実世界での実際のデバッグ手法の例を集めたものです。追加情報は[Debugging/Troubleshooting QMK](faq_debug.md)を参照してください。 +以下は現実世界での実際のデバッグ手法の例を集めたものです。追加情報は[Debugging/Troubleshooting QMK](ja/faq_debug.md)を参照してください。 ### マトリックス上のどの場所でキー押下が起こったか？