LaTeX fancyref

1 fancyref

Das fancyref Paket (Version v0.9c 1999/02/03) wurde gemacht um die Darstellung und Umsetzung von Verweisen innerhalb von LaTeX Dokumenten zu verbessern.[1] Dies geschieht dadurch, dass sowohl dem label wie auch dem ref zusätzliche Informationen übergeben werden, anhand derer eine Zuordnung des Verweises zu einem bestimmten Objekt aus LaTeX erfolgen kann. Eine moderne Weiterentwicklung stellt das Paket cleveref dar. Bei diesem erkennt das Paket selbst aber das Objekt, sodass keine zusätzlichen Informationen seitens des Nutzer bereit gestellt werden müssen.

1.1 Einbinden des Paketes

Das Paket wird mit \usepackage{fancyref} eingebunden. Es bindet seinerseits das Paket varioref ein.

1.2 Optionen

Das Paket fancyref verfügt über acht Optionen, die sich in die Bereich Sprache, Abstand und Formatierung der Ausgabe unterschieden lassen.

Sprache Die wichtigste Option ist die Einstellung der Sprache, hierbei kann zwischen german (deutsch) und english (englisch) gewählt werden. Wobei english der Defaultwert ist.
Abstand Der Abstand zwischen Bezeichnung und Nummer kann über die Optionen loose (locker, ein normales Leerzeichen) oder tight (eng) festgelegt werden. Die Option loose ist der Defaultwert.
Formatierung Über die Optionen plain (einfache Wiedergabe von Bezeichner und Nummer) und vario (Ausgabe wie beim varioref Paket) kann die Formatierung der Ausgabe beeinflusst werden. Der Defaultwert ist hier vario.
Mehr Darüber hinaus gibt es noch die Option margin die die Verweise in den Seitenrand setzt und die Option paren die die Verweise geklammert ausgibt. Dabei ist aber zu beachten, dass die zwei letztgenannten Optionen nicht miteinander kombinierbar sind. Es erfolgt zwar keine Fehlermeldung, aber der Verweis wird nur geklammert im Fließtext gesetzt und nicht geklammert im Seitenrand.

Standardmäßig gesetzt werden die Optionen english, loose und vario.

2 Befehle

Der label aus dem Standard ist erhalten geblieben, es hat sich lediglich der Aufbau der Markierung selbst geändert. Für den ref Befehl gibt es nun zwei neue Varianten. Zum einen \fref{Markierung} für Verweise im Satz und \Fref{Markierung} für Verweise am Satzanfang. Der Grund dafür ist, das es in der englischen Sprache einen Unterschied macht, ob der Bezeichner am Satzanfang oder im Satz steht (Groß- Kleinschreibung). Da es in der deutschen Sprache diesen Unterschied für die verwendeten Begriffe nicht gibt, gibt es wenn die Option german gesetzt wurde, keinen Unterschied zwischen der Ausgabe von fref und Fref.
Im Gegensatz zu den Standardbefehlen label und ref enthalten die neuen Varianten eine zusätzliche Information (Präfixe) über das Objekt hinter dem sie gesetzt wurden. Die Auswahl der Präfixe erfolgt per Hand.

Standardpräfixe in fancyref
Objekt	Präfix	Ausgabe (german)
chapter	chap	Kapitel
section	sec	Abschnitt
equation	eq	Gleichung
figure	fig	Abbildung
table	tab	Tabelle
enumeration	enum	Punkt
footnote	fn	Fußnote

2.1 Aufbau der Befehle

Die Befehle label, fref und Fref folgt diesem Schema:

\Befehl{Präfix|Trenner|Markierung}

Beispiel

\label{sec:eins}
\fref{sec:eins} oder \Fref{sec:eins}

2.2 Neue eigene Präfixe für fancyref definieren

1. Schritt Präfix festlegen hier abc:

\newcommand*{\fancyrefabclabelprefix}{abc}

2. Schritt Bezeichner / Objekt festlegen hier ABC beziehungsweise abc:

\newcommand*{\Frefabcname}{ABC}
\newcommand*{\frefabcname}{abc}

3. Schritt Ausgabe formatieren für plain und vario:

\frefformat{plain}{\fancyrefabclabelprefix}{\frefabcname\fancyrefdefaultspacing#1#3}
\Frefformat{plain}{\fancyrefabclabelprefix}{\Frefabcname\fancyrefdefaultspacing#1#3}

\frefformat{vario}{\fancyrefabclabelprefix}{\frefabcname\fancyrefdefaultspacing#1#3}
\Frefformat{vario}{\fancyrefabclabelprefix}{\Frefabcname\fancyrefdefaultspacing#1#3}

4. Schritt verwenden:

\label{abc:test} 
\fref{abc:test} oder \Fref{abc:test}

3 Nachteil

Durch die fixe Zuordnung zu bestimmten Objekttypen ist eine Änderung im Nachhinein nur manuell möglich. Dies mag bei einer Tabelle oder einer Abbildung nur ein theoretisches Problem sein, aber bei den Gliederungsbefehlen kann es aber durchaus vorkommen, dass sich im Laufe der Erstellung eines Dokumentes sich die entsprechende Einteilung ändern kann, und aus einem Abschnitt doch ein Kapitel wird oder umgekehrt.

Literatur

[1] Axel Reichert, Fancy Cross-referencing, 1999-02-03, http://mirrors.ctan.org/macros/latex/contrib/fancyref/fancyref.pdf