Коллекции

Настройка Плагин
1
:information_source: Краткое описание Пользователи создают коллекции связанных тем
:hammer_and_wrench: Ссылка на репозиторий https://github.com/Alteras1/discourse-collections
:open_book: Руководство по установке Как устанавливать плагины в Discourse

Предпросмотр

Мобильная версия

Коллекции

Этот плагин позволяет пользователям создавать коллекции тем, которые отображаются при просмотре соответствующих тем. В коллекции можно добавлять любые URL-адреса, и они будут видны на любой связанной теме. Коллекции можно организовывать по разделам, и любые изменения в коллекции отражаются на всех связанных темах. Нет никаких ограничений на темы, которые можно связать, поэтому пользователи могут создавать коллекции, охватывающие различные категории или теги.

Заголовок и описание

Необязательное поле для ввода. Если оно заполнено, эти данные будут отображаться в верхней части списка.

Разделы

Необязательная функция организации. Добавление заголовка раздела позволяет делить коллекцию на секции, что обеспечивает возможность сворачивания разделов.

Подколлекции

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

Разрешения

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

Демонстрация разрешений

Настройки

Название Описание
collections enabled Включить/отключить плагин. По умолчанию: true
collection by topic owner Разрешить создателю темы создавать коллекции. По умолчанию: true
collection by topic owner allow groups Ограничить круг создателей тем, которые могут создавать коллекции. Ограничивает параметр collection by topic owner. По умолчанию: TL1
subcollection by topic owner allow groups Ограничить круг создателей тем, которые могут создавать подколлекции. Ограничивает параметр collection by topic owner. По умолчанию: TL1
collection modification by allowed groups Группы, которым разрешено создавать/изменять любые коллекции. По умолчанию: Admin Moderators TL4.
sections in subcollection Разрешить заголовки разделов в подколлекциях. По умолчанию: true

Альтернативы

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

Тематический компонент DiscoTOC - automatic table of contents также позволяет организовывать ссылки вне тела сообщения, но он ограничен рамками одной темы.

Если ваша цель — организация в стиле вики, то Discourse Doc Categories будет более подходящим вариантом. Если вам нужно связывать темы только на некоторых страницах, лучше подойдет DiscoTOC - automatic table of contents.

Примечания

Изначально этот плагин разрабатывался для поддержки миграции форума, участником которого я являюсь, на платформу Discourse. Поскольку это форум, ориентированный на написание текстов, пользователи поддерживают отдельные темы для разных целей, что приводит к ситуации, когда ссылки между темами из разных категорий практически необходимы. Чтобы облегчить этот процесс, я создал этот плагин, чтобы помочь пользователям самостоятельно организовывать контент.

Существовала альтернативная версия, где это был бы просто тематический компонент, а индексация происходила бы с помощью пользовательских div-элементов с URL-адресами других сообщений. Но после разработки 90% инструментов, мастеров и кода для этого я понял, что это не стоит усилий, и пользователи, скорее всего, проигнорируют все руководства и будут жаловаться на то, что ничего не работает. Поэтому этот путь был отброшен. Честно говоря, это не такое уж плохое решение, так как оно было бы гораздо легче, чем плагин, но оно возложило бы на пользователей ненужную нагрузку по обеспечению правильного форматирования не в одном сообщении, а во многих.

В настоящее время я пометил этот плагин как experimental, так как я еще не окончательно определился с функциями интерфейса (например, иконками) и системой разрешений. Также мне нужно добавить автоматические модульные тесты.

21 лайк
Post Collections, Topic-to-Topic Navigation Buttons, Menus, Anchor Links, and Topic TOC
2

К сведению: все видео не работали :thinking: (iPad)

1 лайк
3

Хм, я думал, что iOS Safari поддерживает WebM…

Я заменил видео на MP4. Спасибо!

5 лайков
4

Можно ли включить «публичные» коллекции, как в Discourse Docs?

1 лайк
5

Извините, если было неясно: все коллекции являются «публичными». Все пользователи видят одну и ту же коллекцию по одной и той же теме. Этот плагин предназначен для организации тем, а не для создания личных «папок с закладками» для пользователей.

Discourse Topic with Collection as viewed from an anonymous user
Discourse Topic with Collection as viewed from an anonymous user1920×1243 155 KB

