aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/reference_info_json.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/reference_info_json.md')
-rw-r--r--docs/ja/reference_info_json.md68
1 files changed, 68 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..e6a71adc9
--- /dev/null
+++ b/docs/ja/reference_info_json.md
@@ -0,0 +1,68 @@
1# `info.json`
2
3<!---
4 original document: 0.10.33:docs/reference_info_json.md
5 git diff 0.10.33 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* `layouts`
24 * 物理的なレイアウト表現。詳細は以下のセクションを見てください。
25
26### レイアウトの形式
27
28`info.json` ファイル内の辞書の `layouts` 部分は、幾つかの入れ子になった辞書を含みます。外側のレイヤーは QMK レイアウトマクロで構成されます。例えば、`LAYOUT_ansi` あるいは `LAYOUT_iso`。
29
30* `layout`
31 * 物理レイアウトを説明するキー辞書のリスト。詳細は次のセクションを見てください。
32
33### キー辞書形式
34
35レイアウトの各キー辞書は、キーの物理プロパティを記述します。<https://keyboard-layout-editor.com> の Raw Code に精通している場合、多くの概念が同じであることが分かります。可能な限り同じキー名とレイアウトの選択を再利用しますが、keyboard-layout-editor とは異なって各キーはステートレスで、前のキーからプロパティを継承しません。
36
37全てのキーの位置と回転は、キーボードの左上と、各キーの左上を基準にして指定されます。
38
39* `x`
40 * **必須**: 水平軸でのキーの絶対位置(キー単位)。
41* `y`
42 * **必須**: 垂直軸でのキーの絶対位置(キー単位)。
43* `w`
44 * キー単位でのキーの幅。`ks` が指定された場合は無視されます。デフォルト: `1`
45* `h`
46 * キー単位でのキーの高さ。`ks` が指定された場合は無視されます。デフォルト: `1`
47* `r`
48 * キーを回転させる時計回りの角度。
49* `rx`
50 * キーを回転させる点の水平軸における絶対位置。デフォルト: `x`
51* `ry`
52 * キーを回転させる点の垂直軸における絶対位置。デフォルト: `y`
53* `ks`
54 * キー形状: キー単位で頂点を列挙することでポリゴンを定義します。
55 * **重要**: これらはキーの左上からの相対位置で、絶対位置ではありません。
56 * ISO Enter の例: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]`
57* `label`
58 * マトリックス内のこの位置につける名前。
59 * これは通常 PCB 上でこの位置にシルクスクリーン印刷されるものと同じ名前でなければなりません。
60
61## メタデータはどのように公開されますか?
62
63このメタデータは主に2つの方法で使われます:
64
65* Web ベースの configurator が動的に UI を生成できるようにする。
66* 新しい `make keyboard:keymap:qmk` ターゲットをサポートする。これは、このメタデータをファームウェアにバンドルして QMK Toolbox をよりスマートにします。
67
68Configurator の作成者は、JSON API の使用に関する詳細について、[QMK Compiler](https://docs.api.qmk.fm/using-the-api) ドキュメントを参照することができます。