Macros que mantienen la notación coherente

newcommand, NewDocumentCommand y un archivo de macros compartido.

Macros que mantienen la notación coherente

Todo artículo tiene notación que se repite: los números reales, un operador de esperanza, un valor absoluto con barras del tamaño adecuado. Si escribes \mathbb{R} en cuarenta sitios y luego tu tutor prefiere \mathbf{R}, tienes cuarenta ediciones por hacer y se te escapará una. Una macro convierte esa notación en un único comando con nombre, definido una sola vez. Cambias la definición y todo el documento la sigue. Así se mantiene la notación coherente: el código fuente no puede desincronizarse consigo mismo.

Definir comandos con newcommand

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

La primera definición es la más simple: \R es ahora una abreviatura pura, y escribir \R en cualquier sitio produce \mathbb{R}.

La segunda forma recibe un argumento. El [1] tras el nombre declara que \E acepta un argumento, y #1 marca dónde cae ese argumento en la expansión. Así, \E{X} se convierte en \mathbb{E}\left[X\right]. La definición aporta más que brevedad: la pareja \left[ y \right] hace que los corchetes crezcan para ajustarse a lo que haya dentro, de modo que \E{\frac{X}{n}} obtiene corchetes altos automáticamente. La macro \abs hace lo mismo con \lvert y \rvert, la pareja correcta de barras verticales para el valor absoluto. Puedes declarar hasta nueve argumentos y referirte a ellos como #1 hasta #9.

Si un comando ya existe, \newcommand se niega a redefinirlo y se detiene con un error, lo cual te protege de romper algo sin darte cuenta. Para sustituir deliberadamente un comando existente, usa \renewcommand en su lugar.

La interfaz moderna

LaTeX actual incluye también un comando de definición más completo:

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

\NewDocumentCommand usa una cadena de especificación de argumentos en lugar de un recuento. Aquí mm significa dos argumentos obligatorios, así que \citepair{knuth84}{lamport94} cita las dos claves. El lenguaje de especificación llega más lejos que \newcommand: o declara un argumento opcional entre corchetes, s detecta una variante con asterisco y O{default} da un valor por defecto a un argumento opcional. Para cualquier cosa más allá de una simple sustitución, recurre a esta interfaz.

Comparte las definiciones

Mantén un macros.sty compartido entre los capítulos. Pon tus definiciones en ese único archivo, cárgalo con \usepackage{macros} desde cada documento, y todos los capítulos de una tesis, además de las diapositivas y la versión del artículo, coincidirán en la notación. Cuando se une un colaborador, lee un único archivo corto para aprender tus convenciones en lugar de deducirlas del texto. Esto se combina de forma natural con una configuración de varios archivos.

Un consejo sobre los nombres: da a las macros nombres con significado, como \abs o \norm, en lugar de nombres basados en la apariencia, como \bigbars. El nombre debe decir qué significa la notación, de modo que la definición sea libre de cambiar su aspecto. Y resiste la tentación de definir una macro para algo que usas dos veces; la recompensa empieza hacia el tercer uso.

Volver a Tiempo de ejecución