Obsidian Kanban プラグインの基本的な使い方

スポンサーリンク

日本語での記事がほとんど無いようだったので、Obsidian Kanban プラグインの基本的な使い方をまとめておきます。

マークダウンエディタ「Obsidian」自体については別記事「Obsidian 導入メモ」を参照してください。

※初出時のスクリーンショットで分かりづらいものがあったため修正しました。またかなり頻繁にバージョンアップが行われているようで、この記事を書いてから2日でマイナーバージョンが2つ進みました。

目次

Obsidian Kanban Plugin とは?

いわゆる(タイル配置された)カード型のメモ管理を提供するプラグインです。

GitHub – mgmeyers/obsidian-kanban: Create markdown-backed Kanban boards in Obsidian.

※上記GitHubページより引用

※上画像の左上部分の拡大キリトリ画像

ぱっと見の外見でかなりの方が惹かれるUIだろうと思います。「Backlog」や「Todo」と書かれているグループは”リスト”、それぞれの内部にある「Board description」などは”カード(タイトル)”と呼ばれ、当然リストの場所入れ替えや、リスト間でのカード移動などもドラッグすることで自由に行なえます。

Obsidianデフォルト機能であるファイルエクスプローラ(Obsidianの左サイドバー)形式は、一覧形式で探しやすいものの、その中でも現在の自分の中での着目度合いや優先度合いに沿って並んではいないため順番に探す必要があるという欠点があります。また「スター」機能である程度はピックアップできるものの、それでもやはり数が増えれば順番に探す必要があります。

しかしこの「Kanban プラグイン」の場合、縦 or 横に並べたカンバンの位置的な情報で自分がやらないといけないこと、取り掛かっていることなどを整理できるというメリットがあり、視覚的に認識しやすいものになっています。後ほど説明しますが、この”リスト”によるグルーピングは、フォルダ構成の場所とは関係なく行えます。Obsidianの既存機能でいえば、スター機能が複数グループあって自由にタイリングできるようなものです。

Kanban プラグインの導入方法

さっそく使ってみましょう。

  1. Obsidianの「オプションメニュー」-「コミュニティプラグイン」
  2. 未開放の場合、セーフモード解除
    ※コミュニティプラグンの危険性などはこちらの記事参照。複数の書庫で使う場合には書庫ごとに導入が必要。
  3. 「閲覧」ボタンを押して検索ボックスに「kanban」と入れて「Kanban By mgmeyers」を選択し、「インストール」→「有効化」する
  4. 再度Obsidianの「オプションメニュー」-プラグインオプションの「Kanban」を選択してオプション設定もざっと見ておく

設定しておくべきことなど。

  1. 一応設定しておくべきなのは「ノートフォルダ」の初期位置指定で、これはKanbanから新規でノートを作った際の作成フォルダをどこにするか?という設定です。各自の使い方によりますが、散乱すると後で面倒なので例えばですがKanbanというフォルダを作成しておきそこをデフォルト指定すると良いかも知れません。※なお作成したノートの名称や位置を移動しても自動的にKanbanカードのリンク先を追従して変更してくれます。
  2. またObsidianをデイリーメモ的に使う人は、日付フォーマットや、アーカイブする際のセパレーターやフォーマットを確認しておきましょう。
  3. 一番下にある「リンクされたページのメタデータ」は、活用することでなかなか便利になる可能性を秘めている要素ですが、これは後ほど説明します。

 

Kanban プラグインの使い方(基本)

続いてKanban プラグインの基本的な使い方を見ていきます。

ファイルエクスプローラーのフォルダから右クリックで「新規カンバンボード」で新しいカンバンボードを開くことが出来ます。まっさらななカンバンボードを開いた場合は同時に1つ目の「リスト」作成ダイアログが開くので適当な名前を入力します。ひとまずリスト作成ダイアログを閉じて、作成したリストにある「+カードを追加」をクリックしてアイテムタイトル(カードタイトル)を入力していきます。

