Macros que mantêm a notação honesta

newcommand, NewDocumentCommand e um arquivo de macros compartilhado.

Macros que mantêm a notação honesta

Todo artigo tem notações que se repetem: os números reais, um operador de esperança, um valor absoluto com barras do tamanho certo. Se você digita \mathbb{R} em quarenta lugares e seu orientador depois prefere \mathbf{R}, são quarenta edições a fazer, e você vai esquecer uma. Uma macro transforma essa notação em um único comando nomeado, definido uma vez. Mude a definição e o documento inteiro acompanha. É assim que se mantém a notação honesta: o código-fonte não tem como ficar fora de sincronia consigo mesmo.

Definindo comandos com newcommand

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

A primeira definição é do tipo mais simples: \R agora é uma abreviação pura, e digitar \R em qualquer lugar produz \mathbb{R}.

A segunda forma recebe um argumento. O [1] depois do nome declara que \E aceita um argumento, e #1 marca onde esse argumento entra na expansão. Assim, \E{X} vira \mathbb{E}\left[X\right]. A definição traz mais do que brevidade: o par \left[ e \right] faz os colchetes crescerem para caber no que estiver dentro, então \E{\frac{X}{n}} ganha colchetes altos automaticamente. A macro \abs faz o mesmo com \lvert e \rvert, o par correto de barras verticais para o valor absoluto. Você pode declarar até nove argumentos e se referir a eles como #1 até #9.

Se um comando já existe, \newcommand se recusa a redefini-lo e para com um erro, o que protege você de quebrar algo em silêncio. Para substituir de propósito um comando existente, use \renewcommand.

A interface moderna

O LaTeX atual também traz um comando de definição mais rico:

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

\NewDocumentCommand usa uma cadeia de especificação de argumentos em vez de uma contagem. Aqui mm significa dois argumentos obrigatórios, então \citepair{knuth84}{lamport94} cita as duas chaves. A linguagem de especificação vai além do que \newcommand consegue: o declara um argumento opcional entre colchetes, s detecta uma variante com asterisco e O{default} dá um valor padrão a um argumento opcional. Para qualquer coisa além da substituição simples, use esta interface.

Compartilhe as definições

Mantenha um macros.sty compartilhado entre os capítulos. Coloque as suas definições nesse único arquivo, carregue-o com \usepackage{macros} em cada documento, e todos os capítulos de uma tese, mais os slides e a versão em artigo, concordam quanto à notação. Quando um colaborador entra, ele lê um arquivo curto para aprender as suas convenções em vez de fazer engenharia reversa a partir do texto. Isso combina naturalmente com uma estrutura de vários arquivos.

Uma dica sobre nomes: dê às macros nomes com significado, como \abs ou \norm, em vez de nomes baseados na aparência, como \bigbars. O nome deve dizer o que a notação significa, para que a definição fique livre para mudar o visual. E resista a definir uma macro para algo que você usa duas vezes; o retorno começa por volta do terceiro uso.

Voltar para Tempo de execução