Des macros pour une notation cohérente
newcommand, NewDocumentCommand, un fichier de macros partagé.
Des macros pour une notation cohérente
Chaque article contient une notation qui revient : les nombres réels, un opérateur d’espérance, une valeur absolue aux barres bien dimensionnées. Si vous tapez \mathbb{R} à quarante endroits et que votre encadrant préfère ensuite \mathbf{R}, vous avez quarante modifications à faire et vous en oublierez une. Une macro transforme cette notation en une seule commande nommée, définie une fois. Changez la définition et tout le document suit. C’est ainsi que vous gardez la notation cohérente : la source ne peut pas se désynchroniser d’elle-même.
Définir des commandes avec newcommand
\newcommand{\R}{\mathbb{R}}\newcommand{\E}[1]{\mathbb{E}\left[#1\right]}\newcommand{\abs}[1]{\left\lvert #1 \right\rvert}La première définition est la plus simple : \R est désormais un simple raccourci, et taper \R n’importe où produit \mathbb{R}.
La deuxième forme prend un argument. Le [1] après le nom déclare que \E accepte un argument, et #1 marque l’endroit où cet argument se place dans le développement. Ainsi, \E{X} devient \mathbb{E}\left[X\right]. La définition apporte plus que de la concision : la paire \left[ et \right] fait grandir les crochets pour qu’ils s’adaptent à leur contenu, de sorte que \E{\frac{X}{n}} obtient automatiquement de grands crochets. La macro \abs fait de même avec \lvert et \rvert, la bonne paire de barres verticales pour la valeur absolue. Vous pouvez déclarer jusqu’à neuf arguments et les désigner par #1 jusqu’à #9.
Si une commande existe déjà, \newcommand refuse de la redéfinir et s’arrête avec une erreur, ce qui vous évite de casser quelque chose sans le savoir. Pour remplacer volontairement une commande existante, utilisez plutôt \renewcommand.
L’interface moderne
Le LaTeX actuel fournit aussi une commande de définition plus riche :
\NewDocumentCommand{\citepair}{mm}{\cite{#1}, \cite{#2}}\NewDocumentCommand utilise une chaîne de spécification des arguments plutôt qu’un nombre. Ici, mm signifie deux arguments obligatoires, de sorte que \citepair{knuth84}{lamport94} cite les deux clés. Ce langage de spécification va plus loin que \newcommand : o déclare un argument facultatif entre crochets, s détecte une variante avec étoile, et O{default} donne une valeur par défaut à un argument facultatif. Dès que vous dépassez la simple substitution, adoptez cette interface.
Partager les définitions
Gardez un fichier macros.sty partagé entre les chapitres. Placez vos définitions dans ce seul fichier, chargez-le avec \usepackage{macros} depuis chaque document, et tous les chapitres d’une thèse, ainsi que les diapositives et la version article, s’accordent sur la notation. Quand un collaborateur arrive, il lit un seul court fichier pour apprendre vos conventions au lieu de les reconstituer à partir du texte. Cela s’associe naturellement à une organisation en plusieurs fichiers.
Un conseil sur les noms : donnez aux macros des noms parlants comme \abs ou \norm plutôt que des noms fondés sur l’apparence comme \bigbars. Le nom doit dire ce que la notation signifie, afin que la définition reste libre de changer son aspect. Et résistez à l’envie de définir une macro pour quelque chose que vous n’utilisez que deux fois ; le gain commence autour de la troisième utilisation.