diff options
author | umi <57262844+umi-umi@users.noreply.github.com> | 2020-09-04 03:25:21 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-04 03:25:21 +0900 |
commit | 9b9587527f7b0db1613b0c71c9f5b1f7b4109a23 (patch) | |
tree | 98614912c62d4f34ca32035d8baace5fd29c65b2 /docs/ja/reference_info_json.md | |
parent | c1a6b5f430a46206ce98a3c52284725e80322a98 (diff) | |
download | qmk_firmware-9b9587527f7b0db1613b0c71c9f5b1f7b4109a23.tar.gz qmk_firmware-9b9587527f7b0db1613b0c71c9f5b1f7b4109a23.zip |
[Docs] Japanese translation of docs/reference_info_json.md (#9881)
* add reference_info_json.md translation
* update based on comment
* update based on comment
Diffstat (limited to 'docs/ja/reference_info_json.md')
-rw-r--r-- | docs/ja/reference_info_json.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/ja/reference_info_json.md b/docs/ja/reference_info_json.md new file mode 100644 index 000000000..708f7c19a --- /dev/null +++ b/docs/ja/reference_info_json.md | |||
@@ -0,0 +1,78 @@ | |||
1 | # `info.json` | ||
2 | |||
3 | <!--- | ||
4 | original document: 0.9.46:docs/reference_info_json.md | ||
5 | git diff 0.9.46 HEAD -- docs/reference_info_json.md | cat | ||
6 | --> | ||
7 | |||
8 | このファイルは [QMK API](https://github.com/qmk/qmk_api) によって使われます。このファイルは [QMK Configurator](https://config.qmk.fm/) がキーボードの画像を表示するために必要な情報を含んでいます。ここにメタデータを設定することもできます。 | ||
9 | |||
10 | このメタデータを指定するために、`qmk_firmware/keyboards/<name>` の下の全てのレベルで `info.json` を作成することができます。これらのファイルは結合され、より具体的なファイルがそうではないファイルのキーを上書きします。つまり、メタデータ情報を複製する必要はありません。例えば、`qmk_firmware/keyboards/clueboard/info.json` は `manufacturer` および `maintainer` を指定し、`qmk_firmware/keyboards/clueboard/66/info.json` は Clueboard 66% についてのより具体的な情報を指定します。 | ||
11 | |||
12 | ## `info.json` の形式 | ||
13 | |||
14 | `info.json` ファイルは設定可能な以下のキーを持つ JSON 形式の辞書です。全てを設定する必要はなく、キーボードに適用するキーだけを設定します。 | ||
15 | |||
16 | * `keyboard_name` | ||
17 | * キーボードを説明する自由形式のテキスト文字列。 | ||
18 | * 例: `Clueboard 66%` | ||
19 | * `url` | ||
20 | * キーボードの製品ページ、[QMK.fm/keyboards](https://qmk.fm/keyboards) のページ、あるいはキーボードに関する情報を説明する他のページの URL。 | ||
21 | * `maintainer` | ||
22 | * メンテナの GitHub のユーザ名、あるいはコミュニティが管理するキーボードの場合は `qmk` | ||
23 | * `width` | ||
24 | * キー単位でのキーボードの幅 | ||
25 | * `height` | ||
26 | * キー単位でのキーボードの高さ | ||
27 | * `layouts` | ||
28 | * 物理的なレイアウト表現。詳細は以下のセクションを見てください。 | ||
29 | |||
30 | ### レイアウトの形式 | ||
31 | |||
32 | `info.json` ファイル内の辞書の `layouts` 部分は、幾つかの入れ子になった辞書を含みます。外側のレイヤーは QMK レイアウトマクロで構成されます。例えば、`LAYOUT_ansi` あるいは `LAYOUT_iso`。各レイアウトマクロ内には、`width`、 `height`、`key_count` のキーがあります。これらは自明でなければなりません。 | ||
33 | |||
34 | * `width` | ||
35 | * オプション: キー単位でのレイアウトの幅 | ||
36 | * `height` | ||
37 | * オプション: キー単位でのレイアウトの高さ | ||
38 | * `key_count` | ||
39 | * **必須**: このレイアウトのキーの数 | ||
40 | * `layout` | ||
41 | * 物理レイアウトを説明するキー辞書のリスト。詳細は次のセクションを見てください。 | ||
42 | |||
43 | ### キー辞書形式 | ||
44 | |||
45 | レイアウトの各キー辞書は、キーの物理プロパティを記述します。<http://keyboard-layout-editor.com> の Raw Code に精通している場合、多くの概念が同じであることが分かります。可能な限り同じキー名とレイアウトの選択を再利用しますが、keyboard-layout-editor とは異なって各キーはステートレスで、前のキーからプロパティを継承しません。 | ||
46 | |||
47 | 全てのキーの位置と回転は、キーボードの左上と、各キーの左上を基準にして指定されます。 | ||
48 | |||
49 | * `x` | ||
50 | * **必須**: 水平軸でのキーの絶対位置(キー単位)。 | ||
51 | * `y` | ||
52 | * **必須**: 垂直軸でのキーの絶対位置(キー単位)。 | ||
53 | * `w` | ||
54 | * キー単位でのキーの幅。`ks` が指定された場合は無視されます。デフォルト: `1` | ||
55 | * `h` | ||
56 | * キー単位でのキーの高さ。`ks` が指定された場合は無視されます。デフォルト: `1` | ||
57 | * `r` | ||
58 | * キーを回転させる時計回りの角度。 | ||
59 | * `rx` | ||
60 | * キーを回転させる点の水平軸における絶対位置。デフォルト: `x` | ||
61 | * `ry` | ||
62 | * キーを回転させる点の垂直軸における絶対位置。デフォルト: `y` | ||
63 | * `ks` | ||
64 | * キー形状: キー単位で頂点を列挙することでポリゴンを定義します。 | ||
65 | * **重要**: これらはキーの左上からの相対位置で、絶対位置ではありません。 | ||
66 | * ISO Enter の例: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]` | ||
67 | * `label` | ||
68 | * マトリックス内のこの位置につける名前。 | ||
69 | * これは通常 PCB 上でこの位置にシルクスクリーン印刷されるものと同じ名前でなければなりません。 | ||
70 | |||
71 | ## メタデータはどのように公開されますか? | ||
72 | |||
73 | このメタデータは主に2つの方法で使われます: | ||
74 | |||
75 | * Web ベースの configurator が動的に UI を生成できるようにする。 | ||
76 | * 新しい `make keyboard:keymap:qmk` ターゲットをサポートする。これは、このメタデータをファームウェアにバンドルして QMK Toolbox をよりスマートにします。 | ||
77 | |||
78 | Configurator の作成者は、JSON API の使用に関する詳細について、[QMK Compiler](https://docs.api.qmk.fm/using-the-api) ドキュメントを参照することができます。 | ||