Списки сокращений и символов

глоссарии — дополнительный набросок или список, составленный вручную, если этого достаточно.

Списки сокращений и символов

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

Автоматизированный маршрут

\usepackage[acronym]{glossaries-extra}
\makeglossaries
\newacronym{ml}{ML}{machine learning}

Опция acronym включает поддержку акронимов, а \makeglossaries включает механизм, который собирает записи во время компиляции. Каждый \newacronym принимает три аргумента: ключ, который вы вводите в текст, короткую форму и длинную форму. Определите их все в преамбуле или в отдельном файле \input, чтобы они находились в одном месте.

В теле вы никогда не вводите саму аббревиатуру:

\gls{ml} on first use expands; later uses stay short.
\printglossaries

Первый \gls{ml} в документе печатает «машинное обучение (ML)», а каждый последующий печатает просто «ML». Поскольку пакет отслеживает использование, а не положение в источнике, расширение следует за первым использованием, куда бы его ни переместила реструктуризация. \printglossaries печатает собранный список сокращений, где бы вы его ни разместили, обычно после оглавления. Связанные команды объясняют грамматику: \glspl для множественного числа, \Gls для начала предложения с заглавной буквы.

Загвоздка в сборке. Между проходами LaTeX помощник makeglossaries должен запускаться для сортировки и форматирования записей, иначе \printglossaries молча ничего не выдаст. Полные настройки latexmk обрабатывают это автоматически. Более простые конвейеры могут этого не сделать, и глоссарии-дополнительные предлагают для них запасной вариант. Если ваш список упорно отказывается появляться, первым подозреваемым является отсутствующий вспомогательный запуск, который намного опережает ошибку в вашем документе.

Маршрут, построенный вручную

Для простого списка символов часто достаточно поддерживаемой вручную среды описания:

\section*{Notation}
\begin{description}
\item[$\eta$] learning rate
\item[$\theta$] model parameters
\end{description}

Каждый \item[...] печатает свой аргумент скобки в виде жирной метки с последующим объяснением, которое в точности соответствует форме списка обозначений. Отслеживание первого использования не предусмотрено, но список символов редко в нем нуждается; символы определяются там, где они впервые появляются в математических вычислениях.

Честный совет — подбирать инструмент в соответствии с масштабом. Документ с пятью аббревиатурами легче обрабатывать вручную. Диссертация на 200 страниц с сорока — нет, а там пакет окупает стоимость установки во много раз. Урок списков более подробно описывает среду description.

Вернуться к Полная форма