Опросы в Discourse

:discourse2: Краткое описание Плагин Discourse Surveys позволяет создавать опросы непосредственно в сообщениях вашего форума Discourse с помощью простого синтаксиса Markdown.
:hammer_and_wrench: Ссылка на репозиторий https://github.com/discourse/discourse-surveys
:open_book: Руководство по установке Как установить плагины в Discourse

Плагин Discourse Surveys позволяет создавать опросы непосредственно в сообщениях вашего форума Discourse с помощью простого синтаксиса Markdown. Плагин в настоящее время поддерживает множество типов вопросов, таких как радиокнопки, флажки, выпадающие списки, поля ввода чисел, текстовые области, рейтинги по звездам и оценки «палец вверх/вниз».

Возможности

  • 7 различных типов полей: радиокнопки, флажки, выпадающие списки, текстовые области, выбор чисел, рейтинг по звездам и «палец вверх/вниз»

  • Обязательные/необязательные поля: помечайте поля как обязательные, чтобы гарантировать их заполнение

  • Поддержка эмодзи: используйте эмодзи в вариантах ответов опроса

  • Поддержка Markdown: богатое форматирование текста в вопросах и вариантах ответов

  • Аутентификация пользователей: автоматическое предложение войти в систему для анонимных пользователей

  • Отслеживание ответов: предотвращает повторные отправки от одного и того же пользователя

  • Учет прав доступа: уважает права доступа к темам и категориям

  • Адаптивный дизайн: работает без проблем на всех устройствах

Использование

Базовая структура опроса

Все опросы должны быть заключены в теги [survey]:


[survey name="my-survey" title="Опрос клиентов"]

<!-- Здесь размещаются поля опроса -->

[/survey]

Атрибуты опроса

  • name: уникальный идентификатор опроса (по умолчанию «survey»)

  • title: необязательное название, отображаемое в верхней части опроса

  • public: настройка видимости (функция планируется в будущем)

  • status: статус опроса (функция планируется в будущем)

Типы полей

1. Радиокнопки (одиночный выбор)


[radio question="Какой ваш любимый цвет?"]

- Красный

- Синий

- Зеленый

- Желтый

[/radio]

2. Флажки (множественный выбор)


[checkbox question="Какие функции вы используете? (Выберите все подходящие)"]

- Уведомления по электронной почте

- Мобильное приложение

- Уведомления на рабочем столе

- Доступ к API

[/checkbox]

3. Выбор из выпадающего списка


[dropdown question="Какова ваша возрастная группа?"]

- До 18 лет

- 18–24 года

- 25–34 года

- 35–44 года

- 45–54 года

- 55+ лет

[/dropdown]

4. Текстовая область (длинный текст)


[textarea question="Пожалуйста, оставьте подробную обратную связь:" required="false"]

[/textarea]

5. Выбор числа


[number question="Оцените эту функцию от 1 до 10:" min="1" max="10"]

[/number]

6. Рейтинг по звездам


[star question="Как вы оцените ваш общий опыт?"]

[/star]

7. Палец вверх/вниз


[thumbs question="Порекомендовали бы вы это другим?"]

[/thumbs]

Атрибуты полей

Все типы полей поддерживают эти атрибуты:

  • question: текст вопроса (обязательно)

  • required: обязательно ли заполнять поле (true/false, по умолчанию true)

  • min: минимальное значение для числовых полей

  • max: максимальное значение для числовых полей

Полный пример

Базовый Markdown для опроса

Вот базовый пример Markdown для опроса, включающий все доступные поля:

[survey name="awesome-survey-thumbs" title="Отличный опрос"]

[radio question="Выберите один вариант:"]
- Кот
- Собака
[/radio]

[checkbox question="Выберите несколько вариантов:"]
- Красный
- Синий
- Зеленый
[/checkbox]

[dropdown question="Пол:"]
- Мужской
- Женский
[/dropdown]

[number question="Оцените этот опрос от 1 до 10:"]
[/number]

[textarea question="Какова ваша обратная связь по xyz?" required="false"]
[/textarea]

[star question="Как вы оцените общий опыт?"]
[/star]

[thumbs question="Устроили ли вас наши услуги?"]
[/thumbs]

[/survey]

Отображение опроса

Ниже приведен пример того, как приведенный выше Markdown отображается в Discourse:

Расширенное использование

Использование эмодзи в вариантах ответов


[radio question="Выберите ваше любимое животное:"]

- 🐈 Кот

- 🐶 Собака

- 🐦 Птица

- 🐠 Рыба

[/radio]

Форматирование Markdown в вопросах


[radio question="Какой **язык программирования** вы предпочитаете?"]
- JavaScript
- Python
- Ruby
- Go
[/radio]

