Das changes-Paket


Manuelle Änderungsmarkierung
Ekkart Kleinod  • 

Überblick

Das changes-Paket dient zur manuellen Markierung von geändertem Text, insbesondere Einfügungen, Löschungen und Ersetzungen. Der geänderte Text wird farbig markiert und, bei gelöschtem Text, durchgestrichen. Zusätzlich kann Text hervorgehoben und/oder kommentiert werden. Das Paket ermöglicht die freie Definition von Autoren und deren zugeordneten Farben. Es erlaubt zusätzlich die Änderung des Änderungs-, Autor-, Hervorhebungs- und Kommentarmarkups.

Beispiel für Änderungsmarkierung. Das Paket ist ein offizielles LaTeX-Paket, also auch über CTAN verfügbar und in den üblichen Distributionen enthalten.

Markup

Das Paket stellt fünf Befehle für Änderungsmarkup und einen zur Ausgabe der Änderungsliste bereit:

\added[id=<ID>, comment=<Kommentar>]{neuer Text}
\deleted[id=<ID>, comment=<Kommentar>]{gelöschter Text}
\replaced[id=<ID>, comment=<Kommentar>]{neuer Text}{gelöschter Text}
\highlight[id=<ID>, comment=<comment>]{hervorgehobener Text}
\comment[id=<ID>]{Kommentar}
\listofchanges[style=<Stil>, title=<Titel>, show=<Typ>]

Darüber hinaus gibt es Paketoptionen, Befehle zur Anpassung des Aussehens der Markierungen, zur Definition von Autoren etc. Diese sind ausführlich im Benutzerhandbuch beschrieben.

Neuer Text

Neuer Text wird mit added gekennzeichnet:

\added[id=<ID>, comment=<Kommentar>]{neuer Text}

Beispiele:

Das ist \added{neuer} Text.
Das ist \added[comment=vergessen]{neuer} Text.
Das ist \added[id=EK]{neuer} Text.
Das ist \added[id=EK, comment={muss rein}]{neuer} Text.

Gelöschter Text

Gelöschter Text wird mit deleted gekennzeichnet:

\deleted[id=<ID>, comment=<Kommentar>]{gelöschter Text}

Beispiele:

Das ist \deleted{schlechter} Text.
Das ist \deleted[comment=obsolet]{schlechter} Text.
Das ist \deleted[id=EK]{schlechter} Text.
Das ist \deleted[id=EK, comment={Was habe ich da gedacht?}]{schlechter} Text.

Ersetzter Text

Ersetzter Text wird mit replaced gekennzeichnet:

\replaced[id=<ID>, comment=<Kommentar>]{neuer Text}{gelöschter Text}

Beispiele:

Das ist \replaced{neuer}{alter} Text.
Das ist \replaced[comment=ach]{neuer}{alter} Text.
Das ist \replaced[id=EK]{neuer}{alter} Text.
Das ist \replaced[id=EK, comment={klingt besser}]{neuer}{alter} Text.

Hervorgehobener Text

Hervorgehobener Text wird mit highlight gekennzeichnet:

\highlight[id=<ID>, comment=<Kommentar>]{hervorgehobener Text}

Beispiele:

Das ist ein \highlight{wichtiger} Punkt.
Das ist ein \highlight[comment=jawoll]{wichtiger} Punkt.
Das ist ein \highlight[id=EK]{wichtiger} Punkt.
Das ist ein \highlight[id=EK, comment={Weil es so ist!}]{wichtiger} Punkt.

Kommentare

Kommentare werden mit comment gekennzeichnet:

\comment[id=<ID>]{Kommentar}

Beispiele:

Das ist ein kommentierter\highlight{So!} Punkt.
Das ist ein kommentierter\highlight[id=EK]{Weil noch unklar.} Punkt.

Änderungsliste

Die Änderungsliste wird mit listofchanges ausgegeben:

\listofchanges[style=<Stil>, title=<Titel>, show=<Typ>]

Beispiele:

\listofchanges
\listofchanges[style=summary]
\listofchanges[title={Meine Änderungen}]
\listofchanges[show=highlight|comment, title={Kommentiert und markiert}]

Fehler, Wünsche, Verbesserungen

Wenn Sie sich beteiligen wollen, sei es durch Fehlermeldung, Diskussion, Featurewünsche oder Programmierhilfe, verwenden Sie eine der folgenden Möglichkeiten:

  1. per E-Mail (unten das E-Mail-Symbol)
  2. über ein Ticket
  3. direkt per Programmierung in gitlab als Pull-Request