5 лайков
6

Обновлен плагин с поддержкой эмодзи и цветных квадратов в боковой панели!

5 лайков
7

Это выглядит действительно впечатляюще. И абсолютно превосходная документация — это моя рекомендация как наиболее хорошо документированного Customization > Plugin на meta.discourse.org!!

Вы думали о расширении функционала, чтобы он также охватывал списки тем?

Часто бывает очень полезно иметь коллекцию ссылок для каждой категории или тега. Например, частная категория, выделенная для конкретной группы, которая также использует другие инструменты (например, несколько папок в Google Docs, портал местного самоуправления, связанный канал чата и групповую почту). Было бы идеально, если бы модераторы категорий имели контроль над этим.

3 лайка
8

Спасибо большое!

Это определённо то, о чём я раньше размышлял, но, на мой взгляд, это плохо впишется в текущую концепцию организации тем, управляемую пользователями. Для уровня категорий и тегов это не совсем подходит, так как управление пришлось бы ограничить только модераторами. Изначальный сценарий использования заключался в создании ссылок на связанные темы, которые слишком велики для 1–2 тем, но слишком малы для отдельного тега или категории.

Отображение индексов тем в боковой панели для категорий можно реализовать с помощью плагина Discourse Doc Categories, хотя для этого потребуется иной способ настройки. Конечно, неудобно использовать два плагина для выполнения очень похожих задач, но, на мой взгляд, изначальная философия каждого из них достаточно различается, чтобы оправдать отдельные подходы.

Добавление расширения совместимости для плагина Private Topics Plugin — очень интересная идея с точки зрения пользователя. Мне стоит это обдумать…

Остаётся только уровень по тегам. Создание pull-запроса для плагина Discourse Doc Categories (или разработка нового плагина/темы) для тегов — возможный вариант, но в данный момент я об этом не думаю. Возможно, в будущем.

9

На самом деле, это, вероятно, отлично подойдёт для моего случая. Не уверен, однако, насколько он гибкий (поэкспериментирую с ним на этой неделе).

Звучит очень интересно. Какой сценарий использования вы имеете в виду?

10

Для обычных пользователей категория с включённой функцией «Частные темы» будет отображать только их собственные темы. Поэтому я могу представить, что это один из немногих случаев, когда имеет смысл разрешить плагину Collections переносить коллекцию с уровня тем на уровень категории для каждого пользователя.

На форуме, в котором я участвую, есть частная категория, которую пользователи используют как личное пространство для черновиков и тестирования. Там создаётся очень много тем, поэтому здесь иногда происходит организация тем самими пользователями.

11

Я очень надеялся, что это система сбора, где пользователи могут создавать категории и добавлять туда темы по своему выбору, как в галерее. Ну что ж.

12

Как это может быть не тем самым?

1 лайк
13

Думаю, вы не можете создавать категории.

14

Я очень ценю интерфейс перетаскивания этого плагина для создания произвольных последовательностей тем, подобных главам книги, которые можно легко перестраивать.

Я начал работу над компонентом темы, чтобы добавить последовательную навигацию для коллекций, такую как ← Назад и Вперед →, а также пагинацию в модальном окне…

Вот мой рабочий репозиторий:

4 лайка
15

Очень актуально, сегодня займусь этим, и, похоже, это был последний недостающий компонент.

@Alteras У меня баг с крестиком закрытия модального окна в окне «Создать коллекции». На него можно навести курсор и нажать, но модальное окно не закрывается до перезагрузки страницы.

1 лайк
16

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

Меня интересует решение заменять содержимое поста вместо простого перенаправления пользователя на тему.

Мне очень нравится идея использовать ← Назад и Вперед → над таймлайном для навигации по темам без необходимости использовать боковую панель. Возможно, это можно разместить рядом с таймлайном, как оглавление, чтобы к нему можно было легко получить доступ в длинных первых постах, не прокручивая страницу вверх… Или, возможно, просто добавить декоративные элементы к верхнему и нижнему посту…

Если вы не против, я хотел бы изучить возможность внедрения некоторых из этих идей непосредственно в плагин, возможно, с дополнительными настройками сайта для администраторов. Конечно, я не возражаю против создания компонента темы на основе плагина, что даст пользователям больше возможностей для настройки. Дайте знать, если вам понадобится помощь с вашим компонентом темы. Вы должны иметь возможность получать информацию о текущей отображаемой коллекции из сервиса Ember service:collection-sidebar, не анализируя DOM.

