このプロジェクトについて
Obsidian Dataviewは、Obsidianノート作成アプリケーション用のプラグインで、ユーザーのVaultをクエリ可能なデータベースに変換します。YAMLフロントマターとインラインフィールド注釈(`Key:: Value`構文を使用)からメタデータを抽出してMarkdownファイルをインデックス化し、データをフィルタリング、ソート、可視化するための複数のクエリモードを提供します。
このプラグインは4つのクエリインターフェースを提供します:
1. **Dataviewクエリ言語(DQL)**:基本的なクエリのためのパイプラインベースのSQL風表現言語。フォルダからファイルを評価順にリストしたり、タグでフィルタリングする例が含まれます。
2. **インライン式**:Markdownテキストに直接埋め込み、プレビューモードで評価できるDQL式。現在のページ名を表示するなどが可能です。
3. **DataviewJS**:Dataviewインデックスとレンダリングユーティリティへのアクセスを提供する完全なJavaScript API。最も強力なモードで、複雑なグループ化、ソート、カスタムレンダリングロジックを可能にします。
4. **インラインJS式**:Markdown内で任意のJSをインライン実行するためのインライン式のJavaScript版。
データ抽出は2つのメカニズムに依存します:Markdownフロントマター(ドキュメント上部のYAMLブロック)とインラインフィールド(`Key:: Value`構文を使用してドキュメント本文に直接書かれたメタデータ)。どちらもノートに構造化データを注釈するために使用できます。
コードベースはTypeScriptで書かれ、rollup/nodeを使用してコンパイルされます。開発には、リポジトリのクローン、npmでの依存関係のインストール、`npm run dev`を実行してテストVaultにビルドおよびデプロイすることが含まれます。プロジェクトはドキュメントにもMkDocsを使用しています。
JavaScriptクエリは他のObsidianプラグインと同じアクセスレベルで実行されるため、ファイルを変更したりネットワーク呼び出しを行う可能性があります。通常のDataviewクエリはサンドボックス化されており、Vaultに悪影響を及ぼす変更はできません。
このプロジェクトはオープンソースであり、バグ報告、修正、ドキュメント、改善を通じて貢献を受け付けています。TypeScript型定義は他のプラグインで使用するためにNPMに公開されています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.