Discourse-Dokumentenkategorien

[pacharanero (Marcus Baw)]

Ich denke, die Verwirrung und Schwierigkeit könnten darin liegen, dass das Index-Thema in einem bestimmten Format vorliegen muss, und dies ist in der Dokumentation nicht ganz klar angegeben (Top-Post).

Ich hatte dieses Plugin selbst installiert und die Anweisungen sorgfältig befolgt, aber es funktionierte nicht ganz so, wie @dennisjbr es erlebte.

Es könnte hilfreich sein, ein Beispiel für das erforderliche Markdown zu geben, anstatt auf das Meta-Beispiel zu verlinken, da die einzige wichtige Regel lautet, dass es eine Markdown-Aufzählung/nummerierte Liste geben MUSS. Die Dokumentation besagt “eine Liste”, aber das Wort “Liste” hat eine gewöhnliche englische Bedeutung, die auch Nicht-Markdown-Listen einschließt!

Dies funktioniert als Index-Thema:

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

Dies funktioniert nicht:

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

Darüber hinaus können Sie Markdown-Überschriften verwenden, um Abschnitte zu erstellen und mehrere Listen zu verwenden, aber nichts wird in der Seitenleiste angezeigt, es sei denn, es gibt eine Markdown-Liste. Ich schätze, das ist ein bisschen offensichtlich und hat vielleicht niemanden sonst gestolpert, aber es hat mich (dumm oder nicht) erwischt und ich bin kein Neuling bei Discourse, TCs und Plugins.

[hugh (Hugh Lashbrooke)]

Ich habe ein expliziteres Beispiel für ein formatiertes Indexthema zum ursprünglichen Beitrag hier hinzugefügt: https://meta.discourse.org/t/discourse-doc-categories/322376#p-1584993-formatting-index-topics-4

Schauen Sie sich das an und lassen Sie mich wissen, ob Sie es immer noch nicht richtig hinbekommen.

[pacharanero (Marcus Baw)]

Sieht gut aus für mich @hugh!

[MarcP]

Ich habe eine KI-Persona für meine Dokumentationskategorie. Gab es schon Überlegungen, eine KI-Persona für Anonyme verfügbar zu machen? Ich denke zumindest an eine temporäre, anonyme Chat-DM? Ist das überhaupt möglich?

[MarcP]

Wenn Sie eine Seite besuchen, die sehr weit unten im Index steht (zum Scrollen erforderlich ist), wird auch die Hauptseite an eine Position irgendwo in der Mitte gescrollt: zum Beispiel auf diesem Dokumenteneintrag

[hugh (Hugh Lashbrooke)]

Danke, dass Sie darauf aufmerksam gemacht haben! Wir werden sehen, was wir tun können, um dies in Zukunft zu verhindern.

[Heliosurge (Dan DeMontmorency)]

@pacharanero

Markdown-Überschriften zum Erstellen von Abschnitten und zur Verwendung mehrerer Listen, aber nichts wird in der Seitenleiste angezeigt, es sei denn, es gibt eine Markdown-Liste. Ich schätze, das ist ein bisschen offensichtlich und hat vielleicht niemanden sonst gestört, aber es hat mich erwischt (dumm oder nicht) und ich bin kein Neuling bei Discourse, TCs und Plugins.

Tatsächlich sollte man niemals davon ausgehen, dass etwas “offensichtlich” ist, wenn man etwas dokumentiert. Diese Art von Feedback ist für jedes Projekt unerlässlich, um Klarheit zu gewährleisten.

Alles, was geschrieben wird, ergibt für den Autor aufgrund seines tiefen Verständnisses dessen, was er geschrieben hat, normalerweise Sinn. Für andere hingegen ist es möglicherweise weniger klar.

Ich selbst mag Begriffe wie “intuitiv” nicht, da etwas nur dann intuitiv ist, wenn man Erfahrungen mit etwas Ähnlichem hat.

[dennisjbr]

Danke! Das hilft sehr.

[James_Harakaly]

Tolle Arbeit aller Beteiligten an diesem Plugin!!

NOOB hier, also entschuldige ich mich im Voraus! Ich habe versucht, das selbst eine Weile herauszufinden, aber ich kann nirgends eine Lösung finden.

Ich versuche, dieses Plugin zu verwenden, um einzelne Benutzerprojekte auf Kategorieebene zu organisieren.

