Das verbatim-Paket: Darstellung von Code und Text ohne Formatierung
Was macht das verbatim-Paket?
Das verbatim-Paket ermöglicht die wörtliche Darstellung von Text
und Quellcode, ohne dass LaTeX Befehle interpretiert werden.
Besonders hilfreich ist es, wenn:
- LaTeX-Befehle nicht interpretiert werden sollen,
- Einrückungen und Leerzeichen genau wie im Original angezeigt werden müssen,
- Externe Textdateien eingebunden werden sollen,
- Mehrzeilige Kommentare im LaTeX-Quelltext eingefügt werden sollen.
Das Paket bietet folgende Funktionen:
verbatim- undverbatim*-Umgebung – Darstellung von Quelltext im Dokument.comment-Umgebung – Ausblenden von Code-Blöcken.\verbatiminput{}und\verbatiminput*{}– Einfügen externer Dateien.
Video
Folien
Beschreibung
Einbinden des Pakets
Das Paket wird mit folgendem Befehl geladen:
\usepackage{verbatim}
Es benötigt keine weiteren Optionen.
1. Die verbatim- und verbatim*-Umgebung
Diese Umgebungen ermöglichen die direkte Darstellung von Code, ohne dass LaTeX ihn interpretiert.
| Umgebung | Beschreibung |
|---|---|
verbatim |
Zeigt den Quelltext unverändert an. Leerzeichen, Einrückungen und Zeilenumbrüche bleiben erhalten. |
verbatim* |
Funktioniert wie verbatim, zeigt jedoch zusätzlich Leerzeichen
sichtbar an. |
Beispiel:
\begin{verbatim}
Dies ist ein Beispiel für verbatim.
LaTeX-Befehle wie \textbf{fett} werden nicht interpretiert.
\end{verbatim}
Ausgabe:
Dies ist ein Beispiel für verbatim.
LaTeX-Befehle wie \textbf{fett} werden nicht interpretiert.
Mit verbatim* werden zusätzlich Leerzeichen sichtbar dargestellt:
\begin{verbatim*}
Dieser Satz ist eingerückt.
\end{verbatim*}
Ausgabe:
Dieser Satz ist eingerückt.
Hinweis: Eine verbatim-Umgebung kann nicht direkt in eine andere verbatim-Umgebung geschrieben werden.
2. Die comment-Umgebung
Mit der comment-Umgebung können große Code-Blöcke auskommentiert werden.
Alles innerhalb dieser Umgebung wird nicht im fertigen Dokument angezeigt.
Beispiel:
\begin{comment}
Dieser Abschnitt wird nicht angezeigt.
\end{comment}
Das ist besonders nützlich, um vorübergehend Text oder Code auszublenden, ohne % in jeder Zeile zu setzen.
3. Die Befehle \verbatiminput{} und \verbatiminput*{}
Diese Befehle ermöglichen das Einbinden externer Textdateien.
Der Inhalt wird genauso dargestellt, wie er in der Datei steht.
| Befehl | Bedeutung |
|---|---|
\verbatiminput{datei.txt} |
Fügt den Inhalt der Datei unverändert in das Dokument ein. |
\verbatiminput*{datei.txt} |
Fügt den Inhalt der Datei unverändert ein und zeigt zusätzlich Leerzeichen sichtbar an. |
Beispiel:
\verbatiminput{code.txt}
Falls code.txt folgendes enthält:
print("Hello, World!")
wird genau dieser Code ins Dokument eingefügt.
Beispiele & Anwendungen
Beispiel 1: Grundlegende Verwendung der verbatim-Umgebung
\documentclass{article}
\usepackage{verbatim}
\begin{document}
\section*{Verbatim-Ausgabe in LaTeX}
\begin{verbatim}
Dies ist ein Beispiel für die verbatim-Umgebung.
LaTeX-Befehle werden hier nicht interpretiert.
\end{verbatim}
\end{document}
Erklärung:
- Der Text wird ohne Formatierung dargestellt.
- LaTeX-Befehle wie
\textbf{}werden nicht ausgeführt.
Beispiel 2: Vergleich zwischen verbatim und verbatim*
\documentclass{article}
\usepackage{verbatim}
\begin{document}
\section*{Vergleich zwischen verbatim und verbatim*}
% Standard-verbatim: gibt den Text wörtlich wieder; Leerzeichen und Einrückungen bleiben erhalten.
\begin{verbatim}
Dieser Text ist eingerückt.
\end{verbatim}
% Verbatim*: wie verbatim, aber Leerzeichen werden zusätzlich sichtbar dargestellt.
\begin{verbatim*}
Dieser Text ist eingerückt.
\end{verbatim*}
\end{document}
Die anschauliche Variante:
\documentclass{article}
\usepackage{verbatim}
\begin{document}
\begin{verbatim}
a b
a b
a b
\end{verbatim}
\begin{verbatim*}
a b
a b
a b
\end{verbatim*}
\end{document}
Erklärung:
- Bei
verbatimbleiben Einrückungen erhalten, Leerzeichen werden jedoch nicht sichtbar markiert. - Bei
verbatim*bleibt die Einrückung ebenfalls erhalten, zusätzlich werden Leerzeichen sichtbar dargestellt.
Beispiel 3: Verwenden der comment-Umgebung
\documentclass{article}
\usepackage{verbatim}
\begin{document}
\section*{Verwendung der comment-Umgebung}
\begin{comment}
Dieser Abschnitt wird nicht angezeigt.
Er kann für Notizen oder vorübergehende Änderungen genutzt werden.
\end{comment}
\end{document}
Erklärung:
- Alles innerhalb der
comment-Umgebung wird nicht im fertigen PDF angezeigt. - Ideal für umfangreiche Notizen oder temporäre Änderungen.
Beispiel 4: Einfügen externer Dateien
Erstelle zuerst eine Datei code.txt mit folgendem Inhalt:
print("Hallo Welt!")
Dann binde sie in LaTeX ein:
\documentclass{article}
\usepackage{verbatim}
\begin{document}
\section*{Einfügen externer Dateien}
\verbatiminput{code.txt}
\end{document}
Erklärung:
\verbatiminput{code.txt}zeigt den Inhalt der Datei genau so, wie er ist.
Hinweis
Die verbatim-Umgebung darf nicht innerhalb vieler
anderer Befehle verwendet werden, etwa in Argumenten von \section{...}
oder \caption{...}.
Aufgaben & Übungen
Aufgabe 1: Grundlegende Verwendung der verbatim-Umgebung
Erstelle ein LaTeX-Dokument, das folgende Anforderungen erfüllt:
- Schreibe einen Abschnitt mit der Überschrift „Verbatim-Ausgabe in LaTeX“.
- Verwende die
verbatim-Umgebung, um den folgenden LaTeX-Code unformatiert darzustellen:\documentclass{article} \begin{document} Dies ist ein Beispiel für die verbatim-Umgebung. \end{document} - Füge einen Kommentar ein (
%), der den Zweck derverbatim-Umgebung beschreibt.
Aufgabe 2: Vergleich zwischen verbatim und verbatim*
- Erweitere dein Dokument aus Aufgabe 1, indem du einen Satz mit Einrückungen am Zeilenanfang schreibst.
- Verwende die
verbatim- und dieverbatim*-Umgebung, um zu demonstrieren, wie sich beide Versionen in der Darstellung unterscheiden. - Kommentiere den Unterschied.
Aufgabe 3: Verwenden der comment-Umgebung
- Schreibe einen kurzen Absatz mit einer Beschreibung des
verbatim-Pakets. - Blende den Absatz mit der
comment-Umgebung aus. - Notiere in einem Kommentar (
%), warum diese Umgebung nützlich ist.
Hausaufgaben
Hausaufgabe 1 (Theoretisch): Vergleich zwischen verbatim und anderen LaTeX-Umgebungen
Erstelle eine schriftliche Zusammenfassung (ca. 300 Wörter), die folgende Fragen beantwortet:
- Wofür wird die
verbatim-Umgebung verwendet? - Was sind die Unterschiede zwischen
verbatim,verbatim*undlstlisting(aus demlistings-Paket)? - In welchen Situationen ist
verbatimbesser geeignet alslstlisting?
Hausaufgabe 2 (Praktisch): Einfügen von externen Dateien mit \verbatiminput{}
- Erstelle eine Textdatei (
beispiel.txt), die einen einfachen LaTeX-Code enthält. - Verwende
\verbatiminput{beispiel.txt}, um diese Datei in dein LaTeX-Dokument einzufügen. - Teste zusätzlich die Variante
\verbatiminput*{beispiel.txt}und vergleiche die Unterschiede.