Vorlage:FN/Doku

Vorlage:Dokumentation/Seitenhinweis

Diese Vorlage wird nicht für die Belegung von Informationen mit Quellen in Literatur und Medien im Fließtext verwendet.

fatal JSON error: mw.text.jsonDecode: Steuerzeichenfehler, vermutlich falsch kodiert

{ "description": "Lokale '''Fußnoten''' setzen: Anmerkungszeichen unabhängig von der MediaWiki-Technik für Einzelnachweise platzieren<noexport>.<br />
Zusammen mit Vorlage:FNZ können Anmerkungen eingefügt werden, etwa in Tabellen&nbsp;– unabhängig von der Technik der Einzelnachweise mit <code>&lt;ref&gt;…&lt;/ref&gt;</code> und <code style='white-space:nowrap'>&lt;references /&gt;</code>.</noexport>",
  "params": {
     "1":
        { "label":       "Zeichen",
          "description": "Anmerkungszeichen",
          "type":        "line",
          "required":    true,
          "example":     "*)" },
     "gruppe":
        { "label":       "Gruppierung",
          "description": "Früher erforderliche explizite Zuordnung von gleichnamigen Bezeichnern an unterschiedlichen Stellen",
          "type":        "line",
          "deprecated":  "(ersatzlos entfallen)" }
  },
  "format": "inline"
}

Verwendung

