Сноски, заметки на полях и оформление кода

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

Настройка EasyLaTeX для русского текста: XeLaTeX с fontspec и babel; для заметок на полях нужен marginnote, для блоков кода — listings. Последний подходит для приведённых здесь ASCII-примеров, но ограниченно поддерживает Unicode. Для многоязычного кода выберите совместимую дословную или подсвечиваемую среду с движком, поддерживающим Unicode.

Добавление сносок#

Используйте \footnote{...} там, где нужно пояснение:

1Для этого термина используется стандартное отраслевое определение\footnote{Формулировка может немного отличаться в разных стандартах.}.

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

Разделение знака сноски и текста#

Там, где обычная сноска напрямую не работает, например в некоторых таблицах и заголовках, разделите знак и текст:

1Подпись таблицы\footnotemark2...3\footnotetext{Эти данные округлены.}

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

Заметки на полях#

LaTeX предоставляет \marginpar; \marginnote удобен для коротких комментариев в текущем месте:

1\usepackage{marginnote}2​3Этот вывод нужно проверить.\marginnote{Нужен источник}

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

Код внутри строки#

Для коротких команд, имён файлов и переменных используйте \texttt:

1Основной файл обычно называется \texttt{main.tex}.

Для буквального содержимого, в котором нет выбранного разделителя, используйте \verb|...|:

1\verb|\section{Заголовок}|

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

Блоки кода#

Для небольшого объёма дословного текста используйте verbatim:

1\begin{verbatim}2main.tex3figures/result.pdf4\end{verbatim}

Для нумерации, переноса длинных строк и подсветки синтаксиса используйте listings:

1\usepackage{listings}2\usepackage{xcolor}3\lstset{4  basicstyle=\ttfamily\small,5  frame=single,6  breaklines=true7}8​9\begin{lstlisting}[language=Python]10total = sum(values)11print(total)12\end{lstlisting}

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

Частые проблемы#

Сноски переходят на следующую страницу#

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

Заметки на полях перекрываются#

Сократите их, уменьшите количество на странице или используйте сноски. Заметки на полях не подходят для плотного комментирования и существенного основного содержимого.

В listings искажается текст не из ASCII#

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

Полный пример#

1\documentclass[a4paper,12pt]{article}2\usepackage{fontspec}3\setmainfont{CMU Serif}4\setsansfont{CMU Sans Serif}5\setmonofont{CMU Typewriter Text}6\usepackage[russian]{babel}7\usepackage{marginnote}8\usepackage{listings}9\usepackage{xcolor}10\lstset{basicstyle=\ttfamily\small, frame=single, breaklines=true}11​12\begin{document}13​14Используйте \texttt{main.tex} как основной файл\footnote{Единственная точка входа сборки проекта.}.15\marginnote{Проверьте движок перед компиляцией}16​17\begin{lstlisting}[language=Python]18total = sum(values)19print(total)20\end{lstlisting}21​22\end{document}