見た目上はカード形式ですが、結局はMarkdownテキストを表示上工夫して見せかけているだけなので、Kanban プラグインでできることもMarkdownの表記法の範囲内ということになります。

実際にリスト表示やチェックボックスを作ってみたのが下図になります。

1.Kanbanプラグイン表示

※外観は、使用しているテーマ及びCSSスニペットにより異なります。私はライトテーマでBlue Topazを弄ったものを使用しています。以下同じ。

Kanban プラグインでは、こうして作った「Test」という物を”リスト”と呼び、その中の要素ひとつひとつ(番号付きリスト、箇条書き…)を”カード(タイトル)”と呼んでいます。この図では、Testリストの中に3つのカード(タイトル)が入っているということになります。

タイトルという名称で1行だけの編集窓が開きますが、上図のようにカードには複数行記述できます。カードタイトル入力欄に複数行入力する場合はShift+Enterを入力して入力していきましょう。

リストが並んでいるノート自体を”カンバンボード”と呼び、このカンバンボードは複数(例えば趣味や仕事など)持つことが出来ます。いわばKanbanプラグイン導入時のワークスペース的なものだと思えばいいでしょう。このカンバンボードごとに様々な設定を変えることも出来ます。※なお誤解のないように書いておくと、”Obsidian本来のワークスペース”とは複数のノートを開いた作業状態そのものを差し、複数のノートセットの保存や再展開が可能です。

2.編集中の表示

ちなみに入力の終わったカードタイトルは各カードタイトルをダブルクリックすると編集が可能で、その状態では以下のように表示されます。※この例ではスクリーンショット撮影の便宜のためあえて全てのカードタイトルを編集状態のままにしていますが、当然カードひとつずつの編集(と確定)が可能です。

見た目はカンバンですが内容は完全にMarkdownですね。

ちなみにこのKanban プラグインでは、どうやら次のようなルールでCSS適用しているようです。※あくまで1.0.16で確認したものです。

  • 番号付きリストも箇条書き:「+」で書き始める番号付きリストは無視され「-」扱いになる。CSSスニペットでは「ul > li:not(.task-list-item)」以下で指定された内容
  • チェックボックス:タスク”[ ] task”扱い。CSSスニペットでは「li.task-list-item.is-checked」以下で指定された内容

 

3.Markdown表示に切り替えたもの

Obsidianのプラグインなので当たり前といえば当たり前ですが、Kanban プラグインも実体データはMarkdown記法で記述されたノートに過ぎません。

Kanban プラグインではノートのオプションが追加されており、その中の「マークダウンとして開く」を行うことで現在のリスト及びカードをMarkdown表記法で表示することもできます。ちなみに上図の内容をマークダウン表示したのが下ソースになります。

Test

- [ ] 番号付きリスト<br>+ 1<br>+ aa<br>+ bbb
- [ ] 箇条書き<br>- aa<br>- bb<br>- ccc
- [ ] チェックボックス<br>- [ ] 未了タスク<br>- [x] 完了タスク

Markdown記法に切り替えると、Markdown形式の内容を表示だけ変えてうまくカード形式に見せているのだということがよくわかるかと思います。こんなシンプルな内容をあれだけリッチな見た目で見せているのです。

Kanban プラグインでもToDo管理ツールによくある「アーカイブ」という概念があり、個別のカードを手動あるいは時間指定で自動的にアーカイブ化できます。アーカイブされたカード情報はカンバンボードの表示から消え、現時点ではMarkdown記法上でのみ確認できます。

なお(現時点では?)一度Markdown表示に切り替えると元のカード形式表示には戻せません。もう一度カード形式にするには少し不便ですが、マークダウン表示を×ボタンで閉じた上で、左のファイルエクスプローラーからKanbanで作ったカンバンノートを選択して表示しましょう。
→ カンバンボード(ノート)のMore Options(︙)の「カンバンボードとして開く」と「マークダウンとして開く」で、いつでも自由に切り替えできます。コメントでご教示頂きました。ありがとうございました。

