Befehle
Pakete
Klassen
Strukturen
Fehlermeldungen
Das Paket xreview vereinfacht das Überarbeiten von LaTeX-Dokumenten, indem es Änderungen und Kommentare übersichtlich darstellt und später eine bereinigte Version des Dokuments ohne Hervorhebungen erstellt.[1] Dadurch ist es insbesondere für Arbeiten die einen mehrmaligen Überarbeitungsprozess durchlaufen, wie zum Beispiel Abschlussarbeiten und Manuskripte, ein nützliches Paket.
Das Paket wird mit folgendem Befehl geladen:
\usepackage{xreview}
Es gibt zwei Hauptmodi:
\showchanges zeigt Änderungen und Kommentare an.\showclean erstellt eine bereinigte Version ohne Änderungen und Kommentare.Die grundlegenden Befehle von xreview helfen, Hinzufügungen, Löschungen und Änderungen im Text deutlich zu machen. Es gibt drei Hauptbefehle:
\removed{...}: Text wird durchgestrichen dargestellt, um zu zeigen, dass er entfernt wurde.\added{...}: Der hinzugefügte Text wird farbig (standardmäßig blau) angezeigt.\changed{alt}{neu}: Der alte Text wird durchgestrichen und in einer anderen Farbe angezeigt, während der neue Text als Ersatz eingefügt wird.Beispiel:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\begin{document}
\showchanges
\textit{xreview} ist ein \removed{tolles} Paket, um \added{\LaTeX} Dokumente zu überarbeiten und \changed{nervige}{wertvolle} Änderungen hervorzuheben.
\end{document}
Erklärung:
\showchanges werden alle Änderungen im Dokument angezeigt.\removed{tolles} zeigt „tolles“ durchgestrichen und in Rot.\added{\LaTeX} zeigt „\LaTeX“ als neu eingefügten Text in Blau.\changed{nervige}{wertvolle} zeigt „nervige“ als durchgestrichenen Text und „wertvolle“ als neue Einfügung.Bereinigte Version:
Wenn Sie stattdessen \showclean verwenden, sehen Sie nur den sauberen Text:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\begin{document}
\showclean
\textit{xreview} ist ein \removed{tolles} Paket, um \added{\LaTeX} Dokumente zu überarbeiten und \changed{nervige}{wertvolle} Änderungen hervorzuheben.
\end{document}
Das xreview-Paket bietet spezielle Umgebungen zum Entfernen und Hinzufügen von Gleichungen, was besonders für mathematische Dokumente nützlich ist.
remequation und remequation*: Diese Umgebungen markieren eine Gleichung als entfernt.
remequation* unterdrückt die Nummerierung der gelöschten Gleichung.remequation behält eine separate Nummerierung (z. B. mit einem "R"-Präfix), sodass die Gleichung referenziert werden kann.addequation und addequation*: Diese Umgebungen markieren eine Gleichung als hinzugefügt.
Beispiel:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\begin{document}
\showchanges
\begin{equation}
a + b = c
\end{equation}
\begin{remequation}
a + b = d
\end{remequation}
\begin{addequation}
b + c = d
\end{addequation}
\end{document}
Erklärung:
a + b = c wird normal angezeigt und bleibt im Text.remequation markiert a + b = d als entfernte Gleichung, mit separater Nummerierung, um sie bei Bedarf referenzieren zu können.addequation fügt b + c = d als neue Gleichung hinzu, die der normalen Nummerierung folgt.Bereinigte Version:
Mit \showclean wird nur die verbleibende und die neue Gleichung gezeigt, ohne Markierungen:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\begin{document}
\showclean
\begin{equation}
a + b = c
\end{equation}
\begin{remequation}
a + b = d
\end{remequation}
\begin{addequation}
b + c = d
\end{addequation}
\end{document}
Kommentare sind hilfreich, um Notizen und Anmerkungen für andere Bearbeiter oder für sich selbst hinzuzufügen. xreview bietet hierfür verschiedene Befehle:
\comment{text}{Kommentar}: Fügt einen Kommentar zum Text hinzu, der in der bereinigten Version ausgeblendet wird.\resolvedcomment{Kommentar}{Antwort}: Markiert einen Kommentar als „gelöst“, was ihn in einer beruhigenden Farbe (standardmäßig grün) darstellt.\authoredcomments: Mit diesem Befehl können Sie personalisierte Kommentarbefehle erstellen, zum Beispiel \Alicecomment.Beispiel:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\begin{document}
\showchanges
\comment{Dies ist ein Abschnitt}{Überprüfen Sie die Formulierung.}
\resolvedcomment{Dieser Punkt wurde geklärt.}{Einverstanden.}
\authoredcomments[color=cyan]{Alice}
\Alicecomment{Gute Änderung}{Alice stimmt zu.}
\end{document}
Erklärung:
\comment{Dies ist ein Abschnitt}{Überprüfen Sie die Formulierung.} markiert den Text „Dies ist ein Abschnitt“ und fügt den Kommentar „Überprüfen Sie die Formulierung“ hinzu, der im \showclean-Modus nicht erscheint.\resolvedcomment fügt einen Kommentar mit der Kennzeichnung „gelöst“ hinzu.\authoredcomments definiert \Alicecomment, wodurch ein personalisierter Kommentar erstellt wird. Die Kommentare können farblich angepasst werden.xreview bietet die Möglichkeit, das Aussehen der Änderungen anzupassen, zum Beispiel die Farben und die Präfixe von Kommentaren:
\renewcommand{\addedcolor}{green}
\renewcommand{\removedcolor}{purple}
\renewcommand{\commentprefix}{Note}
Erklärung:
\addedcolor und \removedcolor ändern die Farben für Hinzufügungen (hier auf Grün) und Löschungen (hier auf Violett).\commentprefix ändert das Präfix von Kommentaren (standardmäßig „C“).Hier ist ein Beispiel, das alle obigen Funktionen kombiniert und zeigt, wie xreview verwendet werden kann, um Änderungen und Kommentare zu verwalten:
\documentclass[ngerman]{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{xreview}
\renewcommand{\addedcolor}{green}
\renewcommand{\removedcolor}{purple}
\renewcommand{\commentprefix}{Note}
\begin{document}
\showchanges
\textit{xreview} ist ein \removed{tolles} Paket, um \added{\LaTeX} Dokumente zu überarbeiten und \changed{nervige}{wertvolle} Änderungen hervorzuheben.
\comment{Dieser Satz}{Überprüfen Sie die Formulierung.}
\resolvedcomment{Dieser Punkt wurde geklärt.}{Einverstanden.}
\authoredcomments[color=cyan]{Alice}
\Alicecomment{Gute Änderung}{Alice stimmt zu.}
\begin{equation}
a + b = c
\end{equation}
\begin{remequation}
a + b = d
\end{remequation}
\begin{addequation}
b + c = d
\end{addequation}
\end{document}
Erklärung des gesamten Beispiels:
Ergebnis:
Dieses Beispiel zeigt, wie Änderungen, persönliche Kommentare und der Bearbeitungsbericht erstellt werden. Mit \showclean verschwindet der gesamte Änderungsverlauf, und der Text erscheint sauber.
Das xreview-Paket erleichtert die Überarbeitung und Kommentierung von LaTeX-Dokumenten durch eine klare Hervorhebung von Änderungen und die Möglichkeit, eine bereinigte Version ohne Bearbeitungsspuren zu erstellen.