Wir versuchen, ein Forum zu erstellen, das eine Reihe verschiedener Benutzerprojekte enthält. Ursprünglich hatten wir sie alle unter der Kategorie „Projekte“ zusammengefasst. Wenn jemand auf Projekte klickte, sah er alle Unterkategorie-Boxen, die alle einzelnen Projekte in einer ansprechenden Benutzeroberfläche auflisteten (quasi ein Projekt-Marktplatz).
Aber dadurch verlieren wir diese eine Ebene der Datenorganisation, da die einzelnen Projekte als Unterkategorien und nicht als Kategorien beginnen.

Ich war super begeistert, als ich dieses Plugin fand, weil ich dachte, es wäre perfekt, um alle Projekte auf Kategorieebene zu organisieren und uns eine bessere Datenorganisation innerhalb der Projekte zu ermöglichen.

Ich erstelle jetzt also einzelne Projekte als einzelne Kategorien (Angelköder, Projekt 2, Projekt 3) und verwende das Doc-Categories-Plugin, um im Grunde ein Inhaltsverzeichnis aller Projekte zu erstellen, damit die Leute auf die neue Projektkategorie klicken können, die vom Doc-Cat-Plugin verwaltet wird, und das Dropdown-Menü verwenden, um durch die Unterkategorien und Themen zu navigieren, die wir im Index-Thema auflisten möchten.

Gibt es eine Möglichkeit, Kategorien in der mittleren Spalte anzuzeigen, sodass sie der Ansicht der Seite „Alle Kategorien“ im normalen Discourse-Feed ähneln?

Ich möchte, dass beim Klicken auf die Projekt-Doc-Kategorie alle Projekte links im Menü aufgelistet werden, aber dann auch in den Boxen im Hauptfeed angezeigt werden, genau wie es normalerweise mit Unterkategorien geschieht. Ich durfte nur ein Bild in diesem Beitrag posten, also habe ich das Bild der Projekte im Menü auf der linken Seite eingefügt und möchte, dass die Kategorie-Boxen in der Mitte angezeigt werden, wo mein Themenbeitrag angezeigt wird.

Vielen Dank im Voraus für jede Hilfe und Anleitung.

[qianping_chen (rouin)]

Können Sie „relative Links“ hinzufügen, wie z. B. „/t/topic/463“, was für die Änderung von „Domainnamen“ ohne viel Aufwand sehr effektiv wäre.

[MarcP]

@qianping_chen

was sehr effektiv wäre, um „Domainnamen“ ohne viel Aufwand zu ändern.

Es ist derzeit keine große Arbeit. Führen Sie einfach eine Suchen und Ersetzen durch – wie oft wechseln Sie die Domains?

[hugh (Hugh Lashbrooke)]

@James_Harakaly

Ich möchte, dass, wenn ich auf die Dokumentationskategorie Projekte klicke, alle Projekte im Menü auf der linken Seite aufgelistet werden, aber dann auch in den Feldern im Hauptfeed angezeigt werden, genau wie es normalerweise mit Unterkategorien geschieht.

Das klingt, als hätten wir hier auf Meta für die Dokumentationsunterkategorien dasselbe gemacht.

Sie können die Unterkategorien in der Hauptansicht sehen und sie sind auch in der Seitenleiste verlinkt: Documentation - Discourse Meta

Damit dies funktioniert, haben wir einen Index-Thread für die übergeordnete Dokumentationskategorie hinzugefügt, der die Links zu jeder Unterkategorie enthält: Documentation Index.

Hilft Ihnen das, eine gute Lösung für Ihre Instanz zu finden?

[Heliosurge (Dan DeMontmorency)]

@MarcP

@rouin

was sehr effektiv wäre, um „Domainnamen“ ohne viel Aufwand zu ändern.

Es ist derzeit nicht viel Arbeit. Führen Sie einfach eine Suche und Ersetzung durch – wie oft wechseln Sie die Domains?

Da relative Verknüpfungen bereits funktionieren. Warum nicht hinzufügen und jeglichen unnötigen Aufwand eliminieren? Dies sind schließlich interne Links und dies würde zur Parität von Discourse beitragen, da interne Links auch eine Vielzahl von TC und Plugins unterstützen.

[James_Harakaly]

Danke Hugh!
Was ihr mit den Unterkategorien macht, ist auf dem richtigen Weg, aber ich wollte hauptsächlich, dass die Benutzeroberfläche Kategorien in den Feldern in der mittleren Spalte anzeigt, so wie sie es mit Unterkategorien tut.

