Акроніми та списки символів

Начерк із 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.

Назад до Довга форма