Хм… это действительно странно. Мне не удаётся воспроизвести эту проблему. Недавно я внес некоторые изменения в плагин, чтобы устранить проблемы с устаревшими функциями, возможно, это повлияло на работу? Пожалуйста, проверьте, обновлён ли плагин. Также поделитесь деталями вашей конфигурации (браузер, мобильное устройство/десктоп, версия Discourse).

3 лайка
17

У меня устаревшая версия, возможно, поэтому. Я всё ещё был на коммите от 6 ноября.
ETA: Не обращайте внимания, обновление решило проблему.

1 лайк
18

Мне нравится скорость. Это не продуманный дизайн. Мое первоначальное видение заключается в том, чтобы модальное окно открывало слайд-шоу, сфокусированное на контенте.

Поскольку здесь открывается возможность произвольного упорядочивания элементов, где последовательность явно не привязана к какой-либо временной шкале, моя первоначальная цель — повторно использовать поведение вложенных горизонтально прокручиваемых меню из ядра, как у нас реализовано в отображении профилей пользователей. Например, под (статичным) заголовком и описанием коллекции (если они есть) находятся две горизонтально прокручиваемые/свайпаемые строки: заголовки разделов и соответствующие им названия тем ниже.

multilevel-horizontal-swiping
multilevel-horizontal-swiping648×169 16.3 KB

Также внутри модального окна есть сворачиваемое (быстрое выезжание/выезд слева) вертикальное отображение, повторяющее поведение боковой панели слева вне модального окна. Мне нравится идея, что то, что поднимается со страницы в модальном окне, выглядит и ощущается в основном так же, как то, что видно и воспринимается (в центрированном, немодальном представлении), включая элементы навигации, но просто окружая обработанный контент.

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

Пожалуйста, делайте!

Я также вижу возможность адаптировать этот TC или, в ином случае, предоставить такие типы навигации и отображения для категорий документации :page_with_curl:

2 лайка
19

Теперь, когда у меня всё работает (спасибо за предупреждение об обновлении выше), я заметил несколько моментов:

  1. Кнопка «Коллекции» видна даже если пользователь не входит в разрешённые группы. При попытке создать коллекцию возникает ошибка Internal Server Error (она корректно отображается в виде красной полосы в модальном окне).
  2. В боковой панели коллекций кнопка внизу предлагает исходный вариант «Создать коллекцию». Чтобы управлять коллекцией, приходится использовать кнопку в исходном посте. Было бы очень полезно иметь опцию «Управление» сразу в кнопке боковой панели коллекций.
  3. Возможно ли разделить права доступа для коллекций и подколлекций? Подколлекции могли бы быть чрезвычайно полезны для пользователей, которые хотят самостоятельно группировать темы, без широкого воздействия, которое коллекция оказывает на все связанные темы.

Наконец, как этот плагин обрабатывает ситуацию, когда две коллекции ссылаются на одну и ту же тему? А если это две подколлекции? Это подталкивает меня к поддержке предложения №3 для более удобного управления пересекающимися целями пользователей, которым нравится функция коллекций.

РЕДАКТИРОВАНО: Я понял, что пункт №1 связан с ошибкой при изменении коллекции разрешёнными группами, которая допускает темы, не принадлежащие пользователю. Тем не менее, более понятное сообщение об ошибке было бы полезно!

1 лайк
20

Таким образом, настройка «Изменение коллекций разрешёнными группами» предназначена для сотрудников и пользователей с высокими привилегиями, например, помощников, поддерживающих вики. Хотя, похоже, мне всё же нужно исправить ошибки.

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

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

Хм… Мне кажется, что лучше было бы создать отдельный плагин, представляющий собой просто папки закладок, которые можно просматривать публично или приватно… «Личные коллекции»? «Библиотека закладок»? «Плейлисты тем»? Или, возможно, я просто расширю этот плагин. Но базовый код и философия этих двух функций были бы совершенно разными… Немного жаль, что название «Коллекции» довольно широкое и может интерпретироваться множеством способов.

3 лайка