Quarto. Примечания

2026-04-10 · 3 мин. для прочтения
blog computer-science

Quarto. Способы добавить примечания.

Содержание

1 Сноски

  • Дополнительные комментарии, ссылки, пояснения.
  • Как стандартные сноски.
  • В тексте — цифра-ссылка, текст примечания — внизу страницы или в конце документа.
  • В нужном месте текста поставьте сноску, используя синтаксис ^[Текст вашего примечания].
  • Номер сноски присвоится автоматически.
    Это основная мысль документа^[А это важное примечание для соавтора, которое уточняет детали.].
    
    А здесь мы видим ещё один аспект^[И ещё один комментарий от рецензента.].
    

2 Именованные сноски

  • Стандартный синтаксис сноски ^[Текст] не поддерживает абзацы (то есть пустые строки) внутри себя.
  • После первой пустой строке сноска оборвётся.
  • Вместо краткой ^[] ссылки можно использовать полный синтаксис с меткой.
  • Он позволяет внутри сноски делать пустые строки, создавая настоящие абзацы.
  • В нужном месте текста поставьте ссылку на сноску, например [^mycomment]:
Вот основное предложение, требующее развёрнутого комментария.[^mycomment]
  • Где-нибудь ниже (например, в конце раздела или документа) напишите определение сноски.
  • Каждый следующий абзац внутри сноски должен начинаться с отступа в 4 пробела (или одной табуляции).
[^mycomment]: Первый абзац примечания для другого человека. Здесь можно написать несколько предложений.

    Второй абзац. Он отделён пустой строкой и отступом в 4 пробела в начале. Вы можете продолжать так сколько угодно.

    Третий абзац. Внутри сноски можно использовать любую разметку Markdown: *курсив*, **жирный**, даже `код` или списки:

    - элемент списка
    - ещё элемент

3 Заметки на полях (маргиналии) (margin notes)

  • Активно использовал Эдвард Тафти.

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

  • Примечание выносится на широкое поле, обычно справа.

  • В YAML-шапке документа нужно увеличить ширину поля, чтобы на нём помещался текст:

    title: "Мой документ"
    format:
      html:
        grid:
          margin-width: 350px
    
  • В основном тексте оберните нужный абзац или элемент в специальный div:

    ::: {.column-margin}
    Это примечание для другого человека. Оно будет выделено на широком правом поле, рядом с основным текстом.
    :::
    

4 Выноски (callout)

  • Информация, на которую нужно обратить внимание.
  • Выглядят как цветные блоки с иконками.
  • Синтаксис блока с :::.
  • Один из пяти типов: note, tip, warning, caution, important.
  • Можно сделать сворачиваемыми с помощью параметра collapse="true".
::: {.callout-note}
## Примечание для рецензента
Пожалуйста, обратите особое внимание на аргументацию в третьем разделе.
:::

::: {.callout-tip collapse="true"}
## Подсказка для коллеги
Этот блок можно свернуть. Здесь лежат справочные данные, которые не нужно показывать постоянно.
:::

5 Комментарии в коде (code annotations)

  • Аннотации в коде.
  • Они появятся в виде нумерованного списка под блоком кода.
  • В нужных строках кода после комментария (# в R или Python) поставьте номер аннотации в угловых скобках, например # <1>.
  • Сразу после блока с кодом создайте нумерованный список, где каждый пункт соответствует номеру аннотации.
```{r}
#| echo: true
# Загружаем данные <1>
library(ggplot2)

# Строим график <2>
ggplot(mtcars, aes(x=wt, y=mpg)) + geom_point()
```

1.  Здесь мы подключаем необходимую библиотеку.
2.  Строится точечный график зависимости расхода топлива от веса.

6 Сводная таблица

МетодСинтаксисГде отображаетсяДля чего лучше всего подходит
Сноски^[Текст примечания]Внизу страницы или в конце документаНебольшие уточнения, ссылки, справочная информация.
Заметки на полях:::{.column-margin}...:::На широком правом полеКомментарии, которые должны быть всегда на виду рядом с текстом.
Блоки Callout:::{.callout-note}...:::Внутри основного текста, как заметный блокВажные предупреждения, подсказки, инструкции.
Аннотации к коду# <1> и список 1. ...Под блоком с кодомПояснения к конкретным строкам кода.
Дмитрий Сергеевич Кулябов
Authors
Профессор кафедры теории вероятностей и кибербезопасности
Работаю профессором на кафедре теории вероятностей и кибербезопасности Российского университета дружбы народов им. Патриса Лумумбы. Научные интересы относятся к области теоретической физики и математического моделирования.