Meta は世界についての内容ではなく、ドキュメントについてのレコードである。ドキュメント構造レコード(DOC・BODY・END)を除き、すべてドキュメントの HEAD に置く。HEAD には Meta のほかに、ドキュメント全体の根拠 Edge SOURCEとその QUALIFIER も来る。
レイアウト
TAG WORD 000K KKKC CCCC LLLL セクション 14・15 (0x1C0L~0x1FFL)
[Length 拡張 TAG]
Payload 生値、または埋め込み Value・Reference レコード
- Meta には Issuer 形式がない。Meta はすべての Issuer が従う共通規格であり、GEUL のみが定義する。
LLLLは TAG WORD を含む全体の WORD 数 − 1 である。表にない Codec は Reserved である。
Payload 形式
| 形式 | いつ | 例 |
|---|---|---|
| 生値 | 形式が 1 つに定まるとき。他のレコード Codec に依存しない | DOC-* の長さ、SPEC-VERSION、ISSUER-KEY |
| 埋め込み Value | 複数の形式から選ぶとき。Value TAG が形式を知らせる | PROFILE、EFFECTIVE-*、時刻、コンテンツハッシュ |
| 埋め込み Reference | 人・組織・ツール・ドキュメントのような対象を指すとき | DOC-ID、AUTHOR、CO-AUTHOR、RECORDED-BY、SIGNED-OFF、SIGNATURE の署名者 |
| なし | 1 WORD のマーカー | BODY、END |
- 埋め込みレコードは独立したレコードではなく、その Meta に属する。それぞれが Length で境界を見つけ、最後のレコードを読み終えた位置が Meta の末尾とちょうど一致しなければならない。
- 1 つのドキュメントに 1 つだけ置ける Meta と複数置ける Meta は、各 Codec ドキュメントの「個数」が定める。
クラス
Meta の番号は 0x1C0L から Reserved なしで続く。番号のビットはクラスを表さない。クラスは下の区間表で知る。
| クラス | 直接コード | 扱うもの |
|---|---|---|
| 構造 | 0x1C0L~0x1C4L | ドキュメントの境界と長さ |
| 定義 | 0x1C5L~0x1CAL | 解釈の宣言 |
| 出典 | 0x1CBL~0x1D0L | 誰が、いつ、どこで |
| 系譜 | 0x1D1L~0x1DDL | 何からどのようにして生まれたか |
| ポリシー | 0x1DEL~0x1E3L | どのように取り扱うか |
| IMPORT | 0x1E4L | 外部ドキュメントを取り込む |
| 検証 | 0x1E5L~0x1E9L | 信頼できるか |
| Reserved(検証専用) | 0x1EAL~0x1FFL |
- 検証クラスは、セクション 15 で
C >= 5、すなわちw >= 0x1E50のレコードである。Codec ブックなしでこれにより検証クラスを知り、コンテンツハッシュから除く。 - 後ろの Reserved
0x1EAL~0x1FFLは検証専用である。検証以外の新しい Meta は検証より前に入れられず、後ろの Reserved に置くとコンテンツハッシュから除かれる。 - 構造・定義・IMPORT クラスはビットで読まない。デコーダは組み込みの番号表で知る。
- 解釈に必要な Meta: 構造、定義、IMPORT。消すとレコードを読めなくなるか、解釈が変わる。すべてのデコーダが処理しなければならない。これらの Codec は GEUL コア Codec ブックに属する。
- 解釈を変えない Meta: 出典、系譜、検証、ポリシー。消しても叙述の内容はそのままである。信頼判断と取り扱いの材料だけが失われる。
- 根拠は Meta ではなく根拠 Edge SOURCEと QUALIFIER で書く。個別レコードの根拠は BODY に、ドキュメント全体の原典は HEAD に Target
0の SOURCE として置く(ドキュメント)。
構造
Meta の構造クラス(Codec 0x1C0L~0x1C4L)は、ドキュメントの境界と長さを定める。GEUL データの単位はドキュメント 1 つである。
DOC-* ← HEAD 開始
定義・出典・系譜・検証・ポリシー・IMPORT Meta
ドキュメント全体の SOURCE とその QUALIFIER
BODY ← BODY 開始
Reference, Value, Edge
END ← ドキュメントを閉じる
- すべてのドキュメントは
DOC-1WORD/2WORD/4WORDで全体の長さを指定して開く。デコーダはこの長さでドキュメント全体を一度に読み飛ばせる。 BODYとENDは Payload のない 1 WORD レコードである。ENDは必須である。- ドキュメントは入れ子にしない。他のドキュメントは IMPORT で指す。
- HEAD(Meta、ドキュメント全体の SOURCE とその QUALIFIER)が空なら
BODYを省略する。BODYはドキュメントごとに 1 回だけ置ける。
ドキュメント構造の全体はドキュメントにある。
| Codec | 名前 | 意味 |
|---|---|---|
0x1C0L~0x1C2L | DOC-1WORD / 2WORD / 4WORD | 全体の長さを指定してドキュメントを開く |
0x1C3L | BODY | HEAD を終えて BODY を開く |
0x1C4L | END | ドキュメントを閉じる |
詳しい規則はドキュメントにある。
定義
Meta の定義クラス(Codec 0x1C5L~0x1CAL)は解釈の宣言である。宣言は解釈規則を変えるので、すべてのデコーダが処理しなければならない。宣言の範囲はそのドキュメントである。
SPEC-VERSIONは残りのレコードをどう読むかを定めるので、埋め込み Value なしで整数のみを置く。GEUL v1 は0x0001(レコード1C51 0001)である。DOC-IDは、そのドキュメント自身を指すDOC-POINTER(Issuer、ドキュメント ID、バージョン0)である。Codec ドキュメントはCODEC-POINTER(Issuer、Codec ID、バージョン0)である。なければ名前のないドキュメントであり、コンテンツハッシュでのみ指せる。- ドキュメント名のアドレスはない。人が読むタイトルは叙述
LABELで付ける(公表アドレスとバージョン一覧)。
| Codec | 名前 | 意味 |
|---|---|---|
0x1C5L | SPEC-VERSION | 従う仕様の版。整数 1 つ |
0x1C6L | PROFILE | 適用プロファイル |
0x1C7L | DOC-ID | このドキュメントの識別子。自分自身を指す DOC-POINTER(バージョン 0)。Codec ドキュメントは CODEC-POINTER(バージョン 0) |
0x1C8L | EFFECTIVE-FROM | このバージョンの施行日。なければ公表時刻 |
0x1C9L | EFFECTIVE-UNTIL | このバージョンの有効期間の終わり(限時法)。なければ次のバージョンが施行されるまで |
0x1CAL | DEFAULT-LANGUAGE | 既定言語 |
- ドキュメント名のアドレスはない(公表アドレスとバージョン一覧)。人が読むタイトルは BODY の LABEL で付ける。
出典
Meta の出典クラス(Codec 0x1CBL~0x1D0L)は、ドキュメントを誰が、いつ作成し記録したかを記す。
- 作成者・記録者とその時刻は、git の author・committer モデルに従う(
AUTHOR・CREATED-AT、RECORDED-BY・RECORDED-AT)。 - 出典は消しても叙述の内容は変わらない。信頼判断の材料だけが失われる。
- 原典資料はこのクラスにない。ドキュメント全体の原典は HEAD に、個別レコードの原典は BODY に、根拠 Edge SOURCEとして書く。原文内の対応範囲、取得時刻、原文ハッシュは、その SOURCE に付く QUALIFIER である(ページ P304・節 P958、参照日 P813、チェックサム P4092)。
- 原典に付随する性質(原文の範囲、取得時刻)を Meta に置くと、原典が複数ある場合にどの原典のものか定められない。そのため SOURCE を Target とする QUALIFIER で書く。
| Codec | 名前 | 意味 |
|---|---|---|
0x1CBL | AUTHOR | 作成者 (Reference) |
0x1CCL | CO-AUTHOR | 共同作成者 |
0x1CDL | CREATED-AT | 作成時刻 |
0x1CEL | MODIFIED-AT | 修正時刻 |
0x1CFL | RECORDED-BY | 記録した主体 |
0x1D0L | RECORDED-AT | 記録した時刻 |
- 原典資料は Meta ではなく、HEAD の根拠 Edge SOURCE(Target
0)で書き、原文の範囲・取得時刻・原文ハッシュは、その SOURCE に付く QUALIFIER で書く。
系譜
Meta の系譜クラス(Codec 0x1D1L~0x1DDL)は、ドキュメントが何からどのようにして生まれたかを記す。系譜は git のコミットモデルに従い、コミットに当たる単位がドキュメントである。
- コンテンツハッシュはドキュメント一式の内容を指す(git commit id)。開くレコード(
DOC-*)からENDの直前までの SHA-256 であり、検証クラス(セクション 15 のC >= 5、w >= 0x1E50)のレコードは計算から除く。 - バージョン ID は、名前のあるドキュメントの中で公表順に 1 から振る 2 WORD の整数である。
0はバージョンを記していないという意味である。 - 系譜 Meta はコンテンツハッシュでバージョンを指す。ドキュメント内の
PARENTもハッシュに入るので、コンテンツハッシュは履歴全体をつなぐハッシュチェーンになる。 - 履歴は消さない。直した内容は新しいバージョンとして出す。branch のように変わるポインタはドキュメントに置かない。
DELTA-BASE・DELTA-REMOVEは、バージョンを基準バージョンに対する diff として保存する形式である。バージョンは常にスナップショットとして定義する。
改訂規則はドキュメントにある。
系譜は git のコミットモデルに従う。コミットに当たる単位がドキュメントである。
| Codec | 名前 | 意味 |
|---|---|---|
0x1D1L | PARENT | 直前のバージョンのコンテンツハッシュ。複数ならマージ |
0x1D2L | DERIVED-FROM | 別の系譜の資料から派生 |
0x1D3L | GENERATED-BY | 生成主体(人、モデル、ルールエンジン) |
0x1D4L | TRANSFORMED-BY | 変換ツールとそのソースバージョン(コミットダイジェスト) |
0x1D5L | CHERRY-PICKED-FROM | 取り込んだ変更の元のバージョン |
0x1D6L | REVERTS | 元に戻した対象バージョン |
0x1D7L | REPLACES | 書き直した対象バージョン。元のバージョンは消さない |
0x1D8L | SQUASHED-FROM | 一つにまとめた元のバージョン群 |
0x1D9L | MESSAGE | 変更の理由。言語ごとに 1 つ |
0x1DAL | TAG | バージョンに付けた不変の名前 |
0x1DBL | DELTA-BASE | このファイルは基準バージョンに対する diff である |
0x1DCL | DELTA-REMOVE | diff から除く LOCAL ID の一覧 |
0x1DDL | NEXT-LOCAL-ID | 次に割り当てる LOCAL ID。バージョン一覧ドキュメントに置く |
- 履歴は消さない。直した内容は新しいバージョンとして出す。
- branch のように変わるポインタはドキュメントに置かない。リポジトリと索引が管理する。
検証
Meta の検証クラス(Codec 0x1E5L~0x1E9L)は、ドキュメントを信頼できるかを判断する材料を記す。自己発行 Issuer の公開鍵、署名、貢献の権利の確認、信頼度、ドキュメント全体の判定結果である。
- 検証クラスはコンテンツハッシュの計算から除かれる。そのため署名をドキュメントの中に置いても、署名を複数加えても、コンテンツハッシュは変わらない(git
gpgsigと同じ方式)。 - 検証クラスはセクション 15 で
C >= 5、すなわちw >= 0x1E50のレコードなので、Codec ブックなしでハッシュを計算できる。後ろの Reserved0x1EAL~0x1FFLも検証専用なのでハッシュから除かれる。 - ノード・レコード単位の判定は TOULMIN Edge
VERDICT(0x118L)が担う。
| Codec | 名前 | 意味 |
|---|---|---|
0x1E5L | ISSUER-KEY | 自己発行 Issuer の署名アルゴリズムと公開鍵 |
0x1E6L | SIGNATURE | コンテンツハッシュに対する署名。アルゴリズム、署名者、署名 |
0x1E7L | SIGNED-OFF | 貢献の権利の確認 |
0x1E8L | CONFIDENCE | 信頼度 |
0x1E9L | VERDICT | ドキュメント全体の判定結果(Pass、Review、Fail) |
- 検証クラスはコンテンツハッシュの計算から除かれる。そのため署名をドキュメントの中に置いても、署名を複数加えても、コンテンツハッシュは変わらない。
ポリシー
Meta のポリシークラス(Codec 0x1DEL~0x1E3L)は、ドキュメントをどう取り扱うかを定める。ライセンス、公開範囲、個人情報等級、保存期限、同意、使用制限である。
- ポリシーは解釈を変えず、取り扱い方法を定める。
- バイト列内の著作物の元のライセンスは
LICENSEで記録する。
| Codec | 名前 | 意味 |
|---|---|---|
0x1DEL | LICENSE | ライセンス |
0x1DFL | ACCESS | 公開範囲 |
0x1E0L | PRIVACY | 個人情報等級 |
0x1E1L | RETENTION | 保存期限 |
0x1E2L | CONSENT | 同意の範囲と根拠 |
0x1E3L | USAGE | 使用制限 |
- ポリシーは解釈を変えず、取り扱い方法を定める。
IMPORT
Meta の IMPORT クラス(Codec 0x1E4L)は、外部ドキュメントを IMPORT ID で取り込む。Codec は IMPORT-DOC(0x1E4L)1 つである。
- IMPORT はドキュメントだけを取り込む。取り込んだドキュメント内の対象は、BODY の Reference
EXTERNAL-POINTER-*(IMPORT ID、LOCAL ID)で指す(Reference)。 - バージョン ID を記せばその版に、
0なら解釈時点の最新の版にバインドされる。公表ドキュメントはバージョンを記す。 - 取り込んだドキュメントの HEAD は取り込まない。Reference・Value レコードは取り込まずコピーする。
TAG WORD 0001 1110 0100 LLLL IMPORT-DOC (0x1E4L)
[Length 拡張 TAG]
ドキュメント DOC-POINTER レコード (Issuer、ドキュメント ID、バージョン ID)。Codec ドキュメントは CODEC-POINTER
IMPORT ID 残り。最も短い幅の整数
- IMPORT-DOC(
0x1E4L)だけを使う。IMPORT はドキュメントだけを取り込む。取り込んだドキュメント内の対象は、BODY のEXTERNAL-POINTER-*(IMPORT ID、LOCAL ID)で指す。 - バージョン ID を記せばその版に、
0なら解釈時点の最新の版にバインドされる。公表ドキュメントはバージョンを記す。 - 1 つのドキュメントで同じ IMPORT ID を 2 回割り当てない。
- 取り込んだドキュメントの HEAD は取り込まない。そのドキュメントの対象は、そのドキュメントの宣言どおりに解釈する。
例: Issuer 0x00000002 のドキュメント 0x0000000000000002 の最新バージョンを IMPORT ID 1 として取り込む。
1E4A 0418 0000 0002 0000 0000 0000 0002 0000 0000 0001