Discourse Docs Card Filtre

[Discourse]

	Résumé	Discourse Docs Card Filter est conçu pour être utilisé avec le plugin Discourse Docs et vous permet d’insérer des « Cartes » qui agissent comme un filtre cliquable pour obtenir des résultats de filtrage plus rapides lorsque vos utilisateurs accèdent à la page /docs.
	Aperçu	Aperçu sur Discourse Theme Creator
	Lien vers le dépôt	https://github.com/discourse/discourse-docs-card-filter
	Nouveau sur les thèmes Discourse ?	Guide pour débutant sur l’utilisation des thèmes Discourse

Installer ce composant de thème

Comme il s’agit d’un composant de thème #officiel maintenu par l’équipe Discourse, les demandes de Support, de bug, d’amélioration de l’expérience utilisateur (ux) et de nouvelles fonctionnalités (#feature) peuvent être soumises dans les catégories respectives ici sur Meta, en les étiquetant avec la balise de composant de thème appropriée. Cliquez sur un lien ci-dessous pour en créer un.

 Support  Bug  UX  Fonctionnalité

Fonctionnalités

Ce qui précède serait rendu avec ces paramètres dans le plugin docs :

Paramètres

Vous pouvez sélectionner des icônes personnalisées pour chaque filtre de carte de catégorie ou d’étiquette. Vous pouvez également autoriser l’affichage des descriptions de catégorie dans les filtres de carte de catégorie.

Nom	Description
icônes de catégorie	Choisissez des icônes et l’ordre des sujets pour les IDs de catégorie correspondants. Par exemple, ‘6,heart,title-asc’ attribue l’icône cœur à la catégorie 6 et trie la liste des sujets par activité croissante. NOTE : l’ordre peut être (titre,activité)-(asc/desc)
description de catégorie	Active l’affichage de la description de la catégorie dans les filtres de carte de catégorie pour la page docs.
icônes d’étiquette	Choisissez des icônes et l’ordre des sujets pour les identifiants d’étiquette correspondants. Par exemple, ‘featured,heart,activity-desc’ attribue l’icône cœur à l’étiquette featured et trie la liste des sujets par activité décroissante. NOTE : l’ordre peut être (titre,activité)-(asc/desc)

Traduction	Défaut
topics	Sujets
topic	Sujet

Hébergé par nous ? Les composants de thème sont disponibles pour utilisation sur nos plans Standard, Business et Enterprise.

[downey (Michael Downey)]

Merci d’avoir créé cela ! Est-il vrai que si un utilisateur n’a pas les permissions de visualisation sur une catégorie (privée), la carte de cette catégorie privée n’apparaîtra pas au-dessus de la zone de recherche ? (Ou je suppose dans la barre latérale, mais je veux simplement confirmer que le comportement est cohérent.)

[jordan.vidrine]

Cela devrait être le cas, car nous récupérons les informations de la catégorie depuis :

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

À ma connaissance, this.site.categories ne renverra que celles que l’utilisateur actuel peut voir.

[downey (Michael Downey)]

Excellent. Cela en fera un outil vraiment facile à utiliser pour les membres de nos différents groupes de travail qui souhaitent accéder rapidement aux documents de référence de leur(s) groupe(s) et filtrer rapidement le Groupe A du Groupe B, etc. Merci !

[MarcP]

Est-il possible que le compteur sur /docs ne prenne pas en compte les sujets déplacés dans cette catégorie après sa création ?

Je viens de créer une nouvelle catégorie, d’y ajouter des documents et de déplacer quelques sujets, mais le compteur indique toujours « 0 sujet ».

EDIT : il semble que la mise à jour prenne simplement un peu de temps.

[Nick_Chomey]

Y a-t-il un moyen de modifier l’ordre de tri des cartes, même si cela nécessite de modifier le code ? Je voudrais que ce soit par ordre alphabétique plutôt que par nombre de sujets. Merci !

[mallen (Mike)]

Salut à tous. Docs et cette extension de Docs sont fantastiques. Juste une chose cependant. Quelqu’un peut-il m’aider à ajouter ces cartes aux sections top_menu ou homepage ? Ce serait génial d’avoir une page d’accueil standard avec ‘Latest’ par défaut, tout en ayant ces cartes en haut. Cliquer sur une carte mènerait ensuite à la page Docs filtrée.

De plus, j’ai un autre plugin (boîte de recherche) dans la section top_menu. Je n’ai pas réussi à comprendre comment changer l’ordre si plusieurs plugins s’affichent dans cette section.

Merci.

[jrgong]

Salut @jordan.vidrine

