OKF — Open Knowledge Format
最終更新: 2026-07-11
OKF(Open Knowledge Format)は、Markdownの知識コレクションのためのオープンな規約です: 小さく統一されたFrontmatterヘッダーを持つ、純粋なMarkdownファイルです。このページでは、OKFとは何か、Plainvaが自動的に何を行うのか——そして、なぜあなたがそれらを使う必要がないのかを説明します。
OKFとは?
その考え方は: 保管庫内のすべてのドキュメントが、それ自身で何であるかを示すということです。そのためには、Frontmatterの最小限のヘッダーだけで十分です。
---
type: Note
okf_version: "0.1"
---
# My note
type——このドキュメントがどのような種類か(例:Note、Daily Note、Project)。規約の唯一の必須フィールドです。okf_version——ファイルがどのバージョンの規約に基づいて書かれたかを示します。index.md——各フォルダーは、その目次として1つのindex.mdを持つことができます。index.mdとlog.mdという名前はこのために予約されており、通常のノートには使用すべきではありません。
ツールやスクリプトでファイルを書きますか? 正確なフィールド契約——許可される値、各プロパティタイプがどのようにシリアライズされるか、予約名のルール——はファイル形式リファレンスにあります。
なぜPlainvaはOKFを使うのか?
純粋なMarkdownは驚くほどポータブルです——しかしそれだけでは信頼できる構造を持ちません。OKFはそこに必要最小限の構造を加えるだけで、すべては標準的なFrontmatterを持つ、ごく普通のMarkdownのままです:
- データベース、フィルター、テンプレートは構造に依拠できます。 すべてのノートが
typeを持つため、普通のファイルに対する.baseビューも堅牢であり続けます。 - フォルダーはナビゲート可能なままです。 フォルダーごとの
index.mdという目次は、人にもツールにも役立ちます。 - スクリプトやAIアシスタントも保管庫を安全に扱えます——ディスク上の形式が統一され、文書化されているためです。
- ロックインなし。 OKFは、ごく普通のMarkdownの上に成り立つオープンな規約です——他のOKFツールも、今日そして10年後もあなたのファイルを理解できます。
Plainvaが自動的に行うこと
新規ファイルにはOKFヘッダーが自動的に付与されます: Plainvaで作成されたすべてのノートは、そのFrontmatterにtypeとokf_versionを受け取ります。値は保管庫ごとに設定できます: 設定 → 保管庫 → コンテンツと構造 → 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は一度だけ小さなメッセージでそのことを知らせ、変換へ直接移動できるボタンを表示します。
index.md: フォルダーごとの目次
index.mdはフォルダーの目次です: そのフォルダーに含まれるノートとサブフォルダーの一覧で、説明と相対リンクが付いています。
- 生成——常にあなたの操作に応じて、何もないところから自動的に生成されることはありません: フォルダーを右クリック → index.mdを生成/更新、またはまとめてindex.md管理(設定 → 保管庫 → コンテンツと構造)から行います。
- 生成の代わりに採用する——既に概要ノート(MOC、概要、フォルダーノート、READMEなど)がある場合、管理画面がそれらを候補として提案します。採用は、そのファイルを
index.mdに名前変更し(リンクは保管庫全体で更新されます)、任意でOKF向けに整えることもできます。 - 自動的な保守——Plainvaによって生成された一覧には、ファイルの末尾に不可視のマーカー(HTMLコメント)が付きます。このようにマークされたファイルのみ、フォルダーが変更されるたびに自動的に最新の状態に保たれます——そしてそれはOKF保管庫でのみです(ルートの
index.mdにokf_versionがあることで識別されます)。 - 読み取り専用と抜け道——管理されているindex.mdファイルは、「このindex.mdはPlainvaによって管理され、自動的に更新されます」というバナー付きの閲覧モードで開きます。そこでは更新を行うか——それでも編集するを選択できます: これによりマーカーが削除され、そのファイルは再び完全にあなたのものになります(自動更新はされなくなります)。
- 一括処理——すべてのindex.mdを更新は、保管庫のルートのコンテキストメニューと設定にあります。マーカーのないファイルはスキップされます。
- 抜けを埋める——index.md管理の中で、index.mdがないすべてのフォルダーに作成を使うと、まだindex.mdがないフォルダーがすべてあらかじめ選択されるので、一度の操作でまとめて作成できます。
- 閲覧モードでは、管理されている一覧はファイル/フォルダーアイコン付きのカードとしてレンダリングされます。リンクはPlainva内で直接開きます。
既存の保管庫を変換する(オプトイン)
保管庫内のファイルがOKF形式に適合していない場合(typeフィールドの欠落、または予約名が通常のノートとして使われている場合)、Plainvaは変換を提案します——保管庫を開いたときに一度、そして設定 → 保管庫 → コンテンツと構造で恒久的に(この項目は、何かすべきことがある間のみ表示されます)。
OKF形式に変換ウィザードは、明確なステップで動作します。
- スキャン——影響を受けるファイル数を表示します(テンプレートフォルダーとシステムフォルダーは除外されます。Frontmatterが読み取れないファイルはスキップされ、決して「修復」されません)。
- 決定——typeがないファイルのデフォルト
type。既存のtypeの値はそのまま使用(推奨——既に有効なOKFタイプです)するか、別のフィールドに名前変更できます。 - プレビュー(変更なし)——ドライランで、何が変更されるかを事前に確認できます。
- 変換——各ファイルは変更前に
.plainva/backups/にバックアップされます。レポートには、何が変更され、何がスキップされたか、そしてバックアップフォルダーが要約されます。その後、任意でindex.md管理へ進むことができます。
ウィザードからのヒント: 変更は通常通り同期されます——Git保管庫の場合は事前にコミットしてください。
OKFを使う必要があるか?
いいえ。OKFは緩やかな標準です。
- 新規ファイルには自動的にヘッダーが付与されます——これが邪魔になることはなく、コストもかかりません。
- 既存の保管庫(例えばObsidianからのもの)は変更なく引き続き機能します。変換は厳密にオプトインです。
okf_versionが欠落しているだけでは違反とは見なされません——PlainvaとObsidianを永続的に並行して使用でき、繰り返し通知されることもありません。- Obsidianや他のあらゆるエディターは、引き続きすべてのファイルを開くことができます: それは今も昔もごく普通のMarkdownです。
関連ページ
- ファイル形式リファレンス——すべての保管庫ファイルの正確なディスク上の契約
- ノートとMarkdown——Frontmatterとプロパティ
- データベース (.base)——統一された
typeが実際にどう役立つか - FAQ・トラブルシューティング——バックアップや読み取り専用index.mdなど