 |
Краткое описание | Discourse Templates позволяет создавать шаблоны контента для повторного использования. Шаблоны хранятся в виде тем в специальной категории, где их можно при необходимости редактировать и обсуждать. |
 |
Руководство по установке | Этот плагин входит в состав ядра Discourse. Отдельная установка плагина не требуется. |
Этот плагин представляет собой по сути новую версию Discourse Canned Replies, но он более гибкий и хранит шаблоны другим способом.
Возможности
Этот плагин использует одну или несколько категорий для хранения шаблонов для последующего использования. Первый пост в каждой теме этих категорий будет использоваться как шаблон для ответов.
Такой подход предоставляет гораздо больше возможностей, чем было доступно ранее с discourse-canned-replies, так как у каждого шаблона будет история редактирования, могут быть связаны теги, а последующие посты можно использовать для обсуждения содержания шаблона при необходимости.
В качестве шаблонов будут использоваться только видимые темы, поэтому темы, скрытые из списка или архивированные, отображаться не будут.
Плагин также использует настройки безопасности категорий для проверки того, какие пользователи могут использовать шаблоны. Если пользователь может читать темы в категории, то в редакторе сообщений появится опция «Вставить шаблон». Пользователь сможет видеть только те шаблоны/темы в категориях, к которым у него есть доступ.
Можно использовать несколько родительских категорий и/или подкатегорий для предоставления разных наборов шаблонов разным группам пользователей и для организации шаблонов.
Приватные шаблоны
Плагин также поддерживает приватные шаблоны. Приватные шаблоны — это личные сообщения, помеченные тегом шаблона. Эти сообщения будут доступны в качестве шаблонов только автору сообщения.
Архивированные сообщения не будут отображаться как шаблоны.
Все ваши приватные шаблоны можно найти по адресу:
/u/{ИМЯ_ПОЛЬЗОВАТЕЛЯ}/messages/tags/{ТЕГ_ПРИВАТНОГО_ШАБЛОНА}
Настройки:
discourse templates enabled: Активирует плагин.discourse templates categories: Категории, используемые для хранения шаблонов. Каждая тема в этих категориях и их подкатегориях будет использоваться как шаблон и будет доступна пользователям, которые могут видеть их в исходных категориях.discourse templates enable private templates: Включает использование приватных шаблонов.discourse templates groups allowed private templates: Группы пользователей, которым разрешено использовать приватные шаблоны.
Сотрудники всегда имеют разрешение.
discourse templates private templates tags: Теги, которые будут использоваться для маркировки личных сообщений как шаблонов.
Как использовать
После установки плагина необходимо создать хотя бы одну категорию для хранения шаблонов.
Обратите внимание: каждый пользователь, имеющий доступ для чтения тем в этой категории, сможет использовать функциональность плагина в редакторе сообщений.
По умолчанию создавать новые темы как викив настройках категории.
После этого укажите категорию в настройках плагина.
Всё готово. Теперь вам нужно просто создать несколько тем в указанной категории, и они станут доступны для использования в качестве шаблонов.
При желании можно создать подкатегории для лучшей организации шаблонов или для предоставления разных наборов ответов разным группам пользователей.
Чтобы вставить шаблон, сначала откройте редактор ответа, нажмите кнопку «Дополнительно», а затем выберите опцию «Вставить шаблон».
Выберите нужный шаблон (можно искать по тексту или тегам) и нажмите на значок «вставить».
Горячие клавиши
На ПК можно использовать Ctrl+Shift+I, а на Mac — ⌘+Shift+I для вставки шаблонов.
Приватные шаблоны
Для работы необходимо настроить следующие параметры Discourse:
tagging enabled: должно быть включено.enable personal messages: должно быть включено, если вы хотите сделать функцию доступной для пользователей, не являющихся сотрудниками.pm tags allowed for groups: необходимо разрешить группам, использующим приватные шаблоны, добавлять теги к личным сообщениям.
Чтобы использовать приватные шаблоны, сначала включите их в настройках, назначьте группы пользователей, которым разрешено их использовать, и укажите хотя бы один тег для маркировки личных сообщений как шаблонов.
Чтобы создать личный шаблон, пользователи должны:
- отправить незашифрованное личное сообщение самому себе с тегом, настроенным в параметрах плагина. Только автор сообщения сможет видеть его как приватный шаблон.
Предварительно заполненные переменные
Плагин поддерживает следующие переменные в шаблонах:
my_usernamemy_nametopic_titletopic_urloriginal_poster_usernameoriginal_poster_namereply_to_usernamereply_to_namelast_poster_usernamereply_to_or_last_poster_username.
Все вышеперечисленные переменные поддерживают текст по умолчанию (fallback). Если текст по умолчанию не указан и переменную невозможно заменить, она будет удалена.
Замена переменных поддерживается как в заголовке, так и в теле сообщения.
Пример:
Привет, %{reply_to_username,fallback:все},
...
С уважением,
%{my_name}
Если reply_to_username недоступен, шаблон будет выглядеть так:
Привет, все,
...
С уважением,
Arpit Jalan
Миграция с discourse-canned-replies
Существует задача Rake для миграции существующих заготовленных ответов в шаблоны:
rake "discourse-templates:migrate-from-canned-replies"
На Meta эта задача заняла всего несколько секунд для миграции 47 заготовленных ответов, поэтому её можно безопасно использовать, если у вас не огромное количество заготовленных ответов.
TODO
расширить функциональность на другие места, помимо редактора сообщений
разрешить использование более одной родительской категории в качестве источника шаблонов
Журнал изменений
- 2022-07-14T03:00:00Z: Добавлена возможность использования нескольких родительских категорий в качестве источника для шаблонов.
- 2022-07-18T03:00:00Z: Приватные шаблоны.
- 2022-08-10T03:00:00Z: Глобальные горячие клавиши.
Этот плагин теперь включён в ядро Discourse в рамках