Добавить ссылку на документацию CommonMark из редактора

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

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

7 лайков

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

11 лайков

Очень быстрая реализация: настройте тексты ключей education.* на сайте, чтобы они вели на пользовательскую тему для вашего сайта. :sunglasses:

6 лайков

Эти сообщения отображаются только в первые несколько раз, когда вы создаёте новую тему или ответ, верно?

2 лайка

Да, но это также делает их гораздо более подходящим местом для этой информации :information_source:

4 лайка

Я не согласен. Это будет ссылка на справочник, к которому можно обратиться, если вы забыли какой-то редко используемый синтаксис Markdown. Это не то, что нужно прочитать один раз и больше никогда не возвращаться к этому.

1 лайк

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

Они не будут.

Лучшие подходы предполагают предоставление информации пользователю именно тогда, когда она ему наиболее нужна — а не вываливать кучу случайных постоянных ссылок на экране «на всякий случай», которые в 99,999 % случаев будут проигнорированы и лишь добавят визуального шума для всех пользователей.

3 лайка

Нет, извините, что разочаровал. :grin: Это просто эгоистичное предложение о функции, которая была бы удобна лично мне. Идея вдохновлена редактором GitHub, где есть ссылка на спецификацию Markdown, к которой я иногда обращаюсь.

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

Я предполагаю, что фраза «Вы нажали кнопку :heart?» является примером такого подхода? По какой-то причине Discourse предполагает, что я согласен с постом, на который отвечаю, если моё сообщение содержит очень мало символов. Когда я впервые столкнулся с этим, это предположение было неверным и вызвало лишь путаницу и разочарование.

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

2 лайка

Если вам нужна общая справка по Markdown, посетите commonmark.org!

1 лайк

Ещё один голос за небольшую клавишу :grey_question: в правом верхнем/нижнем углу поля ввода.

:ballot_box:

Этот плагин существует уже довольно давно

15 лайков

Люди, которым это было бы удобно, способны заниматься самолечением, самостоятельно находя нужную информацию. Они уже :star: отличники.

Кроме того… если бы пользователи действительно читали что-либо (а они не читают), они бы дошли до шага форматирования в интерактивном приветственном ЛС от discobot, которое получают все новые пользователи. Это лучше всего, так как оно динамично и интерактивно, использует настоящий редактор и содержит ссылки на справку.

Проверьте свои ЛС, и вы увидите там то же самое приветственное сообщение.

6 лайков

Спасибо. Я предполагал, что что-то подобное уже должно существовать, но не смог этого найти.

К сожалению, у меня это не работает. Ошибка сообщена здесь: Plugin not working with Discourse 2.5.0.beta1 · Issue #12 · cpradio/discourse-plugin-composer-help-button · GitHub

3 лайка

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

Мое предложение в качестве решения — добавить синюю панель в верхней части редактора для новых пользователей с текстом вроде:

«Узнайте больше о форматировании текста с помощью Markdown здесь: [ссылка]»

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

3 лайка

Как сказал Джефф, discobot обучает основам Markdown. Включен ли discobot на вашем экземпляре?

3 лайка

Да. Случилась серендипность: кто-то надо мной издевался и угрожал не пользоваться Discourse, если я не смогу объяснить, как им пользоваться.

В итоге я скопировал и вставил эту статью и закрепил её глобально на форуме. По пути я узнал несколько вещей, о которых раньше не знал.

2 лайка

Более простой подход мог бы заключаться в ссылке на

https://commonmark.org/help/

и

https://blog.discourse.org/2016/12/discourse-new-user-tips-and-tricks/

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

3 лайка