Discourseのドキュメントカテゴリ

混乱や難しさの原因は、インデックス トピックが特定の形式でなければならないことにあるのかもしれません。これはドキュメントに完全に明確には記載されていません(トップ投稿)。

このプラグインを自分でインストールし、指示に注意深く従いましたが、@dennisjbr が経験していたのと同じようには機能しませんでした。

メタの例にリンクするのではなく、必要な Markdown の例を示すと役立つかもしれません。なぜなら、唯一の重要なルールは、Markdown の箇条書き/番号付きリストがなければならないということです。ドキュメントには「リスト」とありますが、「リスト」という言葉には、Markdown 以外のリストを含む通常の英語の用法があります!

これはインデックス トピックとして機能します。

* https://meta.discourse.org/t/discourse-doc-categories/322376
* Some Arbitrary Text: https://meta.discourse.org/t/discourse-doc-categories/322376

これは機能しません。

https://meta.discourse.org/t/discourse-doc-categories/322376
Some Arbitrary Text: https://meta.discourse.org/t/discourse-doc-categories/322376

これ以外にも、Markdown の見出しを使用してセクションを作成したり、複数のリストを使用したりできますが、Markdown リストがない限り、サイドバーには何も表示されません。これは少し明白であり、他の誰もつまずかなかったかもしれませんが、私は Discourse、TC、およびプラグインに慣れているにもかかわらず(愚かかもしれませんが)つまずきました。

「いいね!」 4

元の投稿のこちらに、フォーマットされたインデックス トピックのより明確な例を追加しました: https://meta.discourse.org/t/discourse-doc-categories/322376#p-1584993-formatting-index-topics-4

そちらをご確認いただき、まだ解決できない場合はお知らせください。

「いいね!」 8

Hughさん、これで問題なさそうです!

「いいね!」 3

ドキュメントカテゴリにAIペルソナがあります。匿名のユーザー向けのAIペルソナの提供について、何か検討はありましたか?少なくとも、一時的な匿名チャットDMで利用できるようにすることは可能でしょうか?そもそも可能なのでしょうか?

インデックスの非常に下の方にあるページ(スクロールしないと表示されない)にアクセスすると、メインページも中央あたりの位置までスクロールされてしまいます。例えば、こちらのドキュメントアイテム のような場合です。

「いいね!」 2

お知らせいただきありがとうございます。今後、このようなことがないように対応を検討いたします。

「いいね!」 3

実際、文書化する際には「明白」だと考えるべきではありません。この種のフィードバックは、明確さを確保するためにあらゆる種類のプロジェクトにとって不可欠です。

書かれたものは通常、著者自身の深い理解により、著者にとっては意味があります。しかし、他の人にとっては、それほど明確ではないかもしれません。

私自身、「直感的」のような言葉は好きではありません。直感的であるためには、似たようなものを使用した経験がある場合にのみ直感的だからです。

「いいね!」 6

ありがとうございます!大変参考になりました。

皆さん、このプラグインで素晴らしい仕事をしました!!

NOOBなので、前もって謝罪します!しばらく自分で解決しようとしていましたが、どこにも解決策が見つかりませんでした。 :frowning:

このプラグインを、カテゴリレベルで個々のユーザープロジェクトを整理する方法として使用しようとしています。

たくさんの異なるユーザープロジェクトがあるフォーラムを作成しようとしています。元々はすべて「projects」カテゴリの下にあり、誰かが「projects」をクリックすると、すべてのサブカテゴリボックスが表示され、個々のプロジェクトが pretty UI のルックアンドフィールでリストアップされていました(sudo プロジェクトマーケットプレイス)。
しかし、そうすることで、個々のプロジェクトがカテゴリではなくサブカテゴリとして始まるため、その1レベルのデータ整理を失ってしまいます。

このプラグインを見つけたとき、カテゴリレベルですべてのプロジェクトを整理するのに最適だと考え、プロジェクト内のデータ整理を改善できると確信していたので、とても興奮しました。

そこで、個々のプロジェクトを個別のカテゴリ(fishing lure、project 2、project 3)として作成し、doc categories プラグインを使用して、すべてのプロジェクトの目次を作成しています。これにより、人々は新しく作成されたプロジェクトカテゴリをクリックし、doc cat プラグインによって実行され、ドロップダウンメニューを使用して、インデックストピックにリストすることを選択したサブカテゴリやトピックをナビゲートできます。

