Discourse Docs Kartenfilter

[Discourse]

	Zusammenfassung	Discourse Docs Card Filter ist für die Verwendung mit dem Discourse Docs Plugin gedacht und ermöglicht es Ihnen, „Karten" zu platzieren, die als anklickbare Filter fungieren, um bei Betreten der /docs-Seite durch Ihre Benutzer schnellere Filterergebnisse zu erzielen.
	Vorschau	Vorschau im Discourse Theme Creator
	Repository-Link	https://github.com/discourse/discourse-docs-card-filter
	Neu bei Discourse Themes?	Anfängerleitfaden zur Verwendung von Discourse Themes

Dieses Theme-Komponente installieren

Da dies eine official Theme-Komponente ist, die vom Discourse-Team gepflegt wird, können Support, bug, ux und #feature-Anfragen in den jeweiligen Kategorien hier auf Meta gestellt und mit dem entsprechenden Theme-Komponenten-Tag versehen werden. Klicken Sie auf einen der folgenden Links, um einen neuen Beitrag zu starten.

 Support  Bug  UX  Feature

Funktionen

Das Obige würde mit diesen Einstellungen im docs-Plugin gerendert werden:

Einstellungen

Sie können benutzerdefinierte Symbole für jede Kategorie- oder Tag-Kartenfilter auswählen. Sie können auch zulassen, dass Kategorienbeschreibungen in den Kategorienkartenfiltern gerendert werden.

Name	Beschreibung
category icons	Wählen Sie Symbole und die Reihenfolge der Themen für entsprechende Kategorien-IDs. Beispiel: ‘6,heart,title-asc’ weist das Herz-Symbol der Kategorie 6 zu und ordnet die Themenliste nach aufsteigender Aktivität. HINWEIS: Die Reihenfolge kann (title,activity)-(asc/desc) sein.
category description	Aktivieren Sie die Anzeige der Kategorienbeschreibung in den Kategorienkartenfiltern für die Docs-Seite.
tag icons	Wählen Sie Symbole und die Reihenfolge der Themen für entsprechende Tag-Slugs. Beispiel: ‘featured,heart,activity-desc’ weist das Herz-Symbol dem Tag ‘featured’ zu und ordnet die Themenliste nach absteigender Aktivität. HINWEIS: Die Reihenfolge kann (title,activity)-(asc/desc) sein.

Übersetzung	Standard
topics	Themen
topic	Thema

Von uns gehostet? Theme-Komponenten können in unseren Standard-, Business- und Enterprise-Plänen verwendet werden.

[downey (Michael Downey)]

Vielen Dank, dass du das erstellt hast! Stimmt es, dass die Karte für eine private Kategorie nicht über dem Suchfeld erscheint, wenn ein Benutzer keine Anzeigeberechtigungen für diese (private) Kategorie hat? (Oder, wie ich vermute, auch nicht in der Seitenleiste, aber ich möchte nur bestätigen, dass das Verhalten konsistent ist.)

[jordan.vidrine]

Dies sollte der Fall sein, da wir die Kategorieninformationen aus folgendem Code erhalten:

@discourseComputed("category")
  categoryInfo(category) {
    return this.site.categories.findBy("id", category.id);
  },

Soweit ich weiß, gibt this.site.categories nur diejenigen zurück, die der aktuelle Benutzer einsehen kann.

[downey (Michael Downey)]

Ausgezeichnet. Das wird ein wirklich benutzerfreundliches Werkzeug für unsere verschiedenen Arbeitsgruppen sein, die schnellen Zugriff auf ihre Referenzmaterialien benötigen und schnell zwischen Gruppe A und Gruppe B usw. unterscheiden wollen. Danke!

[MarcP]

Ist es möglich, dass der Zähler auf /docs Themen nicht zählt, die erst nach der Erstellung dieser Kategorie dorthin verschoben wurden?

Ich habe gerade eine neue Kategorie erstellt, sie zu den Docs hinzugefügt und einige Themen dorthin verschoben, aber der Zähler zeigt weiterhin „0 Themen" an.

EDIT: Es scheint, als würde es einfach etwas dauern, bis er aktualisiert wird.

[Nick_Chomey]

Gibt es eine Möglichkeit, die Sortierreihenfolge für die Karten zu ändern, auch wenn dies eine Codeänderung erfordert? Ich hätte sie gerne alphabetisch und nicht nach Thema-Anzahl. Danke!

[mallen (Mike)]

Hallo zusammen. Docs und diese Erweiterung von Docs sind fantastisch. Nur eine Sache. Kann mir jemand dabei helfen, diese Karten irgendwie zum top_menu oder zu den homepage-Bereichen hinzuzufügen? Es wäre großartig, eine Standard-Homepage mit “Neueste” als Standard zu haben, aber diese Karten oben zu haben. Dann würde das Klicken auf eine Karte zur gefilterten Docs-Seite führen.

Außerdem habe ich ein weiteres Plugin (Suchfeld), das sich im top_menu-Bereich befindet. Ich konnte nicht herausfinden, wie ich die Reihenfolge ändern kann, wenn mehrere Plugins in diesem Bereich angezeigt werden.

Danke.

[jrgong]

Hallo @jordan.vidrine

Wir haben den TC ausprobiert und er funktioniert hervorragend für Ihren Anwendungsfall. Jetzt können wir eine Wissensdatenbank erstellen.