Nous avons essayé le tc et il fonctionne parfaitement pour votre cas d’utilisation. Nous pouvons maintenant créer une base de connaissances.

Dans ce contexte, j’ai une question : pouvez-vous suggérer une solution de contournement pour ajouter des paramètres à chaque carte de catégorie ou d’étiquette ? De cette façon, nous aimerions ajouter &order=title afin d’affecter le tri pour chaque carte de catégorie ou d’étiquette individuelle.

PS :

[jordan.vidrine]

Hmmm.. Je ne suis pas sûr.

Comment souhaitez-vous que le tri des cartes de catégories et d’étiquettes apparaisse ?

[jrgong]

Salut Jordan

Nous pourrions ajouter un paramètre de tri dans le réglage du thème icônes de catégorie. Par exemple, dans le cas de 6,heart, nous pouvons ajouter une commande de tri supplémentaire, par exemple pour trier par titre de sujet ascendant, ce serait 6,heart,title-asc.

Lors de l’ouverture de la carte de catégorie, cela ajouterait simplement les paramètres de documentation tels que : /docs?ascending=true&category=71&order=title

Qu’en penses-tu ?

[jordan.vidrine]

Bien qu’il soit possible que cela fonctionne bien sur un site, sans beaucoup de retours sur ce sujet axé sur la capacité de trier les cartes, je ne pense pas que le temps passé à faire fonctionner cela correctement soit actuellement justifié.

Cela dit, nous encourageons les PR sur les composants, ainsi que le fork d’un composant pour l’utiliser à votre manière !

N’hésitez pas à faire un PR avec cette fonctionnalité, ou à le forker pour le développer vous-même.

[Ahmed_Gagan]

@jordan.vidrine

Cela dit, nous encourageons les PR sur les composants

Je peux faire une PR pour cette demande car @jrgong sponsorise le travail.

[jrgong]

@Nick_Chomey

Y a-t-il un moyen de changer l’ordre de tri des cartes, même si cela nécessite de modifier le code ? J’aimerais que ce soit par ordre alphabétique plutôt que par nombre de sujets. Merci !

Je fais remonter ce sujet ! Quelqu’un a-t-il trouvé une solution ?

[Nick_Chomey]

Ma solution a été de désactiver les cartes (puisque j’ai trop de catégories pour qu’elles soient utiles de toute façon) et de modifier l’ordre de tri des Docs. Vous pouvez en savoir plus à ce sujet ici Modifying Discourse Docs to only allow for sorting by Title - #2 by Nick_Chomey

[jordan.vidrine]

Nous accueillons certainement les PRs bénéfiques à nos composants !

Si vous ajoutiez la possibilité de trier ces cartes, je suggérerais de créer une nouvelle liste de valeurs où vous pouvez spécifier l’ordre des cartes par ID de catégorie et par ID de balise. Je n’ajouterais pas ces informations à une liste de valeurs déjà existante pour quelque chose d’autre.

[Lishuo_Lin]

@jordan.vidrine Merci d’avoir conçu ce super composant. Y a-t-il un moyen de désactiver le composant sur les appareils mobiles tout en l’affichant sur PC/Mac ?

[jrgong]

Très bien. Mais pourriez-vous au moins changer le paramètre category icons en value-list ? Il est beaucoup plus facile de gérer les cartes dans plusieurs champs de texte plutôt qu’un seul.

Et comme solution de contournement temporaire, il serait très utile que chaque carte de documentation ait une classe CSS avec le slug de catégorie ou de tag respectif.

Avant : \u003ca class=\"docs-card-box category-card\"\u003e
Après : \u003ca class=\"docs-card-box [category-slug] category-card\"\u003e

[jordan.vidrine]

C’est une bonne suggestion

[jrgong]

Faites-moi savoir si vous avez besoin d’aide pour les tests, je serai heureux d’être le cobaye

[jordan.vidrine]

Après y avoir réfléchi davantage, j’ai décidé de ne pas modifier le paramètre category icons en une liste de valeurs car, sans option de repli, cela casserait les composants des utilisateurs actuels.

L’ajout d’un repli consisterait à vérifier si l’utilisateur a défini les icônes dans le champ actuel ou dans le nouveau champ value-list, et je pense que c’est trop compliqué à ajouter à ce composant, car cela ajouterait un autre niveau de paramètres et pourrait prêter à confusion.

Quant aux ajouts de classes, c’est une excellente idée, mais je n’ai pas de calendrier pour savoir quand cela sera ajouté, car il y a des choses plus importantes qui nécessitent mon attention.

Cela dit, lorsque c’est possible, nous accueillons également les PRs pour nos composants, nous sommes après tout open source !