Макроси, що не дають позначенням розходитися

newcommand, NewDocumentCommand, спільний файл макросів.

Макроси, що не дають позначенням розходитися

У кожній статті є позначення, що повторюються: дійсні числа, оператор математичного сподівання, модуль із вертикальними рисками потрібного розміру. Якщо ви набрали \mathbb{R} у сорока місцях, а науковий керівник згодом віддав перевагу \mathbf{R}, вам доведеться виправити сорок місць, і одне ви обов’язково пропустите. Макрос перетворює таке позначення на одну іменовану команду, визначену раз. Змініть визначення, і слідом зміниться весь документ. Так позначення лишаються узгодженими: вихідний текст не може розійтися сам із собою.

Визначення команд через newcommand

\newcommand{\R}{\mathbb{R}}
\newcommand{\E}[1]{\mathbb{E}\left[#1\right]}
\newcommand{\abs}[1]{\left\lvert #1 \right\rvert}

Перше визначення найпростіше: \R тепер просто скорочення, і \R будь-де дає \mathbb{R}.

Друга форма приймає аргумент. [1] після назви оголошує, що \E приймає один аргумент, а #1 позначає, куди в розгорнутому тексті потрапляє цей аргумент. Отже, \E{X} перетворюється на \mathbb{E}\left[X\right]. Це визначення дає більше за лаконічність: пара \left[ і \right] змушує дужки підлаштовуватися під вміст, тож \E{\frac{X}{n}} автоматично отримує високі дужки. Макрос \abs робить те саме з \lvert і \rvert, правильною парою вертикальних рисок для модуля. Можна оголосити до дев’яти аргументів і звертатися до них як #1 до #9.

Якщо команда вже існує, \newcommand відмовляється її перевизначати й зупиняється з помилкою, що захищає вас від непомітної поломки. Щоб навмисно замінити наявну команду, використовуйте \renewcommand.

Сучасний інтерфейс

Поточний LaTeX також постачає потужнішу команду визначення:

\NewDocumentCommand{\citepair}{mm}{\cite{#1}, \cite{#2}}

\NewDocumentCommand використовує рядок специфікації аргументів замість кількості. Тут mm означає два обов’язкові аргументи, тож \citepair{knuth84}{lamport94} цитує обидва ключі. Мова специфікації вміє більше, ніж \newcommand: o оголошує необов’язковий аргумент у квадратних дужках, s розпізнає варіант із зірочкою, а O{default} задає необов’язковому аргументу типове значення. Для всього, що складніше за просту підстановку, беріться за цей інтерфейс.

Спільні визначення

Тримайте файл macros.sty, спільний для всіх розділів. Складіть свої визначення в цей один файл, підключайте його через \usepackage{macros} у кожному документі, і кожен розділ дисертації, а також слайди та версія статті узгоджуватимуть позначення. Коли долучається співавтор, він читає один короткий файл, щоб дізнатися ваші домовленості, замість того щоб відновлювати їх із тексту. Це добре поєднується з налаштуванням із кількома файлами.

Порада щодо назв: давайте макросам змістовні назви, як-от \abs чи \norm, а не назви за виглядом, як-от \bigbars. Назва має казати, що означає позначення, тоді визначення вільно змінюватиме його вигляд. І не поспішайте робити макрос для того, що вживаєте двічі: користь починається десь із третього вживання.

Назад до Середовище виконання