Ich habe schließlich das Unter-Unterkategorie-Plugin gefunden und installiert. Jetzt benutze ich dieses Plugin, um mir zu helfen, Unterkategorien zu gruppieren, damit sie wirklich als “Kategorien” fungieren, da wir zwei Ebenen der Datenverteilung unter ihnen haben: Unter-Unterkategorien und Themen.
Dies hat mein Hauptziel erreicht, die Datenverteilung und die Organisationsebenen innerhalb unserer Benutzerprojekte zu erhöhen. Jetzt verwende ich die Unter-Unterkategorien zusammen mit dem Plugin, um das Beste aus beiden Welten auf der Ebene der Stub-Kategorien zu erhalten.
Ich habe versucht, die Projektkategorie nur mit dem Duck-Kategorien-Plugin zu erstellen, aber uns hat die Benutzeroberfläche nicht gefallen, dass nur ein Menü links und nichts in der Mitte zum Durchsuchen für den Benutzer vorhanden ist. Deshalb wollte ich, dass die (Projekte, die Kategorien sind) innerhalb einer Kategorie (alle Projekte) angezeigt werden, wie es Unterkategorien normalerweise können. (mein Bild im letzten Beitrag meines Mockups)

Hier ist die Hauptkategorie der Projekte: BETA - wird andere Unterkategorien haben

und hier sind die “Unter-Unterkategorien” am Werk, die die Unterkategorie in eine Kategorie verwandeln.
zusammen mit der einfachen Navigation des Index-Themas.

Vielen Dank nochmals für all die Arbeit, die ihr leistet.
Ich hoffe, ich war in diesem Beitrag etwas klarer.

Ich habe eine Lösung gefunden, mit der wir sehr zufrieden sind, und es ist eine Kombination aus den beiden Plugins.

[hugh (Hugh Lashbrooke)]

Es freut mich, dass Sie eine Lösung gefunden haben, die für Sie funktioniert!

[hellekin]

Was ist der Vorteil dieses Plugins gegenüber dem Legacy-Docs-Plugin?

Im Legacy-Plugin kann ich Dokumente in jeder Kategorie haben, solange ich Tags pflege. Jetzt scheint es, dass alle Dokumentationsthemen unter einer einzigen Kategorie leben müssen. Stimmt das? In diesem Fall geht der Kontext verloren, da einige (bestehende) Dokumentationen für bestimmte Gruppen/Kategorien relevant sein könnten (z. B. nur für Mitarbeiter verfügbar).

Könnten Sie bitte die Unterschiede zwischen den beiden Ansätzen erläutern, warum Sie diesen Ansatz gewählt haben und wie Sie die Lücke zwischen dem Legacy-Plugin und dem neuen schließen wollen?

OT-Kommentar zu "Callouts"

@MarcP

Verschiedene Arten von Callouts

HedgeDoc verwendet die folgende Markdown-Erweiterung zur Unterstützung von Callouts (sie nennen es Alert Areas):

### Alert Area

:::success
Ja :tada:
:::

:::info
Das ist eine Nachricht :mega:
:::

:::warning
Vorsicht :zap:
:::

:::danger
Oh nein! :fire:
:::

wird angezeigt

(dies wäre mit CSS, wenn eine Klasse gegeben ist, ziemlich einfach zu stylen).

OT-Kommentar zu Faulheit und KI

@Jagster

Ich bin faul, also habe ich das nicht manuell gemacht, aber ich habe die KI des Forums benutzt.

Können Sie sich die überschüssige Energie und das Wasser vorstellen, die für nur drei Zeilen Markdown verbraucht wurden, die Sie manuell kopieren und einfügen hätten können?

OT-Kommentar zu relativen vs. absoluten URLs

@qianping_chen

Können Sie “relative Links” hinzufügen, wie z. B. “/t/topic/463”, was bei der Änderung von “Domainnamen” ohne viel Aufwand sehr effektiv wäre.

Tatsächlich ist das Kopieren und Einfügen von Topic-URLs einfacher, und wenn Sie Domains ändern, würden Sie wahrscheinlich Topics exportieren/importieren, und Discourse würde die Domain für Sie ersetzen.

---

Nachdem ich ein wenig experimentiert habe, hier meine (vorläufigen) Schlussfolgerungen:

1. Die Verwendung des Kategoriebeschreibungs-Topics zur Bereitstellung eines Dokumentationsindexes ist nützlich (z. B. Singular Docs - Documentation - petites singularités).
2. Eine Top-Level-Kategorie “Dokumentation” ermöglicht die Verwendung von Unterkategorien zur Änderung des Sidebar-Indexes der Dokumentation (z. B. erscheint “Ruby installieren” unter “Anleitungen” in Documentation - petites singularités, aber unter “Tipps & Tricks” in Sysadmin Docs - petites singularités), um eine gute Struktur zu bieten (siehe Documentation hier, die Unterkategorien als Boxen anzeigt).
3. Dokumentationsthemen können überall im Forum sein, auch in privaten Bereichen – obwohl der Dokumentationsindex dann ihre Existenz offenbart.
4. Die Seitenleiste ist derzeit instabil:
   • manchmal zeigt sie URLs, manchmal den Titel
   • manchmal nur Präfixtext
   • wenn abgemeldet, fehlen möglicherweise einige indizierte Themen