カテゴリを中央の列に表示して、「すべてのカテゴリ」ページのような表示にすることは可能ですか?

「projects」doc カテゴリをクリックすると、左側のメニューにすべてのプロジェクトがリストされ、さらに通常のサブカテゴリのようにメインフィードのボックスにも表示されるようにしたいです。この投稿には画像は1枚しか投稿できませんでしたが、左側のメニューにあるプロジェクトの画像と、トピック投稿が表示されている中央の領域にカテゴリボックスが表示されるようにしたいです。

ヘルプとガイダンスに感謝します。

「いいね!」 3

「相対リンク」(例:「/t/topic/463」)を追加していただけますでしょうか。これは、「ドメイン名」を変更する際に、あまり手間がかからず、非常に効果的だと思います。

「いいね!」 1

現在、それほど手間はかかりません。検索と置換 を実行するだけです。ドメインを切り替える頻度はどれくらいですか?

「いいね!」 2

これは、ここでMetaのドキュメントサブカテゴリに対して行ったことと同様のようです。

メインビューでサブカテゴリを確認でき、サイドバーにもリンクされています: Documentation - Discourse Meta

これを機能させるために、親ドキュメントカテゴリのインデックストピックを追加しました。これには各サブカテゴリへのリンクが含まれています: https://meta.discourse.org/t/documentation-index/315730。

これで、ご自身のインスタンスで適切なソリューションを見つけるのに役立ちますか?

「いいね!」 3

相対リンクはすでに機能しているので、作業が不要になるように追加するのはどうでしょうか。これらは結局のところ内部リンクであり、内部リンクがさまざまなTCおよびプラグインで機能するのと同様に、Discourseのパリティに貢献するでしょう。

「いいね!」 1

Hughさん、ありがとうございます!
サブカテゴリで行っていることは正しい方向ですが、私は主にUIで、サブカテゴリのように中央の列のボックスにカテゴリを表示させたいと考えていました。

結局、サブサブカテゴリプラグインを見つけてインストールしました。これで、サブカテゴリをグループ化するためにそのプラグインを使用しており、実際には「カテゴリ」として機能しています。なぜなら、その下に2つのレベルのデータ配布(サブサブカテゴリとトピック)があるからです。
これにより、ユーザープロジェクト内のデータ配布量と組織レベルを増やすという私の主な目標が達成されました。したがって、サブサブカテゴリとプラグインを組み合わせて、スタブカテゴリレベルで両方の長所を得ています。
ダックカテゴリプラグインだけでプロジェクトカテゴリを作成しようとしましたが、左側のメニューしかなく、ユーザーが閲覧できるものが中央にないUIは気に入らなかったのです。そのため、(カテゴリであるプロジェクト)を、サブカテゴリが通常できるような(すべてのプロジェクトという)カテゴリ内に表示させたかったのです。(前の投稿のモックアップの画像を参照)

こちらがプロジェクトのメインカテゴリです:BETA - 他のサブカテゴリがあります

そして、こちらが「サブサブカテゴリ」の働きです。サブカテゴリをカテゴリに変換しています。
インデックストピックの簡単なナビゲーションと共に。


皆さんが行っているすべての作業に改めて感謝します。
今回の投稿で少しは明確になったことを願っています。:frowning:

私たちは非常に満足のいく解決策を見つけました。それは2つのプラグインの組み合わせです。

「いいね!」 2

ご自身に合った解決策が見つかって嬉しいです!

「いいね!」 2

レガシーのドキュメントプラグインと比較した場合、このプラグインの利点は何ですか?

レガシープラグインでは、タグを維持している限り、任意のカテゴリにドキュメントを配置できます。しかし、現在はすべてのドキュメントトピックが単一のカテゴリの下に配置される必要があるようです。これは正しいですか?その場合、既存のドキュメントの一部が特定のグループ/カテゴリ(例:スタッフのみ利用可能)に影響される可能性があるため、コンテキストが失われることになります。

両アプローチの違い、このアプローチを選択した理由、そしてレガシープラグインと新しいプラグインのギャップをどのように埋めるつもりなのかを明確にしていただけますか?:heart:

「callouts」に関するOTコメント

