日本語
拡張を載せる
このカタログのモデルに属性を足して使っている組織は、モデルのページの「拡張している組織」に載せられます。同じ意味の属性が要るほかの組織が、新しく作らずにその名前を使えるので、お互いのデータがそろいます。
フォームに記入するだけです。費用はかからず、プログラミングも要りません。足した属性の良し悪しは審査しません。GitHub のアカウントが要ります。
用意するもの
- GitHub のアカウント。無ければ登録してください。
- 拡張したモデル。例:
task/Task。 - 足した属性。それぞれの名前、IRI、意味。
- 自分の @context。その URL、またはデータの中に書いている @context。
言葉の意味:
- 属性は、データの 1 つの項目です(
nameやcategoryなど)。 - IRI は、属性の名前として使う Web アドレスです。これで、誰が見ても同じ意味だと分かります。自分のドメインのアドレスを使います(例:
https://models.gtt-project.org/ns/redmine#category)。 - @context は、属性の名前と IRI を結び付ける短いファイルです。書き方は属性を足すに、ブラウザで作るなら拡張ビルダーがあります。
フォームに記入する
モデルのページのリンク「フォームで登録してください」から開くと、モデル名が入った状態になります。空のフォームからでも構いません。日本語でも英語でも大丈夫です。
| 項目 | 書くこと | 例(GTT プロジェクト) |
|---|---|---|
| 拡張したモデル | サブジェクトと型を / でつないで | task/Task |
| 組織名 | 組織の名前を日本語と英語で | GTT プロジェクト / GTT Project |
| 足した属性 | 1 行に 1 つ:名前、IRI、意味(日本語 / 英語)をカンマで区切って | category, https://models.gtt-project.org/ns/redmine#category, Redmine の課題のカテゴリー名 / The Redmine issue category name |
| @context | @context の URL、またはデータの中に書いている @context | https://models.gtt-project.org/context/redmine/v0.jsonld |
| 基にしたバージョン | サブジェクトのバージョン。サブジェクトのページにあります | 1.0.0 |
| 組織またはプロジェクトのページ(任意) | 組織または拡張について書いたページ | https://models.gtt-project.org/models/redmine/Task/ |
| 公開しているデータ(任意) | データを公開していれば、その場所 | (空) |
| 公開の同意 | 2 つともチェック:組織を代表していること、内容を誰でも再利用できること(CC0 1.0) | 両方チェック |
Issue は公開されます。API キー、パスワード、トークン、ログイン URL は書かないでください。
最後に「Create」を押します。
そのあと
- メンテナーが、登録した人が組織を代表していることを確かめます。Issue で質問することがあります。
- メンテナーか登録した人が、Pull Request でカタログに登録します。間違いは自動の検査で見つかります。たとえば、名前がモデルの属性や NGSI-LD のコアの用語と重なっている、IRI が datamodels.jp のアドレスになっている、など。ドメインの持ち主かどうかは検査しません。検査の一覧は貢献するにあります。
- マージされると、数分でモデルのページの「拡張している組織」と
catalog.jsonに載ります。
内容は申告のまま載せます。属性の設計が良いかどうかは、datamodels.jp では確かめません。あとで直したり外したりしたいときは、新しい Issue で知らせてください。
例:GTT プロジェクト
GTT プロジェクトの Redmine 用プラグインは、課題を Task のエンティティとして NGSI-LD ブローカーに送ります。Task には課題のカテゴリーの属性が無いので、GTT は category を 1 つ足しました。
- GTT は、自分のサイト models.gtt-project.org で公開しています。サイトはツールキットで作りました(自分のサイトで公開する)。@context の redmine/v0.jsonld は、カタログの task の @context を取り込み、
categoryを足しています。 - GTT が #189 で登録し、#190 でカタログに入りました。
- Task のページに載っています。
みんなに役立ちそうなら
モデルを使う多くの人に役立つ属性なら、カタログそのものに提案してください。手順は貢献するにあります。