In diesem Zusammenhang habe ich eine Frage: Können Sie Workarounds vorschlagen, um jeder Kategorie- oder Tag-Karte einige Parameter hinzuzufügen? Auf diese Weise möchten wir &order=title anhängen, um die Sortierung für jede einzelne Kategorie- oder Tag-Karte zu beeinflussen.

PS:

[jordan.vidrine]

Hmmm.. Ich bin mir nicht sicher.

Wie möchten Sie, dass die Kategorie- und Tag-Karten sortiert werden?

[jrgong]

Hallo Jordan

Wir könnten einen Sortierparameter in den Theme-Einstellungen für category icons hinzufügen. Zum Beispiel könnten wir bei 6,heart einen zusätzlichen Sortierbefehl hinzufügen, z. B. um nach dem Thema aufsteigend zu sortieren, wäre es 6,heart,title-asc.

Beim Öffnen der Kategoriekarte würden dann einfach die Dokumentationsparameter angehängt, wie z. B.: /docs?ascending=true&category=71&order=title

Was hältst du davon?

[jordan.vidrine]

Obwohl es möglich ist, dass dies auf einer Website gut funktionieren könnte, gibt es ohne viel Feedback zu diesem Thema, das sich auf die Fähigkeit konzentriert, die Karten zu sortieren, nicht unbedingt das Gefühl, dass die Zeit, die für die ordnungsgemäße Funktion aufgewendet wird, derzeit gerechtfertigt ist.

Das heißt, wir ermutigen PRs zu Komponenten sowie das Forken einer Komponente, um sie auf Ihre eigene Weise zu verwenden!

Sie können gerne einen PR mit dieser Funktionalität erstellen oder ihn für sich selbst forken.

[Ahmed_Gagan]

@jordan.vidrine

Das gesagt, wir ermutigen PRs für Komponenten

Ich kann eine PR für diese Anfrage erstellen, da @jrgong die Arbeit sponsert.

[jrgong]

@Nick_Chomey

Gibt es eine Möglichkeit, die Sortierreihenfolge für die Karten zu ändern, auch wenn dies eine Codeänderung erfordert? Ich hätte gerne, dass sie alphabetisch und nicht nach Thema-Anzahl sortiert wird. Danke!

Ich pushe das hier mal hoch! Konnte das schon jemand herausfinden?

[Nick_Chomey]

Meine Lösung war, die Karten auszuschalten (da ich zu viele Kategorien habe, als dass sie nützlich wären) und die Sortierreihenfolge von Docs zu ändern. Mehr dazu erfahren Sie hier Modifying Discourse Docs to only allow for sorting by Title - #2 by Nick_Chomey

[jordan.vidrine]

Wir begrüßen definitiv nützliche PRs für unsere Komponenten!

Wenn Sie die Möglichkeit hinzufügen würden, diese Karten zu sortieren, würde ich vorschlagen, eine neue Werteliste zu erstellen, in der Sie die Reihenfolge der Karten nach Kategorie-ID und Tag-ID angeben können. Ich würde sie nicht zu einer bereits vorhandenen Werteliste für etwas Unverwandtes hinzufügen.

[Lishuo_Lin]

@jordan.vidrine Vielen Dank für das Design der großartigen Komponente. Gibt es eine Möglichkeit, die Komponente auf Mobilgeräten zu deaktivieren, sie aber auf dem PC/Mac anzuzeigen?

[jrgong]

Ist in Ordnung. Aber könnten Sie zumindest die Einstellung für Kategorie-Icons auf eine Werteliste umstellen? Es ist viel einfacher, die Karten in mehreren Textfeldern zu verwalten als in einem einzigen.

Und als vorübergehende Lösung wäre es sehr hilfreich, wenn jede Dokumentationskarte eine CSS-Klasse mit der jeweiligen Kategorie oder dem jeweiligen Tag-Slug hätte.

Vorher: <a>
Nachher: <a class="docs-card-box [category-slug] category-card">

[jordan.vidrine]

Das ist ein guter Vorschlag

[jrgong]

Lass mich wissen, wenn du Hilfe beim Testen brauchst, ich bin gerne dein Versuchskaninchen

[jordan.vidrine]

Nachdem ich weiter darüber nachgedacht habe, habe ich mich dagegen entschieden, die Einstellung für Kategoriensymbole auf eine Werteliste zu ändern, da dies ohne eine Fallback-Option dazu führen würde, dass die Komponenten der aktuellen Benutzer kaputtgehen.

Das Hinzufügen eines Fallbacks würde so aussehen, dass geprüft wird, ob der Benutzer die Symbole entweder im aktuellen Feld oder im neuen Wertelisten-Feld festgelegt hat, und ich denke, das ist zu umständlich, um es dieser Komponente hinzuzufügen, da dies eine weitere Einstellungsebene hinzufügen und zu möglicher Verwirrung führen würde.

Was die Klassenzusätze betrifft, ist das eine großartige Idee, aber ich habe keinen Zeitplan dafür, wann dies hinzugefügt wird, da es wichtigere Dinge gibt, die meine Aufmerksamkeit erfordern.

Das heißt, wenn möglich, freuen wir uns auch über PRs für unsere Komponenten, wir sind schließlich Open Source!