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

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

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

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

Параметр acronym дає змогу підтримувати акроніми, а \makeglossaries вмикає механізм, який збирає записи під час компіляції. Кожен \newaccronym приймає три аргументи: ключ, який ви вводите в тексті, коротку форму та довгу форму. Визначте їх усі у преамбулі або в окремому файлі, який ви \input, щоб вони були в одному місці.

У тілі ви ніколи не вводите саму абревіатуру:

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

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

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

Маршрут, побудований своїми руками

Для простого списку символів часто достатньо середовища «опису», створеного вручну:

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

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

Щира порада - підібрати інструмент до масштабу. Папір із п’ятьма абревіатурами легше обробляти вручну. 200-сторінкова дисертація з сорока – це не так, і там пакет багаторазово окупає вартість його налаштування. Урок зі списками більш детально розглядає середовище опис.