Kanban プラグインの使い方(ページリンク)

続いてさらなるKanban プラグインの使い方を見ていきます。

Markdownですので当然メモへのリンクもできます。ノートにリンクするためには、カードタイトルを編集するときに、(通常のObsidianノート同様に)”[[]]”でノートへのリンクを記述するだけです。※カードタイトルの編集はダブルクリックで入ります。新規にカードタイトルを起こす場合は「+カードを追加」で行います。なおカンバンボードのカード上は自動リンク(非明示リンク)はされないので明示的に”[[]]”で括る必要があります。

この時にまだ存在しないノート名を記述すると、(CSS設定により)赤色で表示され、リンクをクリックすることでノート作成を開始することができます。

このリンク作成時のインターフェースが少し変わっていて、インクリメンタルサーチ的に既存のノートが列挙されるのですが、関係ないノート名が出てくることもあります。またフォルダは列挙されない?ため、めんどくさい場合は自分で”フォルダ名/ノート名”を記述したほうが早いかも知れません。※Markdownに切り替えて記述してしまうという最終的な手段もあります。
こうして試しに未作成ノートへのリンクや、作成済ノートへのリンクを作ってみたのが下記になります。

※3番目のカードは、2番目のカード内容をコピーしてあえて編集状態にしたものです。

リンクに対してCtrlを押しながらマウスをホバーさせるとノート内容のプレビューが可能なのは、通常のObsidianの動作と一緒です。未作成カードの場合はクリックでノートの作成画面へと移動します。

2番目のカードの下に日付が表示されていますが、これは3番目のカードのように記述することでそのカードの作成日付や実行期限などを表記することができるものです。またこの日付入力はデフォルトではトリガーキー「@」を押すことで自動的にカレンダーが開きそこから選択することで簡易的に入力することも可能です。同様に時刻の入力は「@@」で時間選択が可能です。日付や時刻の変更はダイレクトに日付・時刻表示をクリックすることで行えます。

この日付入力を行うための「トリガーキー」はオプション設定で変更可能です。またデフォルトだと「@{2021-09-01}」や「@@{00:00} 」という入力内容がそのまま(フッタ部ではなく)カード本文部分に表示されてしまいますが、これはオプションの「カードタイトルの日付を隠す」で非表示にできます。

※個人的にToDo管理的な部分への興味が薄いため飛ばしますが、日付指定によるアーカイブ入りなどの機能もあるようです。ご興味のある方は調べてみると良いでしょう。

 

Kanban プラグインの使い方(メタデータ)

続いてフロントマターによるリンク先ファイルのメタデータ表示で、これがなかなかおもしろい要素です。

ここまではソフトウェア開発での”カンバン(Kanban)”メソッドであり、後述するロードマップでも確認できるようにGitHubでもサポートしています。しかしObsidian上に実装されたKanbanプラグインでは、フロントマターを利用したメタデータの活用というちょっとした、ただしとても大事な追加要素があるのです。

メタデータの表示

メタデータを表示することで、例えば次のようなカード表示が可能です。

調査依頼というリストの中に「No.0010123」「No.0010124」というカードが2枚入っている状態ですが、カードタイトルの下にタイトル、顧客、担当者などの表示が増えています。これがリンク先ノート(ファイル)のメタデータの表示です。

説明不要かと思いますが、No.0010123カードの実体は「[[No.0010123]]」というリンクのみです(テストで入れたため”<br>@{2021-10-01}”と日付データも入っている)。No.0010124カードも同様。その他の情報は、リンク先であるNo.0010123/00110124ノートからKanbanプラグインが自動的に引用してきた情報を表示しています。

