Аббревиатуры и списки обозначений

Набросок на glossaries-extra или список вручную, когда этого достаточно.

Аббревиатуры и списки обозначений

Длинные документы обрастают сокращениями, а правила обращения с ними строгие. Аббревиатуру при первом употреблении расшифровывают полностью, дальше пишут сокращённо, а в диссертации в начале обычно нужен ещё и список сокращений. Вести его вручную рано или поздно подводит, причём всегда одинаково. Вы переставляете две главы, первое употребление сдвигается, и вдруг «ML» встречается за три страницы до «machine learning (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} в документе выводит «machine learning (ML)», а все последующие выводят просто «ML». Пакет отслеживает сами употребления, а не их место в исходнике, поэтому расшифровка следует за первым употреблением, куда бы вы его ни перенесли при перестройке текста. \printglossaries выводит собранный список сокращений там, где вы его поставите, обычно после оглавления. Грамматику вокруг этого обслуживают родственные команды: \glspl для множественного числа, \Gls для написания с заглавной буквы в начале предложения.

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

Способ вручную

Для простого списка обозначений часто хватает окружения description, которое вы ведёте сами:

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

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

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

Вернуться к Длинные документы