[checkbox question="Выберите ваши *любимые* функции:"]
- Скорость
- Безопасность
- Простота использования
[/checkbox]

[textarea question="Пожалуйста, прочитайте наши [руководства](https://example.com) и оставьте обратную связь:"]
[/textarea]

Поддерживаемое форматирование:

  • Жирный текст: **текст**
  • Курсив: *текст*
  • Зачеркнутый текст: ~~текст~~
  • Код в строке: `код`
  • Ссылки: [текст](url)

Смешанные обязательные и необязательные поля


[survey name="mixed-survey"]

[radio question="Какова ваша роль?" required="true"]

- Разработчик

- Дизайнер

- Менеджер

- Другое

[/radio]

[textarea question="Есть дополнительные мысли?" required="false"]

[/textarea]

[/survey]

Результаты опроса

В настоящее время у этого плагина нет пользовательского интерфейса для просмотра результатов опроса напрямую. Вместо этого вы можете использовать запросы Data Explorer для получения и анализа ответов на опрос. Вот пример запроса:

-- [params]
-- text :survey_name = survey

SELECT
  s.id,
  s.name,
  s.post_id,
  sf.question,
  COALESCE(sr.value, sfo.html) AS value,
  sr.user_id,
  sr.created_at AS responded_at
FROM
  surveys s
  JOIN survey_fields sf ON sf.survey_id = s.id
  JOIN survey_responses sr ON sr.survey_field_id = sf.id
  LEFT JOIN survey_field_options sfo ON sfo.id = sr.survey_field_option_id
WHERE
  s.name = :survey_name
ORDER BY
  s.id DESC

Поддержка экспорта страниц администратора из бэкенда

Посетите /admin/plugins/discourse-surveys/export

Права доступа и безопасность

  • Требуется вход в систему: анонимные пользователи должны войти в систему перед отправкой ответов

  • Один ответ на пользователя: каждый пользователь может отправить только один ответ на опрос

  • Права доступа к теме: пользователи должны иметь права на чтение темы, чтобы просматривать опросы

  • Права на публикацию: пользователи должны иметь права на публикацию в теме, чтобы отправлять ответы

  • Архивные темы: опросы в архивных темах не могут принимать новые ответы

  • Удаленные сообщения: опросы в удаленных сообщениях больше недоступны

Ограничения

  • Разрешен только один опрос в сообщении

  • Структуру опроса нельзя изменить после получения ответов

  • Вопросы всех полей опроса должны быть уникальными в рамках одного опроса

  • Вопросы полей опроса не могут быть пустыми

Технические детали

Схема базы данных

Плагин создает четыре основные таблицы базы данных:

  • surveys: основные записи опросов

  • survey_fields: отдельные поля в опросах

  • survey_field_options: варианты для полей с выбором

  • survey_responses: ответы пользователей на поля опроса

Стилизация

Плагин включает адаптивный CSS, который адаптируется к вашей теме. Пользовательские стили можно добавить, используя следующие CSS-классы:

  • .survey — основной контейнер опроса

  • .survey-field — обертка для отдельного поля

  • .field-[type] — контейнеры для конкретных типов полей

  • .submit-response — кнопка отправки

34 лайка

Значит, пользователи не видят результаты (если у них нет прав на использование запроса), и это полностью для администраторов или фоновых сотрудников?

3 лайка

Да, всё верно.

7 лайков

Это не кажется очень практичным :cry:

3 лайка

Нужна возможность публиковать результаты опроса. В противном случае лучше использовать несколько опросов.

3 лайка

Здравствуйте

Пример Markdown отображается в новой теме, как показано ниже. Мой Discourse обновлён до последней версии.

В чём может быть проблема?

С уважением

Привет, @ppcole,

Выше показано, что отображается в предпросмотре композитора при создании опроса. Как только вы создадите тему, она отобразится корректно, как и ожидалось.

Спасибо, Арпит. Всё сработало. Жду улучшений.

1 лайк

Подскажите, пожалуйста, вы работаете над этим, но без реального приоритета?

Было бы здорово, если бы это продолжали разрабатывать — у этого проекта огромный потенциал.

1 лайк

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

Однако с небольшой помощью генеративного ИИ мне удалось создать очень удобный запрос для Data Explorer. Из-за некоторых ограничений Data Explorer невозможно сделать его достаточно динамичным для обработки различных опросов; по сути, для каждого опроса требуется индивидуальный запрос.

К счастью, генеративный ИИ может сделать это довольно просто. Вот пример промпта, который, вероятно, сработает в большинстве сервисов генеративного ИИ (если у вас не активирован плагин ИИ) — просто вставьте свой опрос в формате Markdown, и вы сможете начать работу:

Промпт для генеративного ИИ для создания индивидуального SQL-запроса для конкретного опроса

