La page `admin/customize/email_templates` devrait inclure une brève documentation de ces modèles

La demande :

La page d’administration pour la personnalisation des modèles d’e-mails devrait inclure :

  • Une description en une phrase de quand le modèle actuellement sélectionné sera envoyé par e-mail aux utilisateurs.
  • Une description en une phrase de chaque clé d’interpolation utilisable dans le modèle actuel.

La justification :

Sur cette page, je rencontre souvent deux problèmes :

1 : Ne pas comprendre quand le modèle sera envoyé

Le nom du modèle n’est pas suffisant pour comprendre quand un modèle d’e-mail sera envoyé. Bons exemples :

  • Modèle d’e-mail d’invitation personnalisé pour le forum
  • Modèle d’e-mail d’invitation personnalisé
  • Modèle d’e-mail d’invitation pour le forum
  • Modèle d’e-mail d’invitation

Ces noms n’ont de sens qu’a posteriori, après que nous ayons compris les distinctions entre eux. Il serait donc formidable d’ajouter à ces modèles (et à tous les autres) une petite description d’une phrase sur la page, pour informer l’administrateur de l’utilité du modèle.

Vous pourriez utiliser directement le texte d’un utile article d’aide sur ce forum — le contenu est déjà rédigé, du moins pour la localisation anglaise.

2 : Ne pas savoir quelles clés d’interpolation sont disponibles ou ce qu’elles font

Par exemple, voici le modèle pour « L’utilisateur a répondu » :

%{header_instructions}

%{message}

%{context}

%{respond_instructions}

Le problème ici :

  1. Je ne sais pas ce que signifie %{context}.
  2. Si je supprime ces clés, il peut être difficile de les retrouver.

Il serait donc également formidable d’avoir des descriptions d’une phrase pour chacune des clés disponibles pour chaque modèle d’e-mail. Peut-être sous forme de liste extensible/masquable sur la page ?

Pour référence, voici quelques publications demandant cette information : une, deux

7 « J'aime »