 |
Краткое описание | 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: Группы пользователей, которым разрешено использовать приватные шаблоны.
Сотрудники (Staff) всегда имеют доступ.
discourse templates private templates tags: Теги, которые будут использоваться для标记 личных сообщений как шаблонов.
Как использовать
После установки плагина вам необходимо создать хотя бы одну категорию для хранения шаблонов.
Обратите внимание, что каждый пользователь, имеющий доступ к чтению тем в этой категории, сможет использовать функциональность плагина в редакторе сообщений.
Создавать новые темы как вики по умолчаниюв настройках категории.
После этого укажите категорию в настройках плагина.
На этом всё. Теперь вам осталось создать несколько тем в указанной категории, и они будут доступны для использования в качестве шаблонов.
При желании вы можете создавать подкатегории для лучшей организации шаблонов или для предоставления разных наборов ответов разным группам пользователей.
Чтобы вставить шаблон, сначала откройте редактор ответа и нажмите кнопку дополнительных опций, затем выберите опцию «Вставить шаблон».
Выберите нужный шаблон, можно искать по тексту или тегам, и нажмите на значок «вставить».
Горячая клавиша
Вы можете использовать Ctrl+Shift+I на ПК или ⌘+Shift+I на Mac, чтобы вставлять шаблоны.
Приватные шаблоны
Для работы необходимо настроить следующие параметры 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 недоступен, шаблон будет выглядеть так:
Привет, там,
...
С уважением,
Арпит Джалан
Миграция с 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 в рамках