Verzeichnisse acronym Paket

acronym Paket - Abkürzungsverzeichnis erstellen

Das acronym Paket in LaTeX ermöglicht die Verwaltung und einheitliche Darstellung von Abkürzungen in einem Dokument. Es erlaubt die Definition von Abkürzungen mit einer Lang- und Kurzform, sodass sie beim ersten Auftreten ausgeschrieben und anschließend nur in der Kurzform verwendet werden.

---

Video

---

Folien

Folien

---

Beschreibung

Was ist acronym und wofür wird es verwendet?

Das Paket acronym dient zur einfachen Erstellung eines Abkürzungsverzeichnisses in LaTeX-Dokumenten. Mit diesem Paket können Abkürzungen definiert, verwendet und automatisch in einem Verzeichnis gelistet werden. Zusätzlich können Pluralformen und spezielle Formatierungen umgesetzt werden.

Einbinden des Pakets

Das Paket wird mit folgendem Befehl in das LaTeX-Dokument eingebunden:

\usepackage{acronym}

Zusätzlich werden die Pakete suffix und xstring benötigt. Falls die Option smaller verwendet wird, muss auch relsize eingebunden sein.

Optionen des Pakets

Beim Laden von acronym können verschiedene Optionen gesetzt werden:

• footnote: Zeigt die Langform der Abkürzung beim ersten Auftreten als Fußnote an.
• nohyperlinks: Deaktiviert Verlinkungen, falls hyperref verwendet wird.
• printonlyused: Listet nur Abkürzungen im Verzeichnis, die im Dokument verwendet werden.
• withpage: Ergänzt die Seitenzahl, auf der die Abkürzung verwendet wurde (in Kombination mit printonlyused).
• smaller: Verkleinert die Darstellung der Abkürzungen.
• dua: Zeigt immer die Langform an, außer es werden explizit Kurzformbefehle genutzt.
• nolist: Verhindert die Erstellung eines Abkürzungsverzeichnisses.

Beispiel:

\usepackage[nohyperlinks, printonlyused, withpage, smaller]{acronym}

Definieren von Abkürzungen

Abkürzungen können entweder direkt mit Befehlen wie \newacro oder \acrodef oder innerhalb der acronym-Umgebung definiert werden:

\begin{acronym}[ECU]
\acro{ecu}[ECU]{European currency unit}
\acro{eu}[EU]{Europäische Union}
\end{acronym}

Die längste Kurzform (z. B. ECU) sollte als Option in eckigen Klammern gesetzt werden, um die Spaltenbreite des Verzeichnisses festzulegen.

Erstellen eines Abkürzungsverzeichnisses

Das Verzeichnis wird an der Stelle eingefügt, an der die acronym-Umgebung verwendet wird. Der Titel und die Aufnahme ins Inhaltsverzeichnis können manuell hinzugefügt werden:

\section*{Abkürzungsverzeichnis}
\addcontentsline{toc}{section}{Abkürzungsverzeichnis}

Befehle zur Darstellung von Abkürzungen

• \ac{Kuerzel}: Beim ersten Auftreten wird die Langform mit der Abkürzung in Klammern angezeigt. Danach erscheint nur die Abkürzung.
• \acf{Kuerzel}: Zeigt die Langform mit der Abkürzung in Klammern an, unabhängig davon, ob die Abkürzung bereits verwendet wurde.
• \acs{Kuerzel}: Gibt nur die Abkürzung aus.
• \acl{Kuerzel}: Gibt nur die Langform aus.
• \acp{Kuerzel}: Wie \ac{Kuerzel}, aber für die Pluralform.
• \acfp{Kuerzel}: Wie \acf{Kuerzel}, aber für die Pluralform.
• \acsp{Kuerzel}: Wie \acs{Kuerzel}, aber für die Pluralform.
• \aclp{Kuerzel}: Wie \acl{Kuerzel}, aber für die Pluralform.
• \acfi{Kuerzel}: Zeigt die Langform kursiv und die Abkürzung in Kapitälchen an.
• \iac{Kuerzel}: Fügt der Abkürzung (bzw. Langform mit Abkürzung) den unbestimmten englischen Artikel a hinzu.
• \Iac{Kuerzel}: Fügt der Abkürzung (bzw. Langform mit Abkürzung) den unbestimmten englischen Artikel A hinzu.

Zusätzliche Befehle

• \acresetall: Setzt den Status aller Abkürzungen zurück, sodass sie bei der nächsten Verwendung wie beim ersten Auftreten angezeigt werden.
• \acused{Kuerzel}: Markiert die Abkürzung als verwendet, ohne sie im Text auszugeben.
• \acsu{Kuerzel}: Zeigt die Abkürzung an und markiert sie als verwendet.
• \aclu{Kuerzel}: Zeigt die Langform an und markiert sie als verwendet.

Befehlsvarianten mit Stern (*)

Jeder der oben genannten Befehle hat eine Variante mit einem Stern (*). Diese Varianten haben die gleiche Funktion wie die normalen Befehle, markieren die Abkürzungen jedoch nicht als verwendet. Dies ist nützlich, wenn die Option printonlyused aktiv ist und bestimmte Abkürzungen nicht im Verzeichnis erscheinen sollen.

---

Beispiele & Anwendungen

Beispiel 1: Grundlegende Verwendung

Das folgende Beispiel zeigt, wie eine Abkürzung definiert und im Text verwendet wird:

\documentclass{article}
\usepackage[printonlyused]{acronym}

\begin{document}

\section*{Abkürzungsverzeichnis}
\begin{acronym}[ECU]
\acro{ecu}[ECU]{European currency unit}
\end{acronym}