Die Vorlagen FN und FNZ bieten gemeinsam die Möglichkeit, Anmerkungen völlig unabhängig von der Technik der Einzelnachweise/Belege (die mit <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 sorgen müssen, damit auch die interne Rückverlinkung ermöglicht wird.

Die Vorlage FN setzt nur die Markierung (den Bezeichner / das Zeichen) für eine Fußnote. Die eigentliche Fußnote wird mit der Vorlage FNZ gesetzt. Die Namensgebung von FN („Fußnote“) und FNZ („Fußnotenzeichen“) ist damit in Bezug auf den Verwendungszweck der Vorlagen vertauscht, wird aber aus Kompatibilitätsgründen nicht mehr geändert.

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.

Die Paarungen der FN mit den FNZ werden solange als Gruppierung betrachtet, bis nach mehreren FN das erste FNZ auftritt. Umgekehrt begint mit dem ersten FN nach FNZ eine neue, automatisch generierte Gruppe.

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.

Vorlage:Standardbaustein

Kopiervorlagen

<syntaxhighlight lang="wikitext" copy> <templatestyles src="FN/styles.css" /> ^zeichen </syntaxhighlight> <syntaxhighlight lang="wikitext" copy>

^zeichen

bedeutung

</syntaxhighlight>

Syntax

Vorlage:FN

Die Vorlage FN darf, ebenso wie ref-Tags (<ref>…</ref>; MediaWiki-Technik für Belege und Anmerkungen), nicht in Überschriften des Inhaltsverzeichnisses verwendet werden.

Diese Vorlage setzt nur die Markierung.

Beispiel FN: Vorlage:Standardbaustein Vorlage:Standardbaustein

^(Anm.)

Siehe Anmerkung im Abschnitt für die Vorlage FNZ (wegen des unter Verwendung thematisierten problematisch großen Abstandes und der dann irreführenden Rückverlinkung als separater Hinweis statt möglicher zusätzlicher Fußnotenmarke, obwohl beide als „Anm.“ benannt sind und sich daher visuell nicht unterscheiden).

Vorlage:Standardbaustein

Vorlage:FNZ

<section begin="FNZ" />Diese Vorlage setzt die eigentliche Fußnote.

Beispiel FNZ:
Vorlage:Standardbaustein Vorlage:Standardbaustein

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.<templatestyles src="FN/styles.css" /> ^(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:
Vorlage:Standardbaustein Vorlage:Standardbaustein

Skriptfehler: Ein solches Modul „Vorlage:Anker“ ist nicht vorhanden.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.<templatestyles src="FN/styles.css" /> ^(Achtung!) So kann beispielsweise zwischen zwei Textstellen hin und her verwiesen werden<templatestyles src="FN/styles.css" /> ^(Hinweis)<templatestyles src="FN/styles.css" /> ^{(bekanntes Problem)} oder kurze Fußnoten<templatestyles src="FN/styles.css" /> ⁽¹⁾<templatestyles src="FN/styles.css" /> ⁽²⁾<templatestyles src="FN/styles.css" /> ⁽³⁾ können nebeneinander gesetzt werden:<templatestyles src="FN/styles.css" /> ^(Info)

Beispiel FNZ im Fließtext:
Vorlage:Standardbaustein Vorlage:Standardbaustein

Die Bezeichnung des Parameters sollte so gewählt werden, dass der Sinn seiner Verwendung erkennbar ist, wie etwa „inline“, „imFließtext“ oder „ohne_Umbruch“.

<templatestyles src="FN/styles.css" />^(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).<templatestyles src="FN/styles.css" /> ^{(bekanntes Problem)} Für diese Fälle kann in Parameter 2 der spezielle Wert - (der einfache Bindestrich) genutzt werden:

Beispiel FNZ ohne Text:
Vorlage:Standardbaustein Vorlage:Standardbaustein

^(Achtung!)

Der Anmerkungstext, also der Fußnoteninhalt in Parameter 2, darf dann auch keine HTML-Block-Elemente enthalten, sondern ausschließlich Inline-Elemente! Anderenfalls wird fehlerhafter Code generiert (Linter-Fehler).

^{(bekanntes Problem)}

Bei leeren Fußnoten kann die Einzelnachweisvorschau nichts anzeigen und erzeugt bei der Marke, die durch Vorlage:FN eingefügt wird, stattdessen die Fehlermeldung „Es gab ein Problem bei der Anzeige dieser Vorschau“! Die visuell nicht zu unterscheidende Marke, die durch Vorlage:FNZ eingefügt wird, erzeugt dagegen keine Vorschau wie alle anderen mit dieser Vorlage eingefügten Marken.

^(Info)

Darstellung kurzer Fußnoten mit Parameter 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):

<templatestyles src="FN/styles.css" />⁽¹⁾ kurze Fußnote 1 — <templatestyles src="FN/styles.css" />⁽²⁾ kurze Fußnote 2 — <templatestyles src="FN/styles.css" />⁽³⁾ kurze Fußnote 3 .

Skriptfehler: Ein solches Modul „Vorlage:Anker“ ist nicht vorhanden.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:Standardbaustein Vorlage:Standardbaustein<section end="FNZ" />

Vorlage:FNBox

Fußnotentext mit Vorlage:FNZ

</syntaxhighlight>

Die Vorlage FNBox erzeugt zur visuellen Trennung den Fußnotenstrich – eine Linie von 8 rem Länge mit einer Höhe/Breite von 1 px – und eine Einrückung von 0,8 rem.

Beispiel FNBox:
Vorlage:Standardbaustein Vorlage:Standardbaustein

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.<section end="FNBox" />

Erlaubte Zeichen für Vorlage:FN und Vorlage:FNZ

Erlaubt ist in den Parametern 2 und 3 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 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 im Parameter 1 nicht. Siehe auch Hilfe:Sonderzeichen.

Sternchen

Im Prinzip sind „normale“ Sternchen <templatestyles src="FN/styles.css" /> ^* (ASCII 42_dez. bzw. 2A_hex.) und entsprechend <templatestyles src="FN/styles.css" /> ^**, <templatestyles src="FN/styles.css" /> ^***, <templatestyles src="FN/styles.css" /> ^**** 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<templatestyles src="FN/styles.css" /> ^*<templatestyles src="FN/styles.css" /> ^a nochmehrText<templatestyles src="FN/styles.css" /> ^*a

Besser ist es, auf das Malzeichen ∗ („Hodge-Stern-Operator“, U+2217, HTML-Entität &lowast;) 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<templatestyles src="FN/styles.css" /> ^∗<templatestyles src="FN/styles.css" /> ^a, TextText<templatestyles src="FN/styles.css" /> ^∗a, TextText<templatestyles src="FN/styles.css" /> ^∗∗, TextText<templatestyles src="FN/styles.css" /> ^∗∗∗

Das unten folgende Verwendungsbeispiel zeigt einen Fall, wo das überhohe ASCII-Sternchen im Spaltenkopf nicht unbedingt stört.

Umschlossene Zeichen

Unicode bietet eine Anzahl Umschlossene alphanumerische Zeichen, wie ⑴ oder ⒜, die eigentlich praktisch wären,<templatestyles src="FN/styles.css" /> ^⑴^/<templatestyles src="FN/styles.css" /> ^⒜ 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“ <templatestyles src="FN/styles.css" /> ⁽¹⁾^/<templatestyles src="FN/styles.css" /> ^(a) sicherlich deutlich besser (ASCII/Basis-Lateinisch).

Gesammelte Anmerkungen

^(x)

Diese Anmerkung dokumentiert, dass die Rückverlinkung nur auf das erste Vorkommen des Bezeichners im Text möglich ist:
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:

^*

ein einfaches Sternchen als Symbol und (als Inline-Fußnoten) <templatestyles src="FN/styles.css" />^** zwei Sternchen, <templatestyles src="FN/styles.css" />^*** drei Sternchen, <templatestyles src="FN/styles.css" />^**** vier Sternchen

<templatestyles src="FN/styles.css" />^a Buchstabe ohne Klammern, <templatestyles src="FN/styles.css" />^(a) Buchstabe mit Klammern, <templatestyles src="FN/styles.css" />^*a Sternchen mit Buchstabe in einem Bezeichner

^∗

Sternoperator als HTML-Entität (vergleiche Quelltext der Dokumentation)

^∗a

Sternoperator und Buchstabe in einem Bezeichner

^∗∗

zwei Sternoperatoren, <templatestyles src="FN/styles.css" />^∗∗∗ drei Sternoperatoren

^⑴

Symbol aus dem Unicodeblock Umschlossene alphanumerische Zeichen (ein Zeichen): 1 in runden Klammern

^⒜

weiteres Symbol aus dem Unicodeblock Umschlossene alphanumerische Zeichen (ein Zeichen): a in runden Klammern

⁽¹⁾

Symbol aus drei Zeichen ASCII bzw. aus dem Unicodeblock Basis-Lateinisch: 1 in runden Klammern

Verwendungsbeispiel

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.

Vorlage:Standardbaustein Vorlage:Standardbaustein

Alternative

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 nicht auftritt.

Vorlage:Standardbaustein Vorlage:Standardbaustein <section begin="CSS_Wartung" />

Beeinflussung der Darstellung

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

Vorlage:Vorlagenfehler-Wartungskat.<section end="CSS_Wartung" />