Makros, die die Notation ehrlich halten

newcommand, NewDocumentCommand, eine gemeinsame Makrodatei.

Makros, die die Notation ehrlich halten

Jedes Paper hat Notation, die sich wiederholt: die reellen Zahlen, ein Erwartungswertoperator, ein Betrag mit passend großen Strichen. Wenn Sie \mathbb{R} an vierzig Stellen tippen und Ihre Betreuerin oder Ihr Betreuer später \mathbf{R} vorzieht, haben Sie vierzig Änderungen vorzunehmen, und eine werden Sie übersehen. Ein Makro macht aus dieser Notation einen einzigen benannten Befehl, der einmal definiert wird. Ändern Sie die Definition, folgt das ganze Dokument. So halten Sie die Notation ehrlich: Der Quelltext kann nicht mit sich selbst aus dem Takt geraten.

Befehle mit newcommand definieren

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

Die erste Definition ist die einfachste Art: \R ist jetzt reine Abkürzung, und \R an beliebiger Stelle ergibt \mathbb{R}.

Die zweite Form nimmt ein Argument. Das [1] nach dem Namen legt fest, dass \E ein Argument akzeptiert, und #1 markiert, wo dieses Argument in der Expansion landet. So wird \E{X} zu \mathbb{E}\left[X\right]. Die Definition bringt mehr als Kürze: Das Paar \left[ und \right] lässt die Klammern mit ihrem Inhalt wachsen, sodass \E{\frac{X}{n}} automatisch hohe Klammern bekommt. Das Makro \abs tut dasselbe mit \lvert und \rvert, dem richtigen Paar senkrechter Striche für den Betrag. Sie können bis zu neun Argumente deklarieren und sie als #1 bis #9 ansprechen.

Existiert ein Befehl bereits, weigert sich \newcommand, ihn neu zu definieren, und bricht mit einem Fehler ab. Das schützt Sie davor, unbemerkt etwas kaputt zu machen. Um einen bestehenden Befehl bewusst zu ersetzen, verwenden Sie stattdessen \renewcommand.

Die moderne Schnittstelle

Aktuelles LaTeX bringt außerdem einen leistungsfähigeren Definitionsbefehl mit:

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

\NewDocumentCommand verwendet statt einer Anzahl eine Zeichenkette zur Spezifikation der Argumente. Hier bedeutet mm zwei obligatorische Argumente, sodass \citepair{knuth84}{lamport94} beide Schlüssel zitiert. Die Spezifikationssprache reicht weiter als \newcommand: o deklariert ein optionales Argument in eckigen Klammern, s erkennt eine Sternvariante, und O{default} gibt einem optionalen Argument einen Standardwert. Greifen Sie für alles, was über einfaches Ersetzen hinausgeht, zu dieser Schnittstelle.

Definitionen gemeinsam nutzen

Führen Sie eine macros.sty, die alle Kapitel gemeinsam nutzen. Legen Sie Ihre Definitionen in diese eine Datei, laden Sie sie in jedem Dokument mit \usepackage{macros}, und jedes Kapitel einer Abschlussarbeit, dazu die Folien und die Paper-Fassung, stimmen in der Notation überein. Wer neu zum Projekt stößt, liest eine kurze Datei, um Ihre Konventionen kennenzulernen, statt sie aus dem Text zu rekonstruieren. Das passt gut zu einem Setup mit mehreren Dateien.

Ein Tipp zur Benennung: Geben Sie Makros sinnvolle Namen wie \abs oder \norm statt am Erscheinungsbild orientierter Namen wie \bigbars. Der Name soll sagen, was die Notation bedeutet, damit die Definition frei ändern kann, wie sie aussieht. Und widerstehen Sie dem Drang, ein Makro für etwas zu definieren, das Sie zweimal verwenden; der Nutzen beginnt etwa bei der dritten Verwendung.

Zurück zu Laufzeit