Die \ac{ecu} ist eine bedeutende Währungseinheit. In weiteren Abschnitten wird die \acs{ecu} verwendet.

\end{document}

Erläuterung:

• \ac{ecu} zeigt beim ersten Auftreten die Langform und die Abkürzung: European currency unit (ECU).
• \acs{ecu} zeigt nur die Abkürzung: ECU.

Beispiel 2: Verwendung von Pluralformen

Das nächste Beispiel demonstriert die Definition und Verwendung von Pluralformen:

\documentclass{article}
\usepackage[printonlyused]{acronym}

\begin{document}

\section*{Abkürzungsverzeichnis}
\begin{acronym}[Dr.]
\acro{dr}[Dr.]{Doktor}
\acroplural{dr}[Dres.]{Doktoren}
\end{acronym}

Die \ac{dr} sind oft Experten in ihrem Fachgebiet. Besonders hervorzuheben sind die \acp{dr} mit Spezialisierung.

\end{document}

Erläuterung:

• \ac{dr} gibt die Singularform aus: Doktor (Dr.).
• \acp{dr} gibt die Pluralform aus: Doktoren (Dres.).

Beispiel 3: Kombination mit Optionen

In diesem Beispiel wird gezeigt, wie mehrere Optionen genutzt werden können:

\documentclass{article}
\usepackage[nohyperlinks, printonlyused, withpage, smaller]{acronym}

\begin{document}

\section*{Abkürzungsverzeichnis}
\addcontentsline{toc}{section}{Abkürzungsverzeichnis}
\begin{acronym}[ML]
\acro{ai}[AI]{Artificial Intelligence}
\acro{ml}[ML]{Machine Learning}
\end{acronym}

Die \ac{ai} ist ein Teilbereich von \ac{ml}.

\end{document}

Erläuterung:

• Die Option nohyperlinks deaktiviert Hyperlinks zu Abkürzungen.
• printonlyused listet nur genutzte Abkürzungen im Verzeichnis auf.
• withpage zeigt die Seitenzahlen an, auf denen die Abkürzungen verwendet wurden.

Beispiel 4: Übersicht über Befehle

Das folgende Beispiel demonstriert die Wirkung der verschiedenen Befehle:

\documentclass{article}
\usepackage{acronym}

\begin{document}

\section*{Abkürzungsverzeichnis}
\begin{acronym}[ECU]
\acro{ecu}[ECU]{European currency unit}
\end{acronym}

\ac{ecu} \\
\acf{ecu} \\
\acs{ecu} \\
\acl{ecu} \\
\acp{ecu} \\
\acfp{ecu} \\
\acsp{ecu} \\
\aclp{ecu} \\
\acfi{ecu} \\
\iac{ecu} \\
\Iac{ecu}

\end{document}

Erläuterung:

• Zeigt die verschiedenen Ausgabenformate (Singular, Plural, kursiv, Artikel, etc.) in der Praxis.

Zusätzliche Anwendungsfälle

• Langform in Fußnoten anzeigen: Mit der Option footnote wird die Langform als Fußnote eingefügt:

  \usepackage[footnote]{acronym}
  

• Verhindern von Verlinkungen: Die Option nohyperlinks deaktiviert Hyperlinks:

  \usepackage[nohyperlinks]{acronym}
  

---

Aufgaben & Übungen

Aufgabe 1: Einfache Abkürzungsliste erstellen

Erstelle ein LaTeX-Dokument mit einer Abkürzungsliste.

• Definiere drei Abkürzungen in der acronym-Umgebung.
• Die Abkürzungsliste soll mit der Überschrift „Abkürzungsverzeichnis“ erscheinen.
• Stelle sicher, dass die Liste im Inhaltsverzeichnis erscheint.
• Verwende eine der definierten Abkürzungen mindestens zweimal im Text.

Aufgabe 2: Abkürzungen mit Pluralformen verwenden

• Erweitere das Dokument aus Aufgabe 1, indem du für mindestens eine Abkürzung eine Pluralform definierst.
• Verwende die Abkürzung im Singular und im Plural an verschiedenen Stellen im Text.
• Nutze die Befehle \acp{} und \acsp{} für die Pluralformen.

Aufgabe 3: Verwendung von \newacro außerhalb der acronym-Umgebung

• Definiere zwei weitere Abkürzungen mit \newacro{} außerhalb der acronym-Umgebung.
• Verwende eine dieser Abkürzungen mit \acf{} (Langform mit Kurzform) und eine andere mit \acs{} (nur Kurzform).

---

Hausaufgaben

Hausaufgabe 1 (Theoretisch): Vergleich acronym vs. acro

Erstelle eine schriftliche Zusammenfassung (ca. 300 Wörter), die folgende Fragen beantwortet:

1. Welche Hauptfunktionen bietet das acronym-Paket?
2. Wie unterscheidet sich acronym vom acro-Paket?
3. Welche Vorteile hat acronym für LaTeX-Anfänger?
4. In welchen Situationen wäre es sinnvoll, acro statt acronym zu verwenden?

Hausaufgabe 2 (Praktisch): Erweiterte Abkürzungsliste mit eigener Formatierung

• Erstelle eine Abkürzungsliste mit mindestens fünf Abkürzungen.
• Verwende die Option printonlyused, sodass nur verwendete Abkürzungen in der Liste erscheinen.
• Formatiere die Liste so, dass sie mit einer benutzerdefinierten Überschrift „Glossary“ erscheint.
• Füge die Liste ins Inhaltsverzeichnis ein.