ПунктЗначение
ИмяDOC-ID (BIND документа спецификации DOC-ID)
TAG ID0x1C7L
Codec ID0x00001C70
Документ спецификации0x00000000/codecs/0x00001C70/ (цель DECLARE 1C70)
Раздел14 1110 (Meta), смещение в разделе C = 7
KindMeta · класс: объявление
TAG WORD0001 1100 0111 LLLL (000K KKKC CCCC LLLL)
Описание в индексеИдентификатор этого документа. Встроенный Reference DOC-POINTER (Issuer, ID документа, версия 0). Для документа Codec — CODEC-POINTER (Issuer, Codec ID, версия 0)
Сторона Hugometa/declaration/doc-id.md

Поля (документ спецификации)

Порядок FIELD в документе — это порядок полей Payload (Документ спецификации Codec).

ПорядокПоле (BIND)FIELDШиринаПринимаемый формат (CODEC)ENUM
1doc#2запись0410 DOC-POINTER, 0420 CODEC-POINTER

Объявляет идентификатор этого документа. Он нужен, чтобы другие документы могли указывать на этот документ и на объекты в нём.

Раскладка

TAG WORD          0001 1100 0111 LLLL      Codec 0x1C7L
[Length — расширяющий TAG]
Документ          запись Reference DOC-POINTER. (Issuer, ID документа, версия 0). Для документа Codec — CODEC-POINTER
  • Codec: Meta 0x1C7L, класс объявления
  • Payload: один встроенный Reference DOC-POINTER (Issuer, ID документа, версия 0)
  • Количество: не более одного. Для документов версий под docs/<ID документа>/ и codecs/<Codec ID>/ обязателен

Интерпретация и валидность

  • Payload — ровно одна запись Reference DOC-POINTER (Issuer, ID документа, версия 0). В качестве ID версии используется только 0. Версию назначает не документ, а список версий. Для документа Codec используется CODEC-POINTER (Issuer, Codec ID, версия 0) (CODEC-POINTER).
  • Поэтому запись, указывающая на «этот документ», одинакова в DOC-ID, в записи PUBLICATION списка версий и в цитатах из других документов.
  • Один и тот же документ независимо от версии имеет один и тот же DOC-ID. ID версии и хеш содержимого в документе не пишутся (Версия).
  • Адреса по имени документа нет (Адреса публикации и список версий). Заголовок для чтения человеком берёт на себя Edge-высказывание LABEL.
  • Если его нет, документ безымянный, и указать на него можно только по хешу содержимого. Он нужен, чтобы другой документ мог указывать на LOCAL этого документа через указывающий Reference.
  • Сторона, получающая документ, проверяет, что DOC-ID полученного документа совпадает с запрошенными Issuer и ID документа.
  • ID документа 0x0000000000000000 — это индексный документ определений терминов Issuer (Issuer). Он тоже является документом версии под docs/<ID документа>/, поэтому в нём ставится DOC-ID (DOC-POINTER (Issuer, 0, 0)). Самого Issuer представляет ISSUER-POINTER.
  • Документы версий <ID версии>.geul (включая документы спецификации) под <Issuer>/docs/<ID документа>/ и <Issuer>/codecs/<Codec ID>/ в .well-known/geul/ обязаны иметь DOC-ID.
  • Документы-списки — исключение, DOC-ID в них не ставится: список версий versions.geul (PUBLICATION) и версия <ID версии>.geul списка Issuer issuers/ (Адреса публикации и список версий). Чей это список, говорит DOC-POINTER в записи. Версию документа-списка указывает PUBLICATION в его versions.geul через DOC-POINTER (0x00000000, зарезервированный ID документа, ID версии). Адрес по хешу содержимого <Issuer>/hashes/ — копия перечисленных выше документов и следует оригиналу.
  • ID документа 0xFFFFFFFFFFFFFFFF зарезервирован у всех Issuer (как и 0x0000000000000000) и используется для списка Issuer у Issuer 0x00000000. Другие Issuer его не используют. Поскольку у документов-списков нет DOC-ID, это значение встречается только в DOC-POINTER записей issuers/versions.geul.
  • Документ спецификации Codec — это документ Codec у GEUL Issuer 0x00000000. ID документа у него нет, а в качестве DOC-ID ставится CODEC-POINTER (0x00000000, Codec ID, 0). Codec ID — это Kind и Codec TAG WORD, записанные в 32 битах (0x0B80 → 0x00000B80) (документ спецификации).

Пример

  • Issuer 0x00000002, документ 0x…0005: 1C79 0418 0000 0002 0000 0000 0000 0005 0000 0000 (Meta TAG 1 + Reference TAG 1 + Issuer 2 + ID документа 4 + версия 2 = 10 WORD)

Исходный текст документа спецификации

Документ спецификации 0x00000000/codecs/0x00001C70/latest.geul, прочитанный командой geul show (16-ричные значения в верхнем регистре).

SPEC-VERSION 0x0001
DOC-ID 0x04260000000000001C7000000000
BODY
#1 DECLARE 0x1C70
#2 FIELD #1 record
#5 CODEC #2 0x0410
#3 BIND #1 "DOC-ID"
#4 BIND #2 "doc"
#6 CODEC #2 0x0420