 |
Сводка | Превращает таблицу в теме в поисковые элементы, на которые участники могут ссылаться с помощью +, включая ссылки и превью onebox. |
 |
Репозиторий | Discourse Mentionables |
 |
Гид по установке | Установка плагинов на самохостинговом сайте Discourse |
 |
Спонсорство | Пожалуйста, рассмотрите возможность спонсирования дальнейшего развития, чтобы помочь поддерживать эти плагины в рабочем состоянии с текущими версиями Discourse. |
Предоставьте вашему сообществу общий словарь для тех тем, о которых вы говорите: книги,
продукты, проекты, места, ресурсы поддержки или что-либо другое, имеющее URL.
Участники вводят + и часть названия, выбирают подсказку и получают читаемую ссылку, не запоминая адрес.
Возможности
- Начните только с URL. Импортер получает имена и генерирует слаги; добавьте
свои собственные имена и слаги как необязательные переопределения. - Поиск во время написания. Введите
+или используйте кнопку панели инструментов композера для поиска
в вашем каталоге. Работает как в Markdown, так и в композере rich text. - Читаемые встроенные ссылки. Упоминания отображаются в виде компактных «пилюль» (pill) с использованием имени элемента
для отображения, со стабильным слагом в Markdown поста. - Нативные onebox. Поместите упоминание на отдельную строку, чтобы отобразить onebox, используя
существующие макеты Discourse и поддерживаемые назначения. - Превью на десктопе. Наведите курсор или установите фокус на встроенную «пилюлю», чтобы открыть всплывающее превью
со ссылкой Открыть исходную страницу. Обычные клики открывают целевой адрес. - Каталог, который администраторы могут редактировать в Discourse. Импорт из таблицы Markdown
в первом посте темы. Не требуются учетная запись Google или учетные данные API. - Кнопка таблицы для администраторов. Вставьте пустую таблицу mentionables из
панели инструментов композера, а затем заполните свои элементы.
Внешний вид onebox зависит от назначения и обычной поддержки onebox в Discourse.
Неподдерживаемые назначения остаются обычными ссылками. Для всплывающих карточек требуется вход;
гости все еще могут перейти по ссылке на назначение. Упоминания в коде остаются без изменений,
a упоминания в списках и цитатах остаются встроенными.
Базовый Mentionables и расширение Pro
Базовый Mentionables — это основной плагин. Pro — это необязательный сопутствующий плагин,
устанавливаемый вместе с ним; Pro включает базовые функции через эту зависимость.
| Функция | Базовый Mentionables | С расширением Pro |
|---|---|---|
| Импорт таблицы Markdown из первого поста темы | Да | Да |
| Держать исходную тему в ограниченной категории | Да | Да |
| Кнопка композера только для администраторов для вставки каркаса таблицы | Да | Да, включая столбцы с иконками |
Поиск с помощью + в композерах Markdown и rich text |
Да | Да |
| Встроенные пилюли упоминаний и автономные нативные oneboxes | Да | Да |
| Всплывающие превью при наведении мыши или фокусе клавиатуры на десктопе | Да | Да, в режиме наведения по умолчанию |
| Импорт из Google Sheets с использованием служебной учетной записи | — | Да |
| Выбор между таблицами тем и Google Sheets | Только таблицы тем | Да |
| Автоматическая синхронизация каждые 12 часов | — | Необязательно, выключено по умолчанию |
| Импорт необязательных имен иконок и цветов HTML | — | Да, из любого источника |
| Открытие всплывающих превью по клику или касанию, включая сенсорные устройства | — | Необязательно |
Столбцы icon и icon_colour в Pro добавляют цветную иконку перед именем
упоминания. Например, используйте book и #2563eb для руководства. При включенном
mentionables_pro_click_to_preview клик или касание по «пилюле» открывает ее
превью; ссылка Открыть исходную страницу в превью ведет вас к целевому адресу.
Быстрая настройка
-
Установите базовый плагин, используя гид по установке выше. Пересоберите Discourse
после установки. -
Создайте тему для вашего каталога. Как администратор, используйте Вставить таблицу mentionables
в панели инструментов композера или вставьте эту таблицу в первый пост:| name | url | slug | image_url | | ------------------ | ----------------------------------- | ------------------ | --------- | | Getting started | https://example.com/getting-started | getting-started | | | Community handbook | https://example.com/handbook | community-handbook | | | Events calendar | https://example.com/events | events-calendar | | -
Замените примеры URL своими, сохраните пост и установите
mentionables_topic_idна числовой ID этой темы. Оставьтеmentionables_enabled
включенным. Для установок Pro следует выбратьtopic_tableвmentionables_source
для этой настройки. -
Откройте Администрирование → Плагины → Mentionables, нажмите Начать импорт, а затем
Обновить, чтобы просмотреть отчет. Фоновый рабочий процесс должен быть запущен. -
Перезагрузите браузер, откройте композер и введите
+, чтобы попробовать ваши элементы.
Используйте имена столбцов в нижнем регистре. Только url является обязательным, начинающимся с http://
или https://. Строки только с URL получают имя из назначения и генерируют
слег. Вы можете указать name, slug или оба, чтобы переопределить эти значения по умолчанию, смешивая
эти варианты в одной таблице. Если название недоступно, URL становится
именем для отображения. Существующие URL сохраняют свои слаги, если источник их опускает.
image_url и description являются необязательными.
Импортер читает первую некотируемую таблицу со столбцом url в первом
посте. Ответы, процитированные таблицы и кодированные образцы кода игнорируются. Исходные темы
должны быть обычными, не удаленными темами, а не личными сообщениями.
Конфиденциальность источника и обновление вашего каталога
Вы можете держать исходную тему в категории Staff или другой ограниченной категории, чтобы только
доверенные люди могли ее поддерживать. Импортированные имена, URL и изображения
доступны пользователям mentionables. Ограничение темы не делает
импортированный каталог частным. Не включайте конфиденциальную информацию в таблицу.
Каждый импорт синхронизируется по URL: совпадающие URL обновляются, новые URL создают записи,
a URL, удаленные из источника, удаляют записи. Полный источник должен быть
валидным; дублирующиеся URL или слаги, недействительные строки, сбои получения данных и пустые наборы данных
не изменяют каталог. Используйте Удалить все для намеренной очистки.
Исходные темы и электронные таблицы никогда не изменяются. Необязательная настройка
mentionables_pro_sync_enabled в Pro запускает тот же импорт каждые 12 часов.
Перезагрузите браузер после импорта. Существующие обработанные посты не пересобираются автоматически,
и явное изменение слуга может нарушить более ранние ссылки +slug.
Настройки и дополнительная информация
| Настройка | Назначение |
|---|---|
mentionables_enabled |
Включить или отключить Mentionables. |
mentionables_topic_id |
Тема, содержащая исходную таблицу в своем первом посте. |
mentionables_autocomplete_limit |
Максимальное количество предложений; по умолчанию пять. |
mentionables_onebox_fallback |
Также получать отсутствующие изображения/описания, когда указано имя; выключено по умолчанию. |
См. README для полного руководства по настройке, поведения импорта и
устранению неполадок. На скриншотах используются тестовые данные из фикстур плагина.
