Présentation de l’éditeur d’index visuel pour les catégories de documentation Discourse

Les catégories de documentation peuvent désormais créer leur index dans la barre latérale directement via l’interface d’administration. L’éditeur d’index est une fonctionnalité à venir pour le plugin Doc Categories, et il élimine la nécessité de maintenir un sujet d’index séparé.

Deux façons de générer un index

L’édition d’une catégorie comporte désormais un onglet Index de la documentation avec un sélecteur de mode :

  • Éditeur crée l’index sur place, sous forme de sections contenant des liens.
  • Sujet d’index correspond au comportement actuel, où les titres et les listes d’un sujet constituent l’index.
  • Désactivé désactive l’index de la barre latérale pour cette catégorie.

Les catégories qui renvoient déjà à un sujet d’index continueront de fonctionner exactement comme elles le font aujourd’hui.

Créer un index

Une section contient des liens, et un lien pointe soit vers un sujet, soit vers n’importe quelle URL que vous saisissez. Chaque lien peut avoir sa propre icône, et l’éditeur vous avertit lorsque deux liens renvoient vers la même destination ou lorsque deux sections partagent un titre identique.

On vous indique également quand des sujets de la catégorie n’apparaissent pas dans l’index, et vous pouvez ajouter ces sujets par lots :

Une section Index auto se remplit automatiquement à partir des sujets de la catégorie, ce qui vous permet de lister manuellement les pages qui vous intéressent et de regrouper tout le reste en un seul endroit. Elle peut être resynchronisée à chaque sauvegarde.

Les sections et les liens peuvent être réordonnés par glisser-déposer. Chaque poignée de déplacement est également un point de tabulation standard qui ouvre un menu de déplacement, permettant ainsi de réorganiser tout l’index au clavier. Un mode de traitement par lots gère la sélection multiple, pour supprimer plusieurs lignes à la fois ou pour faire glisser une sélection entière d’un bloc.

Activez-le sur votre site

L’éditeur d’index est une modification expérimentale à venir. Activez Éditeur d’index des catégories de documentation dans /admin/config/upcoming-changes. Cela n’affecte que les catégories de documentation, et uniquement ce que voient les administrateurs lors de l’édition de l’une d’elles.

Votre avis nous intéresse

Dites-nous comment il se comporte avec un index réel : si la création ici est plus efficace que la maintenance d’un sujet, ce qui manque avant que vous n’acceptiez de migrer une catégorie, et tout ce qui vous semble encore imparfait.

14 « J'aime »

La PR initiale FEATURE: Add visual doc category index editor - Pull Request #87 - discourse/discourse-doc-categories - GitHub vient d’être fusionnée derrière une modification expérimentale à venir. La fonctionnalité fera probablement l’objet d’autres raffinements au cours des une ou deux prochaines semaines avant que nous ne la passions en phase Alpha.

1 « J'aime »