Fournir un lien vers la documentation CommonMark depuis l'éditeur

Je pense qu’il serait utile d’inclure un lien vers la référence CommonMark ou, en option, vers un sujet personnalisé, pour aider les utilisateurs dans leurs éditions lorsque celles-ci ne peuvent pas être effectuées via les boutons de la barre d’outils. Si un lien vers un sujet personnalisé peut être configuré, il serait également possible de documenter des balises spécifiques à certains plugins, comme celles du plugin de coche.

Un bouton avec un point d’interrogation, placé tout à droite de la barre d’outils, semble être une bonne façon d’ajouter ce lien.

7 « J'aime »

Je ne peux pas dire si cela intégrera le cœur à long terme, mais cela semble être un excellent candidat pour un composant de thème dans un premier temps.

11 « J'aime »

Une réponse très rapide : personnalisez les textes de la clé education.* sur le site pour qu’ils pointent vers le sujet personnalisé de votre site. :sunglasses:

6 « J'aime »

Ces messages ne s’affichent-ils que les premières fois que vous rédigez un nouveau sujet ou une nouvelle réponse ?

2 « J'aime »

Oui, mais cela en fait aussi un endroit bien plus approprié pour cette information :information_source:

4 « J'aime »

Je ne suis pas d’accord. Ce serait un lien vers une référence à consulter lorsque vous ne vous souvenez plus de certaines syntaxes Markdown que vous utilisez rarement. Ce n’est pas quelque chose que l’on lit une fois et dont on n’a plus jamais besoin de se souvenir.

1 « J'aime »

Il semble que vous soyez sous l’illusion que les utilisateurs liront tout ce que vous affichez à l’écran.

Ils ne le feront pas.

Les meilleures approches consistent à fournir l’information à l’utilisateur au bon moment, lorsqu’il en a le plus besoin — et non à afficher un tas de liens permanents aléatoires « au cas où », qui seront ignorés dans 99,999 % des cas et qui ajoutent du désordre pour tous les utilisateurs.

3 « J'aime »

Non, désolé de vous décevoir. :grin: Il s’agit simplement d’une suggestion égoïste pour quelque chose qui me serait personnellement utile. Je m’en suis inspiré de l’éditeur GitHub, qui inclut un lien vers la spécification Markdown de GH, que je consulte de temps en temps.

D’accord, ce serait la solution idéale. Bien sûr, c’est plus facile à dire qu’à faire. Cela varie considérablement d’un utilisateur à l’autre, aussi suis-je sceptique quant à l’efficacité d’une telle approche sans essais approfondis. Sinon, cela repose simplement sur des hypothèses.

Je suppose que « Avez-vous cliqué sur le bouton :heart: ? » est un exemple de cette approche ? Pour une raison quelconque, Discourse suppose que j’approuve le message auquel je réponds lorsque mon message ne contient que très peu de caractères. Lors de ma première rencontre avec ce comportement, cette hypothèse était erronée et n’a provoqué que confusion et frustration.

Cela dit, je ne pense pas qu’il existe de solution simple pour éduquer les utilisateurs. Il n’y a probablement aucune solution du tout lorsqu’on a affaire à des utilisateurs de milieux différents, alors veuillez ne pas prendre cela comme une critique.

2 « J'aime »

Si vous souhaitez un rappel générique en Markdown, consultez commonmark.org !

1 « J'aime »

Un autre vote pour un petit :grey_question: en haut à droite ou en bas à droite de la zone de rédaction.

:ballot_box:

Ce plugin existe depuis un moment

15 « J'aime »

Les personnes qui trouveraient cela utile sont capables de s’auto-assister en recherchant activement et en trouvant les informations dont elles ont besoin. Ce sont déjà des étudiants :star.

De plus… si les utilisateurs lisaient vraiment quoi que ce soit (ce qu’ils ne font pas), ils seraient arrivés à l’étape de mise en forme du message de bienvenue interactif du discobot, que tous les nouveaux utilisateurs reçoivent. C’est le mieux, car il est dynamique et interactif, utilisant l’éditeur réel, et contient des liens vers l’aide.

Vérifiez vos MP et vous verrez ce même message de bienvenue là aussi.

6 « J'aime »

Merci. J’ai supposé qu’une chose comme celle-ci devait déjà exister, mais je n’ai pas réussi à la trouver.

Malheureusement, cela ne fonctionne pas pour moi. Le bug a été signalé ici : Plugin not working with Discourse 2.5.0.beta1 · Issue #12 · cpradio/discourse-plugin-composer-help-button · GitHub

3 « J'aime »

Beaucoup de personnes m’ont demandé comment utiliser Markdown, c’est pourquoi j’adhère à cette idée. Personnellement, cela m’a pris beaucoup de temps avant de réaliser que l’éditeur utilisait Markdown et de trouver des instructions sur son utilisation.

Ma suggestion pour résoudre ce problème est d’ajouter une boîte bleue en haut de l’éditeur pour les nouveaux utilisateurs, indiquant quelque chose comme :

“En savoir plus sur la mise en forme de votre texte avec Markdown ici : [lien]”

La boîte bleue peut comporter une croix en haut à droite, afin que les personnes qui ne souhaitent plus la voir puissent la fermer définitivement.

3 « J'aime »

Comme l’a dit Jeff, discobot enseigne quelques bases du markdown. Discobot est-il activé sur votre instance ?

3 « J'aime »

Je le fais. Le hasard a joué et quelqu’un m’harcelait, me menaçant de ne plus utiliser Discourse si je ne pouvais pas expliquer comment l’utiliser.

Finalement, j’ai copié-collé cet article et je l’ai épinglé globalement sur le forum. J’en ai appris quelques-unes que je ne connaissais pas en cours de route.

2 « J'aime »

Une approche plus simple aurait peut-être été de lier à

https://commonmark.org/help/

et à

https://blog.discourse.org/2016/12/discourse-new-user-tips-and-tricks/

Ces deux liens sont envoyés dans le message privé de bienvenue aux nouveaux utilisateurs, que chaque nouvel utilisateur reçoit après avoir créé un compte sur Discourse.

3 « J'aime »