モデルを足す

ノードのサブジェクトにモデルを足し、属性を書きます。ノードがまだ無いときは、サイトを始めるから始めてください。

新しいモデル

npx github:geolonia/datamodels-toolkit#v0.3.3 add road/RoadPatrol

models/road/RoadPatrol/ に schema.json、catalog.yaml、examples/example.json ができます。サブジェクトの @context には型 RoadPatrol が入ります。続けて、属性を書きます。

カタログのモデルから始める

このカタログのモデルから始めるときは、extend を使います。カタログのモデルのスキーマをコピーし、その @context を取り込み、土台にしたモデルを記録します。そのため、check が名前と意味を変えていないかを検査できます。そのうえで、下のように自分の属性を足します。--subclass を付けると、独自の IRI を持つサブタイプになります。

npx github:geolonia/datamodels-toolkit#v0.3.3 extend task/Task road/RoadTask

属性を書く

属性は、1 つにつき 3 か所に書きます（例は add で作った RoadPatrol です）。まず models/road/RoadPatrol/schema.json の properties に書き、IRI は x-iri に入れます。

"route": {
  "type": "string",
  "description": "The route patrolled",
  "x-iri": "https://models.example.org/ns/road#route"
}

次に models/road/context.jsonld の @context に、同じ IRI で書きます。

"route": "road:route"

最後に、models/road/RoadPatrol/catalog.yaml へノードの言語ごとの説明を書きます。

attributes:
  route: { ja: 巡回したルート, en: The route patrolled }

examples/example.json にも値を入れてください（"route": "A-3"）。catalog.yaml と models/road/subject.yaml のタイトルと説明も、自分の言葉に書き換えます。名前や説明の付け方は、このカタログのモデルのルールが参考になります。

モデルができたら、検査とビルドに進みます。