Obsidianの機能でノートへのリンクでもノート内容がプレビューできますがマウスホバーでの確認が必要などワンテンポ面倒くささが残りますし、いちいちカードタイトル側に重複して記述するのも作業が煩瑣ですし二重記載することで管理項目が増えるだけです。

しかしこうやって概要(例えば担当部署や担当者などを表示してもいいでしょう)などを個別ノートのフロントマター部分に記述しておき、そこから自動的に抜粋して表示させることでさらにカンバン状態での視認性が増すと思われます。管理ノート数やPCの性能などにもよるかと思いますが、リンク先フロントマターの変更もほぼ即反映されます。

※カンバンからのノート作成時に使用するテンプレートを指定できますので、そこで共通的なフロントマターを記述しておくと良いでしょう。
※なおこのメタデータキーで引いた引用部分に対しても当該カンバンボード内での検索(Ctrl+F)対象となります。

メタデータの記述内容

このカードでリンクしている「No.0010123」ノートの実体がどうなっているかというと、次のような内容となっています。

---
title: フグ田マスオ素行調査
staff: 山田太郎
client: 磯野波平
description: 娘・磯野サザエの**結婚**にあたっての候補者素行調査
---

#至急

”—”(半角ハイフン3個)で上下を挟まれた始めの4行がメタデータ用のフロントマターで、この例では「title:」「staff:」などがメタデータの記述キー(判別キー)になっています。各キーに対応した値(例えばキー”title”であれば”フグ田マスオ素行調査”の部分)が引用先カンバンボードで表示されるのです。

・メタデータとはObsidianでもサポートされているノートの要約というか共通項的な属性情報のようなもので、それを記述するフォーマットが(ハイフン3個で挟む)フロントマターです。
・論文であれば著者や所属情報、作成日などになるかと思います。プログラムならtitleやauthor/keywords/description、業務やタスクで言えばタスクの重要度、区分やカテゴリー、発注元、提出先、各担当者などになろうかと思います。もちろん文字通り要約を完結に記述しても構いません。その辺りは完全に自由です。

ここでは仮にテストとして「title:」などをキーとして記述していますが、次に説明するように名称や表示ラベル名などは当然自由です。Obsidian標準の物とは別に、独自にフロントマターの様式を追加していけるのがKanban プラグインの拡張要素となっています。

メタデータキーの設定方法

このメタデータキーを設定するのがKanbanプラグインのオプション画面で、上の表示をするために下図のような設定をしています。右端のハンバーガーアイコンは並び順を指定するもので、ここでの指定順にカード欄に表示されます。

※なおこの設定は「Kanban プラグイン」共通のグローバルなオプション設定(Obsidianのコミュニティプラグインのオプション設定)と、個別のカンバンボードのローカルオプション設定(各カンバンボードのギアアイコン)の2種類があり、グローバル設定よりも個別のローカル設定が優先されるようになっています。

ここでは5つのメタデータキーを設定していますが、順番に見ていきましょう。

  1. title
    判定するためのキーが「title」で、カンバン画面での表示の際にラベルとして表示する文字列(つまり表示ラベル)を「タイトル」としています。
  2. client
  3. staff
    2番目のclientおよび3番目のstaffも、それぞれラベルは顧客、担当者としています。なお「No.0010123」ノートではstaff→clientの順に記述していますが、こちらのオプション設定での並び指定ではclient→staffとなっているため、カンバンボードではオプション設定が優先されて指定順(client→staff)に表示されています。
  4. description
    4番目のdescriptionは少し設定が異なっており、「ラベルを隠す」と「(記述)フィールドにマークダウンを含みます」の2ヶ所にチェックが入っています。前者「ラベルを隠す」によりカード表示上ラベルが省略され、さらに後者によりその内容にMarkdown記法を許可する設定になっています。実際に「**結婚**」の部分がMarkdown記法に従って強調表示されていることが確認できるかと思います。※この例ではラベル非表示なのでラベル欄は空白でも構いません。
  5. tags
    これはヘルプには記載がないのですがデフォルトで判定されるキーのようで、「#タグ1」「#タグ2」などとタグ打ちしておいた内容をカードタイトル部分に表示することができます。

