Vorlage:FN/Doku
Diese Seite ist die Dokumentations-Unterseite der Vorlage:FN.
Zusammen mit Vorlage:FNZ können Anmerkungen eingefügt werden, etwa in Tabellen – unabhängig von der Technik der Einzelnachweise mit <ref>…</ref> und <references />.
Vorlagenparameter
| Parameter | Beschreibung | Typ | Status | |
|---|---|---|---|---|
| Zeichen | 1 | Anmerkungszeichen
| Einzeiliger Text | erforderlich |
| Gruppierung | gruppe | Gemeinsamer Code, um mehrere Fußnoten in Gruppen zusammenzufassen (siehe Abschnitt der Dokumentation)
| Einzeiliger Text | optional |
Verwendung
[Quelltext bearbeiten]Die Vorlagen FN und FNZ bieten gemeinsam die Möglichkeit, Anmerkungen völlig unabhängig von der Technik der Einzelnachweise/<ref>…</ref> und <references /> arbeitet) zu setzen. Anders als die von der MediaWiki-Software bereitgestellte Technik funktioniert das vorlagenbasierte System nicht automatisch. Das bedeutet, dass Autoren selbst für die richtige Zuordnung von Markierung und eigentlicher Fußnote sowie von Nummerierung und Gruppierung sorgen müssen, damit auch die interne Rückverlinkung ermöglicht wird.
Die Vorlage FN setzt nur die Markierung (den Bezeichner/
Zusätzlich kann mit der Vorlage FNBox ein unsichtbarer Kasten erzeugt werden, in den die FNZ-Anmerkungen gesetzt werden und der mit dem Fußnotenstrich, einer davor gesetzten kurzen Linie, und einer Einrückung aller Fußnoten eine visuelle Trennung zum vorhergehenden Inhalt bewirkt.
Die Vorlage FN erlaubt einen Sprung zur entsprechenden Einbindung von FNZ und diese einen Rücksprung, beide durch eine Verknüpfung über den Bezeichner. Wird derselbe Bezeichner mehrfach eingesetzt, so erfolgt der Rücksprung allerdings nur auf die erste Note. (x) Daher ist die Vorlage nicht für eine gemeinsame Anmerkung an mehreren Stellen geeignet, sofern diese nicht eng beisammen stehen.
Geeignet ist die Kombination der Vorlagen FN und FNZ
- für Tabellen mit Anmerkungen, um die Tabelle schlank zu halten und die Anmerkungen direkt unterhalb anzuordnen,
- in Infoboxen,
- für gemeinsame Anmerkungen zu mehreren Artikelelementen (Bildunterschrift und Tabelle)
und - für Ähnliches.
Syntax
[Quelltext bearbeiten]Vorlage:FN
[Quelltext bearbeiten]Diese Vorlage setzt nur die Markierung.
Beispiel FN:
Durch Angabe des optionalen Parameters gruppe ändert sich die Anzeige nicht; er macht es aber möglich, innerhalb eines Artikels mehrmals dasselbe Symbol für Fußnotenverweise zu benutzen, indem sie verschiedenen Gruppen zugewiesen werden:
Beispiel FN mit Gruppierung:
Nur Einbindungen von FN und FNZ mit gleicher Gruppe und gleichem Symbol verlinken aufeinander. Ebenso muss in FN und FNZ das Format für die Parameter 1 (das Zeichen) und gruppe identisch sein, um die gegenseitige Verlinkung zu gewährleisten. (Anm.) Auch muss, damit das System korrekt funktioniert, für jede Verwendung von {{FN|Zeichen}} – wobei es mehrfach vorkommen darf (x) – ein {{FNZ|Zeichen|(…)}} vorhanden sein, es findet aber prinzipbedingt keine Überprüfung statt und daher wird keine Fehlermeldung ausgegeben.
Vorlage:FNZ
[Quelltext bearbeiten]Diese Vorlage setzt die eigentliche Fußnote.
Beispiel FNZ:
Nur Einbindungen von FN und FNZ mit gleichem Symbol und gleicher Gruppe verlinken aufeinander. Ebenso muss in FN und FNZ das Format für die Parameter 1 (das Symbol) und gruppe (siehe unten) identisch sein, um die gegenseitige Verlinkung zu gewährleisten. (Anm.)
Steht Text vor und hinter der Vorlage, erfolgt standardmäßig dazwischen ein Zeilenumbruch (technisch gesehen ist die Fußnote ein Blockelement; zur Verdeutlichung Leerzeichen vor und nach der Vorlageneinbindung entfernt):
Beispiel FNZ mit Umbruchvisualisierung:
Mit einer zusätzlichen Kennzeichnung (3. Parameter mit beliebigem Wert, nach dem Anmerkungstext zu setzen) wird dieser Zeilenumbruch verhindert, der Fußnoteninhalt wird damit im Fließtext ausgegeben. (Achtung!) So kann beispielsweise zwischen zwei Textstellen hin und her verwiesen werden (Hinweis) (bekanntes Problem) oder kurze Fußnoten (1) (2) (3) können nebeneinander gesetzt werden: (Info)
Beispiel FNZ im Fließtext:
Die Bezeichnung des Parameters sollte so gewählt werden, dass der Sinn seiner Verwendung erkennbar ist, wie etwa „inline“, „imFließtext“ oder „ohne_Umbruch“.
(Hinweis) Wenn nur zwischen zwei Textstellen hin und her verwiesen werden soll, wird üblicherweise auch in FNZ nichts außer dem Fußnotenzeichen benötigt (kein Anmerkungstext). (bekanntes Problem) Für diese Fälle kann in Parameter 2 der spezielle Wert - (der einfache Bindestrich) genutzt werden:
Beispiel FNZ ohne Text:
3 – diese müssen (anders als die Standard-Nutzungen von FNZ ohne diesen Parameter, die einen eigenen Block erzeugen) wie jeder Fließtext direkt zu Beginn der Zeile, das heißt ohne führende Leerzeichen, gesetzt werden (vergleiche Quelltext der Dokumentation):(1) kurze Fußnote 1 — (2) kurze Fußnote 2 — (3) kurze Fußnote 3 .
Wird der Parameter gruppe in FN verwendet, muss er auf identische Weise auch hier verwendet werden, damit die Rückverlinkung funktioniert. In der Darstellung gibt es keinen Unterschied zur Variante ohne diesen Parameter:
Beispiel FNZ im Fließtext mit Gruppierung:
Außer für den Parameter gruppe muss in FN und FNZ auch das Format für den Parameter 1 (das Zeichen) identisch sein, um die gegenseitige Verlinkung zu gewährleisten. (Anm.) Auch muss, damit das System korrekt funktioniert, für jede Verwendung von {{FNZ|Zeichen|(…)}} mindestens ein {{FN|Zeichen}} vorhanden sein, es findet aber prinzipbedingt keine Überprüfung statt und daher wird keine Fehlermeldung ausgegeben. Wie die obigen Beispiele zeigen (hier {{FNZ|Zeichen|Anmerkung}}), erfolgt auch keine Kontrolle, ob eine Fußnotenvorlage eventuell versehentlich mehrfach mit demselben Parameter 1 ohne Gruppierung verwendet wird.
Vereinzelt kommen Fußnoten mit rechts oder links fließenden Inhalten (Floats) in Konflikt – die Noten werden dann unterhalb dieses anderen Inhalts gesetzt, obwohl daneben noch ausreichend Platz wäre. In solchen Fällen kann als Abhilfe das Parameter-Wert-Paar floatfix=1 (ein boolescher Wert für „true/wahr“) gesetzt werden. Dies hat allerdings den unerwünschten Effekt, dass die Farbmarkierung einer aktivierten Fußnote in den Fließbereich hineinreicht, deshalb so sparsam wie möglich einsetzen! Der Parameter muss bedauerlicherweise für jede Fußnote einzeln eingegeben werden, es gibt keine Möglichkeit einer Bündelung.
Bei Fußnoten im Fließtext, wenn also Parameter 3 gesetzt ist, ist floatfix=1 überflüssig und ohne Wirkung.
Vergleich von FNZ mit und ohne floatfix=1:
Vorlage:FNBox
[Quelltext bearbeiten]{{FNBox|
Fußnotentext mit ''Vorlage:FNZ''
}}
Die Vorlage FNBox erzeugt zur visuellen Trennung den Fußnotenstrich – eine Linie von 8 rem Länge mit einer Höhe/
Beispiel FNBox:
Wie zu erkennen ist, kann innerhalb der FNBox neben den Fußnoten weiterer Text stehen. Gedacht und empfohlen ist das nur für Kurztitel wie „Anmerkungen“, Gliederungspunkte bei Gruppierungen und kurze Quellenangaben.
Erlaubte Zeichen für Vorlage:FN und Vorlage:FNZ
[Quelltext bearbeiten]Erlaubt ist in den Parametern 2, 3 und gruppe jeglicher Text unter Beachtung der üblichen Einschränkungen. Im Parameter 1 besteht als zusätzliche Einschränkung, dass eckige Klammern – auch in Form ihrer HTML-Entitäten – verboten sind, um eine Verwechslung mit dem Nachweissystem von MediaWiki zu vermeiden (vergleiche Abschnitt Alternative).
Es sollte jedoch im Normalfall in den Parametern 1, gruppe und 3 der Zeichensatz völlig ausreichen, der üblicherweise zum Schreiben deutschsprachiger Texte benötigt wird, und zudem sollte ein sehr kurzer, einfacher Text genügen.
Das Gleichheitszeichen kann direkt benutzt werden, wenn der Parameter explizit aufgeführt ist, oder über seine HTML-Entität. Der senkrechte Strich kann meist nur über seine HTML-Entität eingegeben werden. Die in anderen Fällen als Ersatz dienenden Parserfunktionen {{=}} und {{!}} funktionieren in den zwei Parametern 1 und gruppe nicht. Siehe auch Hilfe:Sonderzeichen.
Sternchen
[Quelltext bearbeiten]Im Prinzip sind „normale“ Sternchen * (ASCII 42dez. bzw. 2Ahex.) und entsprechend **, ***, **** usw. möglich. Das Zeichen hat den Nachteil, dass es „von Natur aus“ hochgestellt ist und von der Vorlage noch einmal erhöht wird – mischt man also Sternchen und Buchstaben, ergeben sich Höhenunterschiede:
TextText * a nochmehrText *a
Besser ist es, auf das Malzeichen ∗ („Hodge-Stern-Operator“, U+2217, HTML-Entität ∗) auszuweichen, das auf modernen Betriebssystemen implementiert ist (eine Schriftart, die den Unicodeblock Mathematische Operatoren darstellen kann, muss installiert sein, was üblicherweise der Fall ist) und sauber dargestellt wird, die genaue Höhe des Sterns ist dabei abhängig von der genutzten Schrift:
TextText ∗ a, TextText ∗a, TextText ∗∗, TextText ∗∗∗
Das unten folgende Verwendungsbeispiel zeigt einen Fall, wo das überhohe ASCII-Sternchen im Spaltenkopf nicht unbedingt stört.
Umschlossene Zeichen
[Quelltext bearbeiten]Unicode bietet eine Anzahl Umschlossene alphanumerische Zeichen, wie ⑴ oder ⒜, die eigentlich praktisch wären, ⑴/ ⒜ von deren Einsatz aber unbedingt abzuraten ist, da sie in vielen einfachen Schriftarten nicht enthalten sind und nicht sichergestellt werden kann, dass auf jedem externen Rechner eine passende Schriftart vorhanden ist. Auch ist es möglich, dass in der genutzten Schrift die Zeichen zwar vorhanden sind, ihre Darstellung aber nicht optimal ist – etwa zu klein oder sehr blass. Weil man darauf keinen Einfluss nehmen kann, ist hier „normales“ (1)/ (a) sicherlich deutlich besser (ASCII/
Gesammelte Anmerkungen
[Quelltext bearbeiten]Beim Mausklick auf das „x“ kann nachvollzogen werden, dass der Rücksprung nur auf die erste Note im Abschnitt „Verwendung“ erfolgt und nicht auf die ebenfalls mit einem „x“ gekennzeichnete Stelle in der Syntaxerläuterung für Vorlage:FN. Zugleich wird ersichtlich, dass im Normalfall solche weit auseinanderliegenden Mehrfachverwendungen zu vermeiden sind.
Verschiedene Fußnoten ohne weitere Bedeutung, um das Gegenstück für Beispielmarkierungen zu erhalten:
Verwendungsbeispiel
[Quelltext bearbeiten]Ursprünglich dem Artikel Speiseeis entnommen (dort nicht mehr enthalten), hier abgeändert, zusätzlich mit Referenzierung der Anmerkungen mit dem ref-Tag: Damit sind Erläuterungen und Quellen getrennt. Zum Teil wurde der Gruppenparameter nötig, weil die entsprechenden Markierungen innerhalb dieser Dokumentation oben bereits benutzt wurden. Er könnte bei separater Nutzung entfallen oder in allen anderen Vorlageneinbindungen ebenfalls ergänzt werden.
Alternative
[Quelltext bearbeiten]Wie schon erwähnt, lassen sich Fußnoten auch mit dem MediaWiki-eigenen Nachweissystem realisieren (<ref …>…</ref> und <references />). Dazu wird die Gruppierungsfunktion des allgemeinen Einzelnachweissystems genutzt (Attribut group). Die Kennzeichnung im Text erfolgt hier automatisch durch eine fortlaufende Zahl mit vorangestellter Gruppenbezeichnung, während sich bei Benutzung der Vorlage der dargestellte Bezeichner frei wählen lässt – etwa nur ein einzelnes Zeichen wie * oder nur die Ziffern 1, 2, 3 – und die Gruppenbezeichnung gar nicht angezeigt wird.
Beeinflussung der Darstellung
[Quelltext bearbeiten]Die Vorlagen benutzen CSS für die Darstellung, siehe auf der Unterseite für die Stile.
Siehe dort auch zur möglichen eigenen Übersteuerung der Vorgaben.
Wartung
[Quelltext bearbeiten]Fehlerhafte Einbindungen der Vorlagen {{FN}}, {{FNZ}} und {{FNBox}} werden aufgelistet in der Kategorie:Wikipedia:Vorlagenfehler/Fußnoten – aktuell keine (22. November 2024 21:46) .