HedgeDocは、callouts(彼らは[alert areas](https://demo.hedgedoc.org/features#Alert-Area)と呼んでいます)をサポートするために、次のMarkdown拡張機能を使用しています。

### Alert Area

:::success
はい :tada:
:::

:::info
これはメッセージです :mega:
:::

:::warning
注意してください :zap:
:::

:::danger
ああ、なんてこった! :fire:
:::

これは次のように表示されます

(これは、クラスが与えられればCSSで簡単にスタイル設定できるでしょう)。

怠惰とAIに関するOTコメント

手動でコピー&ペーストできたわずか3行のMarkdownのために、どれだけの過剰なエネルギーと水が消費されたか想像できますか? :slightly_frowning_face:

相対URLと絶対URLに関するOTコメント

実際には、トピックURLをコピー&ペーストする方が簡単です。ドメインを変更する場合は、トピックをエクスポート/インポートすることになり、Discourseがドメインを自動的に置き換えてくれます。


少し実験した結果、私の(一時的な)結論は次のとおりです。

  1. カテゴリの説明トピックを使用してドキュメントインデックスを提供することは有用です(例:https://ps.zoethical.org/t/singular-docs/8350)。
  2. トップレベルのドキュメントカテゴリを使用すると、サブカテゴリを使用してドキュメントサイドバーインデックスを変更できます(例:「Install Ruby」はhttps://ps.zoethical.org/c/docs/204の「How-to Guides」の下に表示されますが、https://ps.zoethical.org/c/docs/sysadmin/205の「Tips & Hints」の下に表示されます)。これにより、優れた構造を提供できます(ここにある#documentationを参照。サブカテゴリがボックスとして表示されます)。
  3. ドキュメントトピックは、プライベートスペースを含むフォーラムのどこにでも配置できます。ただし、ドキュメントインデックスはその存在を明らかにします。
  4. サイドバーは現在不安定です。
    • 時々URLが表示され、時々タイトルが表示されます。
    • 時々プレフィックステキストのみが表示されます。
    • ログアウトすると、一部のインデックス付きトピックが欠落する可能性があります。
  5. レガシードキュメントプラグインから移行する場合、ドキュメントリンクはサイドバーのカスタムセクションに再作成する必要があります(ただし、プラグイン設定でドキュメントカテゴリを変更して自動生成するか、/docsパーマリンクを作成/変更してそのカテゴリにリンクすることができます)。
  6. 「フォーラムに戻る」リンクは奇妙に感じます。ドキュメントトピックはフォーラムトピックのままであり、私たちはまだそこでドキュメントを読んでいるからです!
  7. フィルタリングは、ドキュメントトピックが属する(サブ)カテゴリ名をまだ考慮していません。
「いいね!」 3

スクロールバーが表示されている場合に、UIに小さなバグが発生するようになりました。

また、この「フィルター」検索ボックスは、結果がない場合に尋ねるのではなく、デフォルトで現在のカテゴリ内のカスタム検索クエリにする方がはるかに効果的だと思います。タイトルは非常に短いため、ほとんどの場合、慣れていないユーザーが入力するものはヒットしません。

しかし、通常の「フォーラム」サイドバーが失われているため、フォーラムに戻るというのは理にかなっています。

「いいね!」 1

サイドバーが表示されない原因が、ナビゲーションメニューの設定が「ヘッダー ドロップダウン」ではなく「サイドバー」になっていたためだと気づくまで時間がかかりました。サイドバーが表示されないという方も、それが原因かもしれません。

今度は、ここで見られるようなカテゴリヘッダーとサブカテゴリボックスを追加する方法を理解しようとしていますが、行き詰まっています。

それを有効/無効にする設定が見当たらず、残念ながら表示されないようです。
何かアイデアがあれば、教えていただけると幸いです。
よろしくお願いします。

「いいね!」 1
「いいね!」 4

タグによるフィルタリングがないため、プラグインの有用性が大幅に低下しています。1つのドキュメントが複数のカテゴリに適用されるコミュニティでは、タグによるフィルタリングが不可欠です。

たとえば、「着陸装置アセンブリ」という名前のドキュメントは、複数の航空機モデルに適用され、複数のタグを含むこともあります。タグフィルタリングを使用すると、適切なものを簡単に見つけることができます。

ドキュメントのカテゴリを1つだけ選択する必要がある場合、そのドキュメントが他のいくつかのカテゴリにも属するべき場合はどうすればよいでしょうか?

タグは、自動インデックスであったものが、現在では手動で作成および保守する必要があるものになりました。

「いいね!」 6