Страница `admin/customize/email_templates` должна включать краткую документацию по этим шаблонам

Внести вклад Функция
1

Запрос:

Страница администратора для настройки шаблонов электронной почты должна включать:

  • однострочное описание того, когда выбранный в данный момент шаблон будет отправлен пользователям по электронной почте;
  • однострочное описание каждого ключа интерполяции, который можно использовать в текущем шаблоне.

Обоснование:

На этой странице я часто сталкиваюсь с двумя проблемами:

1: непонимание того, что запускает отправку шаблона

Названия шаблонов недостаточно для понимания того, когда будет отправлен шаблон электронной почты. Отличные примеры:

  • Custom Invite Forum Mailer
  • Custom Invite Mailer
  • Invite Forum Mailer
  • Invite Mailer

Эти названия имеют смысл только ретроспективно, после того как мы поймём различия между ними. Поэтому было бы здорово добавить для этих (и всех остальных) шаблонов краткое однострочное описание на странице, чтобы администратор понимал, для чего предназначен каждый шаблон.

Можно напрямую использовать текст из полезного руководства на этом форуме — контент уже написан, по крайней мере для английской локализации.

2: непонимание того, какие ключи интерполяции доступны и что они делают

Например, вот шаблон для User Replied:

%{header_instructions}

%{message}

%{context}

%{respond_instructions}

Проблема здесь:

  1. Я не знаю, что означает %{context}.
  2. Если я удалю эти ключи, их может быть трудно вернуть обратно.

Поэтому было бы здорово, если бы для каждого ключа, доступного в каждом шаблоне электронной почты, было приведено однострочное описание. Возможно, в виде раскрывающегося/скрываемого списка на странице?

Для справки, вот несколько постов, в которых запрашивается эта информация: один, два

7 лайков