Specus
markdown-report-format.md
MarkdownReport: формат публичных отчетов
Скачать .mdСкачать папку .zip

MarkdownReport: формат публичных отчетов

Этот документ фиксирует поддерживаемые блоки публичных Markdown-отчетов Specus.

Мелкий текст

Мелкий текст предназначен для технических оговорок, библиографии и сносок. Размер, линии, интервалы и цвета задаются централизованно в app/globals.css через класс report_microtext и его варианты.

Замечание

:::note
Значения предварительные и требуют проверки для конкретного участка.
:::

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

Литература и источники

:::references
<!-- notts:start -->

1. Автор. *Название*. Издатель, год. [Источник](https://example.com/).

<!-- notts:end -->
:::

Источники оформляются нумерованным списком. Для книги указываются автор, название, место или издатель и год; для статьи — журнал, том, номер, страницы и DOI; для стандарта — организация, номер и год. Ссылки ведут на DOI, страницу издателя или официальный документ.

Сноски

:::footnotes
1. Пояснение к термину или числовому значению.
2. Граница применимости утверждения.
:::

Сноски используются для коротких пояснений, которые мешают основному ритму текста. Библиографические ссылки следует помещать в references.

Ограничения вложенности

Блоки note, references и footnotes размещаются непосредственно в секции отчета. Их не следует вкладывать внутрь exhibit, media, content или другого контейнера.

Доступность и озвучивание

Замечания и сноски остаются озвучиваемыми. Библиография, URL и технические выходные данные заключаются между notts:start и notts:end.