||||
-|-|
| 概要 | Discourse Doc Categories は、特定のカテゴリをドキュメント用に割り当てる機能を備えており、それらのカテゴリに追加の機能を提供します。
| リポジトリリンク | https://github.com/discourse/discourse-doc-categories
| インストールガイド | Discourse でのプラグインのインストール方法
このプラグインは現在も活発に開発中であり、まだ完全に完成していないことに注意してください。
機能
Discourse Doc Categories プラグインを使用すると、既存の Discourse フォーラムに構造化されたドキュメントをホストできます。これは、特定のドキュメント用カテゴリを割り当て、特定のドキュメントトピックを見つけやすくするための機能を提供することで動作します。
Documentation カテゴリでその動作を確認できます。
カテゴリをドキュメントの場所としてマークすると、そのカテゴリに対して以下の機能が有効になります。
- カテゴリ内のすべてのドキュメントトピックのインデックスとして使用される指定されたトピック
- カテゴリ内の異なるトピック間のナビゲーションのための新しいサイドバー（組み込みのフィルタリングおよび検索機能を含む）
- インデックストピックの整合性を維持するのに役立つ新しいレポート
さらに、このプラグインは、退役した Docs プラグイン から移行するサイト向けのリダイレクト処理を行います。そのプラグインからのドキュメントリンクは既存のトピックURLにリダイレクトされ、以前のドキュメントホームページをメインのドキュメントカテゴリにリダイレクトするための設定も用意されています。
設定
設定は example.discourse.com/admin/site_settings/category/doc_categories で利用可能です。ここでは以下の設定が見つかります。
doc categories enabled: Doc Categories プラグインを有効にするために選択します。doc categories docs legacy enabled: 非推奨の Docs プラグインから移行した場合はこれを選択します。doc categories homepage: 前の設定が有効になっている場合、非推奨の Docs プラグインからのランディングページはこのURLにリダイレクトされます。
どのカテゴリをドキュメントに使用するかを指定するには、インデックストピックを割り当てます。これを行うには、カテゴリページの 
アイコンをクリックしてカテゴリの設定を開きます。そこから「設定」リンクをクリックし、「ドキュメントモード」セクションまでスクロールします。「インデックストピック」フィールドを使用して、インデックスとして使用されるトピックを指定します。
インデックストピック
ドキュメントカテゴリのインデックストピックには2つの目的があります。
- カテゴリに含まれるすべてのトピックの中央リストとして機能する
- このプラグインに含まれるサイドバーは、インデックストピックの内容で構成される
インデックストピックのフォーマット
インデックストピックには任意のコンテンツを含めることができます。サイドバーが正しく機能するためには、ドキュメントトピックの箇条書きリスト（または複数の箇条書きリスト）を含める必要があります。これらは単にリスト内のトピックURLでも構いません。その場合、サイドバーには各ドキュメントトピックの完全なタイトルが表示されます。
タイトルが数語を超える場合、サイドバーに完全なタイトルを表示するのは実用的でないことがあります。特定のトピックに対して短いタイトルを設定するには、URL の前にコロン（:）で区切られた短いタイトルを付けてください。コロンより前のテキストがサイドバーに表示され、そのトピックURLにリンクされます。
インデックストピックをセクションに分け、各セクションの上に任意のレベルの見出しを持つ複数のリストを使用することもできます。これらはサイドバーでこれらのセクションとして表示されます。
以下は、インデックストピックの例です。
カテゴリの簡単な説明から始めても構いません。
## 最初のセクション
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* 短いタイトル: https://discourse.example.com/t/topic-with-a-long-title/56
* 他のタイトル: https://discourse.example.com/t/another-topic-with-a-long-title/78
## 2番目のセクション
* トピックタイトル: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
この例は、以下のようなドキュメントサイドバーを出力します。
Documentation > Site Management のインデックストピックは、ドキュメントカテゴリインデックスの実際の例です: https://meta.discourse.org/t/site-management-index/308032
インデックストピックの管理
カテゴリ内のコンテンツが追加、削除、または編集されても、インデックストピックは自動的に更新されませんが、プラグインにはインデックストピック内の不整合を強調表示する新しいレポートが含まれています。
-
インデックスに登録されていないトピック:
example.discourse.com/admin/reports/doc_categories_missing_topics
このレポートは、ドキュメントカテゴリに含まれていますがインデックスに追加されていないトピックを示します。 -
不要な項目:
example.discourse.com/admin/reports/doc_categories_extraneous_items
このレポートは、インデックスに含まれていますが、そこにあってはならないと思われる項目を示します。レポートには、トピックがレポートに含まれている理由（例：削除された場合や、インデックストピックとは異なるカテゴリにある場合など）が示されます。
追加情報
検索語に in:docs という文字列を追加すると、ドキュメント用にマークされているすべてのカテゴリ（つまり、インデックストピックが割り当てられているカテゴリ）が検索されます。
インデックス内の最大項目数は、Max oneboxes per post サイト設定によって設定されており、デフォルトは50です。50件以上のインデックス項目が必要な場合は、その設定の数値を増やしてください。
）
Obsidianで管理されているコンテンツで、ドキュメントを
