Das cleveref Paket (Version 0.19 von 2013) ist ein Paket um in LATEX clever Verweise zu setzen. Und das Paket hält auch das was der Name verspricht. Durch die Verwendung des cleveref Paketes ist der Umgang mit Verweisen deutlich einfacher geworden. Das Paket selbst unterstützt eine Vielzahl von Sprachen, unter anderem Deutsch, Dänisch, Englisch, Französisch, Italienisch,Niederländisch, Norwegisch, Russisch, Spanisch und Ukrainisch.
Zwar bietet LATEX bereits von Haus aus drei Befehle an mit denen der Nutzer Markierungen setzen und darauf verweisen kann, aber die Ausgabe dieser Standardbefehle ist sehr begrenzt.
label Mit dem label Befehl wird eine Verweisstelle im LATEX Code in der folgenden Form markiert: \label{Markierung}ref Mit dem ref Befehl kann auf die von label gesetzte Markierung verwiesen werden: \ref{Markierung} Danach erscheint im Dokument an der Stelle wo der ref Befehl gesetzt wurde die Gliederungsnummer von der Stelle wo der label Befehl gesetzt wurde.
pageref Der pageref Befehl unterscheidet sich vom ref Befehl nur in so weit als das er anstelle der Gliederungsnummer die Seitenzahl beziehungsweise in der beamer class die Foliennummer ausgibt. \pageref{Markierung}Nachteil
Ein entscheidender Nachteil ist dabei, dass sowohl die Ausgabe der Gliederungsnummer als auch die Seitenzahl in Form einer nackten Nummer erfolgt. Das führt dazu, dass der Anwender regelmäßig Ergänzungen der Form S. beziehungsweise Seite beim pageref Befehl einfügen muss. Bei den Gliederungsnummer dann dortigen Entsprechungen. Dieser Nachteil wird von cleveref behoben.
1.1 Einbinden des Paketes
Beim Einbinden des Paketes ist zum einen darauf zu achten, dass es als letztes Paket eingebunden wird. Und zum anderen, dass die gewünschte Sprache in Form einer Dokumentklassenoption übergeben wird.
sort&compress Die Option sort&sompress wird standardmäßig gesetzt. Dabei werden die Verweislisten sortiert und zusammenhängende Verweise zu einem Verweisbereich zusammengefasst.
sort Die Option sort sortiert nur die Verweislisten. Eine Zusammenfassung von Verweisen findet nicht statt.
compress Mit der Option compress gibt es zwar Zusammenfassung der Verweise aber keine Sortierung.
nosort Wird die Option nosort gesetzt erfolgt weder eine Sortierung noch ein Zusammefassen der Verweise
poorman Die Option poorman erzeugt ein sed Skript, dass die Änderungen des Paketes cleveref wieder aufhebt. Im Fall, dass der hyperref Paket verwendet und die Hyperlinks verändert wurden, gehen diese Anpassungen verloren. Die Nutzung der Option poorman ist dann sinnvoll, wenn man ein LATEX Dokument erstellen will das ohne die neuen Befehle und Anpassungen von cleveref funktioniert, das heißt ohne das Paket cleveref auskommt. Das sed Skript wird dabei wie folgt aufgerufen und erzeugt die Datei NeuerName.tex:
sed -f Name.sed Name.tex > NeuerName.tex
capitalise Die Option capitalise sorgt für erzwungene Großschreibung der Begriffe für die Objekte auf die verwiesen wird. Die Option hat für den deutschen Sprachraum keine Bedeutung.
nameinlink Die Option nameinlink sorgt dafür, dass wenn zusätzlich das hyperref Paket verwendet wird, dass der Name in den Link eingefügt wird. Aus optischen Gründen rät der Paketeautor von der Nutzung der Option ab.
noabbrev Die Option noabbrev sorgt dafür das die Langform eines Objekts verwendet wird und nicht die Abkürzung. Zum Beispiel Abbildung anstelle von Abb..
2 Befehle
Als Hinweis vorab, der komplette Inhalt der Beispielausgabe wurde durch das Paket cleveref erzeugt. Die Markierungen werden mit dem bekannten label Befehl gesetzt.
Befehl
Ausgabe
Beispielausgabe
\cref{Label}
Objekt/Art und Nummer/Wert
Abschnitt 1
\crefrange{Label1}{Label2}
Objekt/Art von bis
Abschnitte 1 bis 2
\cpageref{Label}
Seitenzahl mit dem Wort Seite
Seite 2
\cpagerefrange{Label1}{Label2}
Seitenbereich
Seiten 2 bis 3
\namecref{Label}
Objekt/Art
Abschnitt
\labelcref{Label}
Nummer/Wert
1
\labelcpageref{Label}
Nur die Seitenzahl
2
Für den Fall, dass das hyperref Paket verwendet wird, und keine Verlinkung zwischen Verweis und Markierung wünscht kann man die folgenden Befehle verwenden.
Befehl
Ausgabe
Beispielausgabe
\cref*{Label}
Objekt/Art und Nummer/Wert
Abschnitt 1
\crefrange*{Label1}{Label2}
Objekt/Art von bis
Abschnitte 1 bis 2
\cpageref*{Label}
Seitenzahl mit dem Wort Seite
Seite 2
\cpagerefrange*{Label1}{Label2}
Seitenbereich
Seiten 2 bis 3
\labelcref*{Label}
Nummer/Wert
1
\labelcpageref*{Label}
Nur die Seitenzahl
2
2.1 Objekt/Art
Es werden über 30 verschiedene Objekte unterstützt.
Objekt
Ausgabe singular
Ausgabe plural
equation
Gleichung
Gleichungen
figure
Abbildung
Abbildungen
subfigure
Abbildung
Abbildungen
table
Tabelle
Tabellen
subtable
Tabelle
Tabellen
page
Seite
Seiten
part
Teil
Teile
chapter
Kapitel
Kapitel
section
Abschnitt
Abschnitte
subsection
Abschnitt
Abschnitte
subsubsection
Abschnitt
Abschnitte
appendix
Anhang
Anhänge
subappendix
Anhang
Anhänge
subsubappendix
Anhang
Anhänge
subsubsubappendix
Anhang
Anhänge
enumi
Punkt
Punkte
enumii
Punkt
Punkte
enumiii
Punkt
Punkte
enumiv
Punkt
Punkte
enumv
Punkt
Punkte
footnote
Fußnote
Fußnoten
theorem
Theorem
Theoreme
lemma
Lemma
Lemmata
corollary
Korollar
Korollare
proposition
Satz
Sätze
definition
Definition
Definitionen
result
Ergebnis
Ergebnisse
example
Beispiel
Beispiele
remark
Bemerkung
Bemerkungen
note
Anmerkung
Anmerkungen
algorithm
Algorithmus
Algorithmen
listing
Listing
Listings
line
Zeile
Zeilen
Will man die Ausgabe ändern erfolgt dies am besten direkt hinter dem eingebunden Paket und erfolgt nach diesem Schema:
Im nachfolgenden Beispiel wurde die Ausgabe für die Unterabschnitte geändert.
\documentclass[ngerman]{article}
\usepackage{babel}
...
\usepackage{cleveref}
\crefname{subsection}{Unterabschnitt}{Unterabschnitte}
\Crefname{subsection}{Unterabschnitt}{Unterabschnitte}
\begin{document}
...
\subsection{Unterabschnitt}\label{subsec:firstsubsection}
TEXT ... TEXT ...
\newpage
Wie bereits in \cref{subsec:firstsubsection} erläutert wurde ...
...
\end{document}
2.2 Sortieren und Zusammenfassen
Standardmäßig fasst das Paket, im Fall das auf mehrere Verweisquellen referenziert wird, die jeweiligen gleichen Objekte zusammen (compress) und sortiert diese in der Form Objekt-Ausgabe niedrigste Wert bis höchster Wert zum Beispiel Abschnitte 1 bis 2 (sort).
Die nachfolgende Tabelle gibt ein Beispiel für die verschieden Ausgabenvarianten in Abhängigkeit der gesetzten Option.
Achtung: Hinter dem Komma sollten keine Leerzeichen stehen.
3 showkeys
Das Paket showkeys erleichtert das Auffinden der gesetzten Label deutlich, da es diese im fertig kompilierten Dokument anzeigt. Wenn es nicht mehr benötigt, wird das Paket showkeys einfach auskommentiert.
File translated from
TEX
by
TTH,
version 3.82. On 19 Jul 2016, 14:26.
Wir verwenden Cookies. Wenn Sie weiter auf unseren Seiten surfen, stimmen Sie der Nutzung von Cookies zu. mehr Informationen hier