5. Bei der Migration vom Legacy-Docs-Plugin müssen die Docs-Links im benutzerdefinierten Abschnitt der Seitenleiste neu erstellt werden (könnten aber automatisch generiert werden, indem /docs in der Plugin-Einstellung auf die Dokumentationskategorie geändert wird, oder indem der Permalink /docs erstellt/geändert wird, um auf diese Kategorie zu verweisen).
6. Der Link “Zurück zum Forum” fühlt sich seltsam an, da Dokumentationsthemen Forumsthemen bleiben: Wir sind immer noch da und lesen Docs!
7. Die Filterung berücksichtigt noch nicht die Namen der (Unter-)Kategorien, zu denen das Dokumentationsthema gehört.

[MarcP]

Das neueste Update führt einen kleinen UI-Bug ein, wenn eine Scrollleiste vorhanden ist.

Ich denke auch, dass diese „Filter“-Suchbox viel effektiver wäre, wenn sie standardmäßig eine benutzerdefinierte Suchanfrage in der aktuellen Kategorie wäre (anstatt danach zu fragen, wenn es kein Ergebnis gibt). Die Titel sind sehr kurz, sodass in den meisten Fällen kein Treffer für etwas erzielt wird, das ein nicht vertrauter Benutzer dort eingeben würde.

@hellekin

• Der Link „Zurück zum Forum“ fühlt sich seltsam an, da Dokumentationsthemen Forumsthemen bleiben: Wir lesen dort immer noch Dokumente!

Aber Sie verlieren die normale „Forum“-Seitenleiste, sodass „Zurück zum Forum“ hier irgendwie Sinn ergibt.

[kakaroto (Youness Alaoui)]

Es hat eine Weile gedauert, bis ich herausfand, dass die Seitenleiste nicht angezeigt wurde, weil die Einstellung für das Navigationsmenü aus irgendeinem Grund auf „Header-Dropdown“ statt auf „Seitenleiste“ gesetzt war. Für diejenigen, die die Seitenleiste auch nicht zum Erscheinen bringen konnten, könnte das der Grund sein.

Jetzt stecke ich fest und versuche herauszufinden, wie ich die Kategorieüberschrift und die Unterkategorie-Boxen hinzufügen kann, wie wir sie hier sehen:

Ich kann keine Einstellung sehen, um das zu aktivieren/deaktivieren, und es scheint leider einfach nicht erscheinen zu wollen.
Wenn jemand Ideen hat, würde ich mich über Einblicke freuen.
Danke.

[Moin]

Category Banners

Summary Category Banners uses existing category details to create banners for your category pages (for tags check out Discourse Tag Banners). Preview Preview on Discourse Theme Creator Repository Link https://github.com/discourse/discourse-category-banners New to Discourse Themes? Beginner’s guide to using Discourse Themes Install this theme component Features Category Banners uses existing category details to cr…

Display boxes for subcategories above topic list

This guide explains how to display boxes for subcategories above the topic list in Discourse. Required user level: Administrator (or moderator if the moderators manage categories and groups setting is enabled) There are two ways to display a list of sub-categories within the parent category: in boxes with only the name, logo, and description in boxes with name, logo, and a list of some featured topics You can enable these styles by visiting the parent cate…

[omarfilip]

Das Fehlen einer Filterung nach Tags verringert die Nützlichkeit des Plugins erheblich. In einer Community, in der ein Dokument für mehrere Kategorien gelten kann, ist die Filterung nach Tags unerlässlich.

Ein Dokument mit dem Namen „Landing Gear Assembly“ (Montage des Fahrwerks) gilt beispielsweise für mehrere Flugzeugmodelle und kann auch mehrere Tags enthalten. Mit der Tag-Filterung ist es sehr einfach, das richtige zu finden.

Wenn Sie ein Dokument einer Kategorie zuordnen müssen, was tun Sie, wenn dasselbe Dokument auch in mehreren anderen Kategorien aufgeführt werden sollte?

Tags waren der automatische Index, der nun manuell erstellt und gepflegt werden muss.