Расширить Footnote, включив 'annotations'

Проверка… Редактор всегда показывает что-то отличное от того, что отображается в теме обсуждения [1] markdown: [^note] + [^note]: Это должно быть сноской.

В тестовом посте на discourse.python.org размещение курсора как внутри, так и вне квадратных скобок приводит к появлению встроенной заметки [2] markdown: ^[это закодировано как встроенная заметка].

…и то же самое происходит здесь. В окне предварительного просмотра редактора это выглядит отлично, но в теме отображается не так, как ожидалось. (К тому же гиперссылки в текущей тёмной теме на discourse.python.org очень тёмные и маленькие.)

Кажется, я буду использовать раскрывающиеся списки <1>.

<1>

Потому что я могу размещать их сразу после абзаца, связанного с дополнительной информацией, и они, возможно, даже в свернутом виде займут меньше строк, чем длинная сноска. (Пытался использовать квадратные скобки вокруг ‘1’, но не смог понять, как экранировать их, чтобы не запутать парсер markdown.)


  1. Это должно быть сноской. ↩︎

  2. Это закодировано как встроенная заметка ↩︎

1 лайк

У нас возникают трудности с этим на discuss.python.org.

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

Главное отклонение от идеала — использование термина «сноска» для элемента, который очевидно является чем-то другим. Встроенная заметка располагается в тексте, тогда как сноска находится в нижней части страницы (в нашем случае — внизу сообщения).

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

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

В любом случае, мы в discuss.python.org очень хотели бы иметь возможность использовать как встроенные заметки, так и сноски. Это усилило бы привлекательность хорошо составленного поста в теме.

Один из вариантов — сделать положение курсора двумя разными переключателями:
^[txt] — для создания встроенной заметки.
[^lbl] — для создания сноски.
^[^lbl] — для создания встроенной заметки, текст которой находится удалённо от места её отображения.

Общее название для этих двух элементов дополнительного текста — «Аннотации».

2 лайка

Я думаю, что это, вероятно, лучше всего решить в рамках спецификации CommonMark. См. How should footnotes behave? - Extensions - CommonMark Discussion, как указано выше.

3 лайка

Согласен, Мэтью. И спасибо за указание на ссылки. К сожалению, эти ссылки немного скудны, и я не нашел здесь более подходящих тем. Возможно, на CommonMark.org есть более свежие обсуждения.

Решено, да. Однако сначала мне нужно разобраться, что и как представить ситуации в CommonMark. Я опубликовал это здесь, так как мнение других пользователей поможет в обсуждении, когда тема будет передана в CommonMark. Discourse также является нашим непосредственным «родителем» как пользователей, и Сэм и другие, вероятно, захотят узнать, насколько хорошо работает расширение для сносок для его пользователей.

Поэтому делитесь своими мыслями — и побыстрее, потому что на эту тему есть «утилизатор», который удаляет сообщения через 30 дней!

1 лайк

@mlgtechuser, если я правильно понял, это может быть примером:

Если вы попробуете вместо этого discussion.fedoraproject.org/new-topic и введёте:

[^1]

[^1]: Содержание

…вы, возможно, увидите более ожидаемый результат, так как сноска будет отображаться как библиографическая ссылка (а не как встроенный блок, видимый только при выборе её встроенной числовой ссылки).

В противном случае, если вы просите, чтобы оба режима сосуществовали, то есть некоторые «аннотации» отображались как библиографические сноски в конце документа, а другие оставались встроенными, я полностью согласен: это было бы феноменально.