ここで設定しているキーは、最後のtagsを除いた他の項目は各Obsidian利用者がキー名称からラベル名とラベル表示有無、Markdown記法を許容するか否かを各キーごとに自由に設定できるものです。繰り返しますが、この設定はKanban プラグインのオプションでの共通(グローバル)指定と、個別のカンバンボードのオプションの2段構えで切り替えて使うことも出来ます。同じメタデータキーは個別(カンバンボードローカル)の指定が優先されます。利用方法の幅が相当広いことがわかります。

メタデータのさらなる活用方法

メタデータの使い方としては、上記したように担当者名など共通していて汎用的に表示することで利便性があがる要素をカンバンに表示できるというものです。

しかし記述フィールドにマークダウンを含めることが可能なので、単純な文字だけではなく例えば視認性を向上させるための簡単な記号やイメージなどを表示させることも可能だということです。

Obsidianフォーラムからの引用画像ですが、下記のような表示も可能でしょう。

対応Markdown記法

対応しているMarkdown記法について軽く確認してみたリストです。要するに基本的なMarkdown記法は困らないということです。

※カード本文にMarkdown記法で記述してみたものです。引用インクルードも同様ですので、メタデータキーでのMarkdown記法でも同様の結果になるのではないかと思います。
OK:
  • イタリック *aa*:OK
  • ボールド **aa**:OK
  • イタリックボールド ***aa***:OK
  • ハイライト ==aa==:OK
  • 取り消し線 ~~aa~~:OK
  • code記法 `aa`:OK
  • 引用 >aa:OK
  • 見出し1~5:OK
  • 内部リンク [[]]:OK
  • 埋め込みリンク ![[]]:OK
  • 水平線 —(半角ハイフン3個):OK
  • 表組み:OK。ただしカード横幅以上は見切れスクロールもしない
    → (グローバル/ローカル)オプションの「レーンの幅」を調整する
  • タグ:OKだがデフォルトだと、カード本文とカードフッターの2ヶ所に重複して表示される
    → オプションの「カードタイトル内のタグを隠す」もしくは「カード(フッター)に表示されるタグを隠す」で調整する
  • pre記法 ~~~行で挟む:OK
  • 脚注 [^no]:OK
  • 外部リンク [Google先生](https://www.google.co.jp/):OK

NGまたは要注意:

  • 見出しリンクなど [[A#b]]:入力はできないがコピペすることでリンクは動作する。→「1.0.17」で”#(見出し)”、”^(ブロック)”に対応。しかし日本語ファイル名では?別のファイルの見出しを探しに行く場合がある模様。またフロントマターのAliasにも対応し別名での検索も可能となった
  • Mermaid記法:NG。parse error表示(Cannot read property ‘firstChild of null’)が出てしまう

NGのうち、今後のバージョンアップで対応するものもあるのではないかと思います。

まとめ

この「Kanban プラグイン」は、現時点の機能だけでもかなり優れたプラグインで、Obsidianの可能性を大きく広げるものだということがいえます。特にTodo管理などで苦労されている方にとってはかなり便利になると思います。

個人的にはメタデータの拡張などはObsidian本体に取り込んで欲しいくらいのものです。それをファイルエクスプローラーなどで表示させることができたりすれば、なかなかおもしろいのではないかと妄想します。

しかしKanban プラグインの現時点の機能では、メタデータの設定が流用できなかったり、記述方法が少々泥臭かったりするなど、やや歯がゆい部分も残っています。

※実は、カンバンボード(ノート)をマークダウン表示してみるとわかりますが、このカンバンボードごとのオプション設定(メタデータキーなど含む)もフロントマターで記述されているため、マークダウン記法状態で強引にコピーすることでコピー可能なように思えますが動作保証されているかどうかは不明です。

ただしそれらを差し置いても、Obsidianの可能性をさらに広げるなかなか革命的なプラグインではないかと思います。Obsidian本体がメモアプリ(テキストデータ編集ソフトウェア)にWiki的なリンク構造を持ち込んだ物であると荒っぽく規定するとすれば、このKanban プラグインはさらに(フロントマターを拡張することにより)メモアプリに簡易データベース(RDB)的な考え方を持ち込んだものと言っても良いのではないでしょうか。「そんなのRDBでやればいいじゃん」とかそういう話ではなく、テキストベースのエディタでそれが実現できるというところに大きなメリットがあります。

Obsidian本来のワークスペースの場合は複数ノートのグルーピングに過ぎませんが、それをこのKanbanプラグインでは(フォルダ構造を横断した)各ノートへのリンクとそれへのメタデータ的な情報群(さらにはそのノートを進める上での手順メモや作業項目、細かな作業履歴あるいは感想など単なる思いつきメモなど)をノートから独立してリストとしてまとめ、さらにそれをカンバンボードとして複数保持することができるという階層構造になっています。

例えばWikipediaなどでは、同様のことを「Category(カテゴリ)」と呼ばれる様式のページを作成してそこに項目名を列挙することでグルーピングしています(例えばソフトウェアカテゴリ)が、しかしこれでは単なる情報の羅列でしかなく、その並びや配置に(項目名昇順以外の)特段の意味はありません。いっぽうこのカンバンボードは、それに加えて付随情報を配置し、カード形式で重要度や優先度を考慮して並べることも可能になります。情報編集あるいは知識の構造化と呼ばれる作業を実現する下地ともなりうると考えます。

・完全に余談ですが、Wikipediaでは各項目ページ末に「[[Category:」と記載することでカテゴリページへのリンクを張り、それを各カテゴリページ側で引っ掛けてリスト表示することでカテゴリ表示を実現しています。すべて地道な手動での構築なのです。例えばカテゴリの再構築を考えると柔軟性に乏しいかなり苦しい構造です。これは明示的なリンク構造しか考慮されていない現在のWikiシステムの限界と言えるかと思います。※一部Pukiwiki拡張でAutoLinkやAutoAliasNameなどの機能がある。
・Wikipediaでは近年、マウスホバーによるリンク先の内容プレビューを搭載しましたが、それはObsidianでも同等以上(スクロールもコピーもできる)の機能があります。またObsidianでは当該文書へのメンションリンクと非メンションリンクなどのバックリンク(被リンク)と、当該文書からのアウトゴーイングリンク参照を標準装備していることでリンク構造の構築を自動的かつ簡易化しつつ高度化しています。多くの方はここに惹かれて利用を開始したことでしょう。
・そして今回のKanbanプラグインにより、これらObsidianの高度な文書間連携機能をさらに一歩進めた大げさに言えば簡易データベース的な知識構造の構築が可能となったと考えます。使い方にもよりますが、高度な情報の構築を可能にし、情報参照の速度を圧倒的にスピードアップすることができるでしょう。
・なおカンバンボード形式じゃなく表形式でRDB的な操作がしたいんだという方の場合は「Dataview」プラグインが適していると思われます。

現在も積極的に開発中でありロードマップなども公開されていますので、今後に大きな期待をしたいところです。

 

コメント

  1. 通りすがりの読者 より:

    初めまして.Obsidianの使い方を調べていたところこの記事に辿り着きました.

    私もKanbanを利用している中でMetadateの使い方について大変参考になりました

    >なお(現時点では?)一度Markdown表示に切り替えると元のカード形式表示には戻せません。もう一度カード形式にするには少し不便ですが、マークダウン表示を×ボタンで閉じた上で、左のファイルエクスプローラーからKanbanで作ったカンバンノートを選択して表示しましょう。

    More options>Open as kanban borad で変換可能なはずです.ご確認ください

タイトルとURLをコピーしました