|||
-|-|-|
| 概要 | 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にリダイレクトされます。
ドキュメントに使用するカテゴリを指定するには、インデックストピックを割り当てます。これを行うには、カテゴリページの:wrench:アイコンをクリックしてカテゴリの設定を開きます。そこから、「設定」リンクをクリックし、「ドキュメントモード」セクションまでスクロールします。「インデックストピック」フィールドを使用して、カテゴリのインデックスに使用するトピックを指定します。
インデックストピック
ドキュメントカテゴリのインデックストピックは、2つの目的を果たします。
- カテゴリに含まれるすべてのトピックの中央リストです。
- このプラグインに含まれるサイドバーは、インデックストピックのコンテンツで構成されます。
インデックストピックのフォーマット
インデックストピックには、好きなコンテンツを含めることができます。サイドバーが正しく機能するためには、ドキュメントトピックの箇条書きリスト（または複数の箇条書きリスト）を含める必要があります。これらは単純にリスト内のトピックURLにすることができます。その場合、サイドバーには各ドキュメントトピックの完全なタイトルが表示されます。
タイトルが数語よりも長い場合、サイドバーに完全なタイトルを表示するのは実用的ではない可能性があるため、特定のトピックの短いタイトルを設定するには、URLの前に短縮されたタイトルをコロン（:）で区切って追加します。コロンの前のすべてのテキストがサイドバーに表示され、トピックURLにリンクされます。
インデックストピックをセクションに分割し、それぞれの上に（任意のレベルの）見出しを持つ複数のリストを使用できます。これらはサイドバーにこれらのセクションで表示されます。
開始するためのインデックストピックの例を次に示します。
カテゴリの簡単な説明を任意で追加できます。
## セクション1
* 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 という文字列を追加すると、ドキュメント用にマークされたすべてのカテゴリ（つまり、インデックストピックが割り当てられているカテゴリ）が検索されます。
インデックス内の項目の最大数は、デフォルトで50に設定されている Max oneboxes per post サイト設定によって制御されます。50を超えるインデックス項目が必要な場合は、その設定の数値を増やしてください。
）
Obsidianで管理されているコンテンツで、ドキュメントを
