Сноска в Discourse

||||
-|-|
:discourse2: | Краткое описание | Плагин Discourse Footnote позволяет пользователям создавать сноски в формате Markdown в своих сообщениях.
:open_book: | Руководство по установке | Этот плагин входит в состав ядра Discourse. Отдельная установка плагина не требуется.

Включение сносок

Плагин Footnote включен по умолчанию, но его можно отключить/включить на странице admin/plugins:

enable footnote

Возможности

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

Предложение, требующее сноски. ^[Сноска] 
Еще одно предложение, требующее сноски. ^[Вторая сноска]

Или так:

Предложение, требующее сноски. [^1] 
Еще одно предложение, требующее сноски. [^2]

[^1]: Сноска
[^2]: Вторая сноска

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

Существует два способа отображения сносок, управляемые настройкой администратора display footnotes inline (отображать сноски в строку):

Не в строку:

В строку:

Предложение, требующее сноски[1]
Еще одно предложение, требующее сноски[2]

Варианты отображения в строку совместимы с цитатами и удобны для мобильных устройств.

Настройки

Название | Описание
|-|
enable markdown footnotes | включить синтаксис Markdown для сносок на этом сайте
display footnotes inline | включить раскрытие сносок в строку

:discourse2: Хостинг предоставляется нами? Этот плагин доступен на всех тарифах хостинга Footnote | Discourse - Civilized Discussion

История разработки

Discourse Footnote переупаковывает расширение footnote markdown-it от @Vitaly как плагин для Discourse.


  1. Сноска ↩︎

  2. Вторая сноска ↩︎

73 лайка

Просто предупреждение: похоже, расширение не поддерживает обычный Markdown для сносок с использованием [^1]. Форматированные сноски появляются только при использовании «встроенного» форматирования, например так:

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

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

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

5 лайков

Рецепт для разрешения вашим пользователям создавать всплывающий контент внутри строки с помощью этого плагина Discourse Footnote:

Используйте этот плагин вместе с компонентом темы кнопки «Footnote» для редактора [1] (он добавляет кнопку в редактор/компоновщик для создания сносок)

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

Примеры:

Текст [2]


Текст и загрузка изображения [3]


HTML-контент [4]


  1. (установите оба) ↩︎

  2. Простой текст здесь. ↩︎

  3. Текст и загрузка изображения

    ↩︎

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


    Открытость и обмен

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

    ↩︎

14 лайков

Работает ли плагин сносок на публичных страницах? В моём конкретном случае мне нужно, чтобы он НЕ работал на публичных страницах и был виден только в обычном просмотре темы (например, для внутренних заметок и т.п.)

@jrgong — нет…

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

2 лайка

Похоже, это было перенесено в ядро 17 часов назад.

Я передам кому-то другому обновление этого сообщения.

Перевод отсутствует: en.Плагин discourse-footnote был интегрирован в ядро Discourse. Пожалуйста, удалите плагин из вашего app.yml и пересоберите контейнер.
3 лайка

После переноса в ядро

я удалил плагин из app.yml и выполнил ./launcher rebuild app,

но настройки остались на странице плагина. Можно ли оставить всё как есть?

Это новый. :+1: Вот снимок обоих для сравнения:

старый

новый

4 лайка

Звучит действительно здорово! :+1: Спасибо, что поделились. :smiling_face_with_three_hearts:

Спасибо, что упомянули об этом, я только что применил исправление.

3 лайка

Другая проблема заключается в том, что вам больше не нужно устанавливать плагин, и если вы его уже установили, вам не нужно включать команду git clone в ваш файл yml.

2 лайка

Я слишком медленно обновлял тему новой информацией, и вы меня опередили. :slight_smile:

Всё равно добавлю своё мнение сейчас…


:information_source: Discourse Footnote теперь включён в ядро Discourse, поэтому этот плагин больше не нужно устанавливать отдельно. :partying_face:

Если вы используете самохостинг, вы увидите на своей панели управления информацию об удалении его из файла app.yml.

:discourse2: Размещено нами? Это изменение никак не затронет вас. :+1: Вы можете продолжать пользоваться этим плагином и ни о чём не беспокоиться.

4 лайка

Да. Извините за это.

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

Прошло ещё меньше 24 часов, так что, знаете, это тоже довольно неплохо.

Спасибо.

4 лайка

3 сообщения были перенесены в новую тему: Добавить опцию сноски в меню шестеренки редактора

Есть ли способ отформатировать сноску как обычно? Чтобы она не шла в одну строку с тремя точками, как здесь?[1]

А вместо этого сделать так?


  1. Это выглядит странно для меня ↩︎

Это тот параметр?

1 лайк

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

Нет, пользовательских настроек для этого нет. Только глобальная.

1 лайк

Я заметил, что сноски не позволяют использовать многие элементы синтаксиса Markdown внутри скобок сноки^[Пример: Это находится внутри скобок сноки, но макет ломается, когда я добавляю абзацы, заголовки, списки и т. д.

Вот разрыв абзаца.]

Это не критично, но, безусловно, ограничивает функциональность того, что можно поместить в сноску!

Вы можете, главное — используйте отступ минимум в 4 пробела.

Например:


Вот ссылка на сноску[^1], и ещё одна[^longnote].

[^1]: Вот текст сноски.

[^longnote]: Вот пример с несколькими блоками.

    Последующие абзацы имеют отступ, чтобы показать, что они
относятся к предыдущей сноске.

    * item1
    * item 2

    **Больше** текста

    <em>курсив</em>

Вот ссылка на сноску[1], и ещё одна[2].

Результат:


  1. Вот текст сноски. ↩︎

  2. Вот пример с несколькими блоками.

    Последующие абзацы имеют отступ, чтобы показать, что они
    относятся к предыдущей сноске.

    • item1
    • item 2

    Больше текста

    курсив ↩︎