У меня есть опрос, определенный в формате Markdown, и мне нужен SQL-запрос для извлечения результатов опроса из базы данных Discourse с использованием плагина Data Explorer. Опрос включает различные типы вопросов, такие как радио-кнопки, выпадающие списки, звезды, флажки, текстовые области, оценки большим пальцем и числа. Я хочу, чтобы запрос выдавал результаты, где у каждого пользователя одна строка, а у каждого вопроса — свой столбец. Для вопросов с флажками несколько ответов должны быть объединены в одну строку.

Вот опрос в формате Markdown:

Вставьте сюда ваш опрос в формате Markdown

Вот исходный запрос, использованный для получения результатов опроса:

-- [params]
-- text :survey_name = survey

SELECT s.id, s.name, s.post_id, sf.question, COALESCE(sr.value, sfo.html) AS value, sr.user_id, sr.created_at as responded_at
FROM surveys s
JOIN survey_fields sf ON sf.survey_id = s.id
JOIN survey_responses sr ON sr.survey_field_id = sf.id
LEFT JOIN survey_field_options sfo ON sfo.id = sr.survey_field_option_id
WHERE s.name = :survey_name
ORDER BY s.id DESC

Пожалуйста, сгенерируйте SQL-запрос, который:

  • Задаёт название опроса в виде константы.
  • Использует условную агрегацию для поворота данных, где каждый вопрос становится столбцом.
  • Использует STRING_AGG для вопросов с флажками для обработки нескольких ответов.
  • Гарантирует, что выходные данные сгруппированы по user_id и отсортированы по user_id.
  • Отформатирован для удобства чтения и включает комментарии, объясняющие логику там, где это необходимо.

Дополнительные рекомендации для плагина Data Explorer:

  • Запрос должен быть совместим с плагином Data Explorer для Discourse, что означает, что он не должен заканчиваться точкой с запятой.
  • Используйте имена столбцов, такие как user_id, чтобы использовать функции автоматической ссылки внутри Data Explorer.
  • Избегайте использования динамического SQL, так как плагин его не поддерживает.
  • Убедитесь, что запрос эффективен и оптимизирован для производительности, так как он может выполняться на больших наборах данных.
9 лайков

Это отличный маленький плагин, который удивительно богат на функции. Спасибо за его создание.

@nathank, отличная работа над руководством по быстрому созданию запросов результатов. Это делает весь плагин ещё более полезным :rocket: (и его стоит перенести в первое сообщение).

4 лайка

Я установил это на свой самохостинговый сайт, чтобы попробовать, и это действительно здорово!

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

И, конечно же, возможность просматривать результаты, как это делается с голосованием, без необходимости обращаться к Data Explorer, была бы замечательной.

8 лайков

Да, я столкнулся с той же проблемой. Надеюсь, решение найдётся.

3 лайка

Есть ли обновления для функции опроса?

1 лайк

Кстати, какое обновление вы ожидали?

Я думаю, что его можно выпустить уже сейчас, чтобы мы могли приступить к работе и в простой форме протестировать, как он работает в наших сообществах :slight_smile:

2 лайка

Я хотел бы иметь настройку, которая позволяла бы пользователям анонимно отправлять формы опросов.

FEATURE: Allow anonymous survey submissions gated by surveys_allow_anonymous_submissions by singi2016cn · Pull Request #109 · discourse/discourse-surveys

Ранее ответы на опросы могли отправлять только авторизованные пользователи, так как SurveyController требовал ensure_logged_in, а поле survey_responses.user_id имело ограничение NOT NULL.

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

Содержимое коммита (17 файлов, +651/−74)

  • Функциональность: настройка сайта + миграции (поле user_id становится nullable, добавляется anon_token, частичный уникальный индекс) + серверная логика для анонимных ответов + ограничение по IP + отключение проверки авторизации и управление токеном на фронтенде
  • Исправления: потеря анонимных ответов при экспорте в CSV, неправильный подсчет в админ-панели, отсутствующая строка перевода survey.no_survey_with_this_name
  • i18n: полное совпадение по 26 ключам для локалей en и zh_CN
  • Документация: исправление 5 противоречий в README, добавление раздела «Anonymous Responses»
  • Тестирование: 125 тестов успешно проходят (lib: 26 / requests: 38 / system: 61)

feat: добавлены индикаторы обязательных полей, обновлены стили и поддержка локализации

UX: Отображение индикатора обязательного поля в обязательных полях опросов от singi2016cn · Pull Request #108 · discourse/discourse-surveys

Теперь справа от обязательных полей появляется красная звёздочка, чтобы сообщить пользователю, что это поле обязательно для заполнения.

После отправки пользователь может увидеть отправленную информацию, а также изменить её повторно.