OKF — Open Knowledge Format

最終更新: 2026-09-04

OKF(Open Knowledge Format)は、Markdownの知識コレクションのためのオープンな規約です: 小さく統一されたFrontmatterヘッダーを持つ、純粋なMarkdownファイルです。このページでは、OKFとは何か、Plainvaが自動的に何を行うのか——そして、なぜあなたがそれらを使う必要がないのかを説明します。

OKFとは?

その考え方は: 保管庫内のすべてのドキュメントが、それ自身で何であるかを示すということです。そのためには、Frontmatterの最小限のヘッダーだけで十分です。

---
type: Note
---
# My note

ツールやスクリプトでファイルを書きますか? 正確なフィールド契約——許可される値、各プロパティタイプがどのようにシリアライズされるか、予約名のルール——はファイル形式リファレンスにあります。

OKFの由来: OKFはGoogle Cloudによるオープンな仕様です(GoogleCloudPlatform/knowledge-catalog、Apache-2.0ライセンス)。PlainvaはOKF 0.2(2026年7月25日公開)に従います。0.2で新しく追加されたのは、ノートがどこから来たのか、誰かがレビューしたのか、まだ有効なのかを示す5つの任意フィールドです——generatedverifiedsourcesstale_afterstatus。Plainvaがそれらについて何を表示し何を書き込むかは、下の「出所、レビュー、ライフサイクル」で説明します。

なぜPlainvaはOKFを使うのか?

純粋なMarkdownは驚くほどポータブルです——しかしそれだけでは信頼できる構造を持ちません。OKFはそこに必要最小限の構造を加えるだけで、すべては標準的なFrontmatterを持つ、ごく普通のMarkdownのままです:

Plainvaが自動的に行うこと

新規ファイルにはOKFヘッダーが自動的に付与されます: Plainvaで作成されたすべてのノートは、そのFrontmatterにtypeを受け取ります——OKF 0.2以降、バージョン指標であるokf_versionはルートのindex.mdに一度だけ置かれ、個々のノートにはもう置かれません。値は保管庫ごとに設定できます: 設定 → 保管庫 → コンテンツと構造 → OKF(Open Knowledge Format)新規ノートのtype(デフォルトはNote)とデイリーノートのtype(デフォルトはDaily Note)。テンプレートが独自のtypeを持っている場合は、テンプレートが優先されます。

既存のファイルは無断で変更されることはありません。 Plainvaは、新規ファイルを作成する際、またはあなたが明示的に変換を開始した場合にのみ、OKFフィールドを追加します。

保護されたシステムフィールド: プロパティパネルでは、typeと——古いノートにまだ残っている場合は——okf_versionがOKFシステムフィールド(「OKFシステムフィールド——Plainvaによって管理されています」)としてマークされています: typeの値は既知のタイプのドロップダウンから選択でき、okf_versionは表示のみです。規約が誤って壊れないよう、名前変更、タイプの変更、削除はロックされています。

説明モーダル: 設定内の**OKFとは?**が、3つの文での短い要約とこのページへのリンクを示します。もう自動的には開きません。保管庫にOKF形式に適合していないファイルが含まれている場合、Plainvaは一度だけ小さなメッセージでそのことを知らせ、変換へ直接移動できるボタンを表示します。

出所、レビュー、ライフサイクル(OKF 0.2)

OKF 0.2以降、ノートは自分がどこから来たのか、誰がレビューしたのか、まだ有効なのかを示せます。Plainvaはこれを3つのことに変えます:

Plainvaが表示すること。

Plainvaが書き込むこと。

バンドルのバージョンを更新する。 規約のバージョンはルートのindex.mdに一度だけ置かれます。まだ"0.1"を宣言している保管庫はそのまま変わらず動作します——設定 → 保管庫 → コンテンツと構造 → バンドルのバージョン(スマートフォンでは: 設定 → Vault → メンテナンス → バンドルのバージョン)で、**更新…**を使って0.2に引き上げます。ダイアログは事前に何が変わるかを示します: ルートのindex.md内の行、そしてチェックボックス(デフォルトでオン)として、まだ残っている旧okf_versionフィールドをノートから削除すること。すべてのファイルは変更前にバックアップされます。**クリーンアップ…**は2つ目の部分だけを行います。フィールド表と書き込みルールの詳細はファイル形式リファレンスにあります。

index.md: フォルダーごとの目次

index.mdはフォルダーの目次です: そのフォルダーに含まれるノートとサブフォルダーの一覧で、説明と相対リンクが付いています。

既存の保管庫を変換する(オプトイン)

保管庫内のファイルがOKF形式に適合していない場合(typeフィールドの欠落、または予約名が通常のノートとして使われている場合)、Plainvaは変換を提案します——保管庫を開いたときに一度、そして設定 → 保管庫 → コンテンツと構造で恒久的に(この項目は、何かすべきことがある間のみ表示されます)。

OKF形式に変換ウィザードは、明確なステップで動作します。

  1. スキャン——影響を受けるファイル数を表示します(テンプレートフォルダーとシステムフォルダーは除外されます。Frontmatterが読み取れないファイルはスキップされ、決して「修復」されません)。
  2. 決定——typeがないファイルのデフォルトtype。既存のtypeの値はそのまま使用(推奨——既に有効なOKFタイプです)するか、別のフィールドに名前変更できます。
  3. プレビュー(変更なし)——ドライランで、何が変更されるかを事前に確認できます。
  4. 変換——各ファイルは変更前に.plainva/backups/にバックアップされます。レポートには、何が変更され、何がスキップされたか、そしてバックアップフォルダーが要約されます。その後、任意でindex.md管理へ進むことができます。

ウィザードからのヒント: 変更は通常通り同期されます——Git保管庫の場合は事前にコミットしてください。

スマートフォンで

同じ経路はモバイルにもあります。設定 → Vault → メンテナンス → OKF形式に変換。手順は同じです——スキャン、選択、プレビュー、変換——そして何かが書き込まれる前に、プレビューが対象のノートを名前で示します。

スマートフォンはいつでもアプリをメモリから外せるため、二つの仕組みが加わります。

元に戻すはバックアップフォルダーからファイルを復元します——デスクトップでも同様に、処理後のレポートから行えます。バックアップフォルダーはその後も残ります。変換前の状態の唯一のコピーだからです。

OKFを使う必要があるか?

いいえ。OKFは緩やかな標準です。

関連ページ