Hilfe:Einzelnachweise/Quelltext

Aus Cowboy’s Wiki
Zur Navigation springen Zur Suche springen

Diese Hilfeseite behandelt die technische Umsetzung des <ref>-Systems, wie es insbesondere für Einzelnachweise benutzt wird, in Quelltext-Syntax. Es wird auf die Anmutung einer Anmerkung im Sinne einer Fußnote[1] abgezielt.

group= – Gruppierung

Zwei Elemente <ref> und <references> können über einen Gruppenbezeichner einander zugeordnet werden.

  • Standardmäßig gehören alle diese Elemente einer „unbenannten Gruppe“ an.
  • Der Gruppenbezeichner wird in der Seitendarstellung sichtbar. Üblich sind deshalb kurze selbsterklärende Zeichenketten wie Anm oder A usw.
  • Der Gruppenbezeichner wird auch logischer Bestandteil des Einzelbezeichners, der über name= spezifiziert werden kann.
  • Der Gruppenbezeichner ist nach group= in Anführungszeichen " anzugeben.
  • Der Gruppenbezeichner kann und soll nicht leer sein, und weder mit Leerzeichen beginnen noch enden.[2]
  • Der Gruppenbezeichner soll keine Wikisyntax enthalten; insbesondere keine URL, Wikilinks oder Vorlageneinbindungen.
  • Falls innerhalb eines <references> weitere <ref> deklariert werden, dürfen diese kein group= enthalten; die group-Spezifikation von <references> gilt für alle Elemente.

Syntaxbeispiel:

<ref group="Anm"></ref>
<references group="Anm" />

Darstellung an der verwendenden Stelle (<ref>):

Simulation Geboren Juni 1567[Anm 8] in Leipzig.

<references> – Auflistung darstellen

Wikisyntax: <tag>

<references>

Das Element <references> bewirkt, dass an dieser Stelle alle zuvor oder als Inhalt dieses Elements spezifizierten <ref>-Inhalte aufgelistet werden, sofern sie der gleichen Gruppe angehören.

  • Die hier dargestellten Inhalte erscheinen dann nicht mehr in später folgenden <references>.
  • Vor jedem <references> muss mindestens ein aktives <ref> derselben Gruppe in der physischen Abfolge des effektiven Seiten-Quelltextes definiert worden sein.
  • Es können beliebig viele <references> in der Seite auftreten, sofern sie die vorstehenden Regeln einhalten.
  • Jeder Eintrag beginnt mit der zugehörigen Verweisnummer. Die Zählung beginnt immer wieder bei 1.
  • Jeder Eintrag enthält einen verlinkten Rücksprung zu der Stelle, von der aus verwiesen wurde. Zu deren Kennzeichnung steht dort immer ein nach oben zeigender Pfeil:
    1. Bei einem nur einmal verwendeten Inhalt ist der Pfeil mit dem Rücksprung verlinkt.
    2. Bei mehrfachen Nutzungen folgen auf den Pfeil Kleinbuchstaben a b c und die Kleinbuchstaben sind mit den individuellen Rücksprungzielen verlinkt.
  • Falls die letzte interaktive Aktion ein Klick auf den Verweis gewesen war, wird die exakte Rücksprung-Verlinkung temporär hellblau unterlegt.
Simulation
  1. Lirum Larum Löffelstiel.
  2. a b Wer nicht fragt bleibt dumm.
  3. Es rappelt in der Kiste.

Seit 2014 wurden Seiten ohne <references /> nicht mehr mit einer Fehlermeldung markiert und auch nicht mehr in eine Kategorie aufgenommen. Inzwischen wird wieder eine Wartungskategorie ausgelöst. Die am Ende der Seite nicht mittels <references /> abgedeckten Inhalte werden mittels virtuell generierter Auflistungen angezeigt. Ein Darstellungsproblem ist dabei, dass hierfür die Überschrift fehlt, und auch keine Fehlermeldung auf den Wartungsbedarf hinweist.

<references /> – ohne Deklarationen

In der einfachsten Form wird die Darstellung der Auflistung nur ausgelöst; Syntax:

<references />

Das Leerzeichen vor dem Schrägstrich ist allgemein üblich, damit dieser gut und sicher erkannt werden kann und es nicht zur Verwechslung mit der Öffnung gemäß nachfolgendem Abschnitt kommen kann.

<references></references> – mit Deklarationen

Zwischen einem öffnenden <references> und einem schließenden </references> können <ref> mit ihrem Inhalt deklariert werden, die jedoch an dieser Stelle nicht sichtbar als Verweis dargestellt werden.

Zwischen <references> und </references> darf nur die folgende Wikisyntax auftreten:

Zu jedem mit name="…" deklarierten Element muss zuvor im effektiven Seiten-Quelltext ein <ref name="…" /> mit demselben Einzelbezeichner und ggf. derselben wirksamen Gruppe verwendet worden sein.

Wenn es eine Gruppe geben soll, darf diese nur einmalig zugewiesen werden; den einzelnen Elementen nicht mehr:

<references group="Anm">
<ref name="geb">
Das Geburtsdatum wird abweichend angegeben: … … …
</ref>
</references>

Ein „leeres“ Element <references></references> hat dieselbe Wirkung wie <references /> und sollte durch dieses ersetzt werden, sofern keine Inhalte vorgesehen sind, damit niemand verwirrt wird.

Auf vielen Seiten ist es üblich, alle irgendwo in der Seite vorkommenden Inhalte zentral am Ende zu deklarieren, und an den verweisenden Stellen nur noch die Verweismarke unterzubringen. Dadurch werden die Quelltexte mit dem Grundtext kürzer und übersichtlicher. Bei Mehrfachnutzung derselben Inhalte wird klar, an welcher Stelle sie deklariert wurden. Ggf. ist die Wartung ähnlicher externer Inhalte einfacher, weil etwa alle Vorlageneinbindungen, die auf eine bestimmte externe Webseite verweisen, unmittelbar beieinander zu finden sind.

responsive – Mehrspaltige Auflistung

Über das Schlüsselwort responsive wird vereinbart, dass eine mehrspaltige Auflistung zulässig ist, sofern das im momentanen Endgerät möglich ist, also die Anzeigebreite dafür ausreicht.

  • Außerdem müssen mindestens zehn Elemente aufzuzählen sein.

Syntax:

<references responsive />
Simulation
  1. Alpha
  2. a b Oscar
  3. Delta
  4. a b c Romeo
  5. Hotel
  6. Bravo
  1. Foxtrot
  2. a b Charlie
  3. Sierra
  4. a b c Juliet
  5. Yankee
  6. a b November

Grundsätzlich kommt es nur auf die Existenz des Schlüsselworts responsive an. Gelegentlich wird eine andere Syntax angetroffen, etwa responsive="" oder responsive="1" – das sollte bei Gelegenheit auf das Standardformat reduziert werden.

  • Ausnahme: Die Angabe responsive="0" schaltet die Mehrspaltigkeit explizit ab. Das ist bei uns jedoch die Vorgabe und deshalb überflüssig. Es gibt jedoch andere Wikis, bei denen Mehrspaltigkeit die Vorgabe ist, und auf diese Weise dort Einspaltigkeit bewirkt werden kann.

Angemeldete Konten können für sich persönlich die mehrspaltige Darstellung abschalten mittels CSS:

.mw-references-columns {
   column-width: auto;
}

<ref> – Einzelnen Inhalt spezifizieren

Wikisyntax: <tag>

Das <ref>-Element spezifiziert den Inhalt und/oder Ort des angezeigten Hinweises.

  • Wenn es innerhalb von <references></references> auftritt, wird nur der durch name= zugeordnete Nutzinhalt spezifiziert.
  • Ansonsten entsteht an dieser Stelle ein Verweis mit einem Anmerkungszeichen.
    • Das Anmerkungszeichen ist eine in eckige Klammern eingeschlossene fortlaufende Nummerierung, die mit den Verweisnummern in der Auflistung synchron ist.
    • Bei Gruppen wird der Nummer der Gruppenbezeichner vorangestellt.
    • Die Nummer ist verlinkt mit dem zugeordneten Eintrag in der Auflistung.
    • Falls das Direktanzeige-Popup aktiv ist, erscheint ggf. dieses.
    • Die Nummerierung ändert sich dynamisch mit jeder Änderung an den vorangehenden Elementen, wenn Verweise eingefügt oder entfernt werden. Es kann deshalb nur sehr kurzzeitig auf eine bestimmte Nummer Bezug genommen werden.

Darstellung an der verweisenden Stelle:

Simulation Der Siedepunkt liegt bei 100 °C.[42] Beim Gefrieren …

<ref></ref> – mit Inhalt

Der Nutztext eines Hinweises wird zwischen einem öffnenden <ref> und einem schließenden </ref> mit dem gewünschten Inhalt deklariert. Syntax:

<ref>Inhalt</ref>

oder ergänzt durch die Attribute

Beispiel:

<ref>P. Amir: ''Logarithmische Liebeslyrik''. 2027.</ref>

Darstellung in der Auflistung:

Simulation 62. P. Amir: Logarithmische Liebeslyrik. 2027.

Ein „leeres“ Element <ref name="…"></ref> hat dieselbe Wirkung wie <ref name="…" /> und sollte durch dieses ersetzt werden, damit niemand verwirrt wird.

Leerzeichen und Zeilenumbruch vor und nach dem Inhalt, allgemein: „Whitespace“, werden ignoriert. Insbesondere werden Zeilenumbrüche gern zur optischen Gliederung in <references></references> eingesetzt.

name= – Einzelbezeichner

  • Standardmäßig erhält jedes Element einen automatisch generierten, fortlaufend nummerierten Einzelbezeichner. Diese haben jedoch nicht zwingend etwas mit der sichtbaren Nummerierung zu tun, wären aber im Trivialfall deckungsgleich.
  • Abweichend davon kann ein manuell definierter Einzelbezeichner zugeordnet werden.
  • Dadurch wird auch die Wiederverwendung desselben Inhalts ermöglicht.
  • Der Einzelbezeichner ist nach name= in Anführungszeichen " anzugeben.
  • Der Einzelbezeichner kann und soll nicht „leer“ sein, und weder mit Leerzeichen beginnen noch enden.[2]
  • Der Einzelbezeichner soll keine Wikisyntax enthalten; insbesondere keine URL, Wikilinks oder Vorlageneinbindungen.

Die Wiederverwendung derselben Angaben wird häufig bevorzugt, weil eine Publikation nebst digitaler Reproduktion auf Webseiten mit sich ändernden URL recht umfangreicher Pflege bedarf. Ist diese an einem Ort zentralisiert, reduziert das den Wartungsaufwand und vermeidet Inkonsistenzen. Nebenbei wird der Wikitext kürzer und übersichtlicher.

Wirksamer Bezeichner

Der wirksame Bezeichner setzt sich zusammen aus dem Gruppenbezeichner und dem Einzelbezeichner.

Unerlaubte Einzelbezeichner

Um eine verwirrende Gleichsetzung von name="5" mit [5] zu unterbinden, vor allem wenn zuvor andere Elemente eingefügt oder gelöscht werden und diese Gleichsetzung nicht mehr zutrifft, sind Ziffern zu Beginn eines Einzelbezeichners nicht erlaubt. Diese Vorkehrung wird jedoch durch diverse Hacks umgangen.

Sinnvolle Einzelbezeichner

Selbst gewählte Einzelbezeichner sollen selbsterklärend sein und die zu erwartende Funktion und zugeordnete Anmerkung erahnen lassen; müssen sie insbesondere von ähnlichen Inhalten zweifelsfrei und verwechslungssicher unterscheiden.

  • Sie sind nur innerhalb der Seite gültig; müssen also nur im Kontext dieser Seite aufzulösen und kollisionsfrei zuzuordnen sein.

Unbrauchbar und zu ersetzen sind:

  • ":0" und entsprechend ":1" und ":2" und ":3" usw. – leider massenhaft durch den VisualEditor eingebracht
  • "ReferenceA" und entsprechend "ReferenceB" usw. – eine Mustersyntax der englischsprachigen Wikipedia aus den Nuller Jahren, die aus Bequemlichkeit dort einfach abkopiert wird (siehe auch AWB).
  • "q1" für [1] und "q2" für [2] und "q3" für [3] – führt zu einem verwirrenden Durcheinander, sobald zuvor andere Elemente eingefügt oder gelöscht werden.

Angemessen sind etwa:

  • "Meier1987/69" – wird sich wohl auf das Werk von Meier aus dem Jahr 1987 und dort die Seite 69 beziehen.
  • "rfc822"rfc:822

Gleiche Element-Inhalte

Zurzeit ist es noch möglich, zwei Element-Spezifikationen mit gleichem name= und einem Element-Inhalt zu verwenden; jedoch dann und nur dann, wenn der Inhalt Byte für Byte identisch ist.

  • Sobald eines der beiden bearbeitet wird, sind sie nicht mehr identisch und lösen eine Fehlermeldung aus.
  • Wenn Elemente mit gleichem name= erkannt werden, sollte einer dieser beiden aufgelöst und durch einen inhaltsfreien Verweis ersetzt werden.

<ref name="" /> – ohne Inhalt

Mit der Struktur <ref name="…" /> wird ein sichtbarer Verweis generiert.

  • Dabei muss der Einzelbezeichner name="" wirksam mit einem Inhalt deklariert sein.
  • Die Stelle dieser Spezifikation ist egal; jedoch muss sie vor Abschluss des zugehörigen <references> außerhalb von anderen <ref> auf der obersten Quelltext-Ebene liegen.

Das Leerzeichen vor dem Schrägstrich ist allgemein üblich, damit dieser gut und sicher erkannt werden kann und es nicht zur Verwechslung mit der Öffnung eines Elements mit Inhalt kommen kann.

details= – Fundstelle

Im September 2025 wurde eine Erweiterung der Funktionalität eingeführt.[3] Sie ermöglicht, die bibliografischen Angaben einer Publikation zentral zu hinterlegen und zentral zu pflegen und dann auf einzelne Fundstellen (Seitenzahlen, Versnummern, Spaltennummern, Paragrafen) darin zu verweisen.

  • Das Attribut details="" enthält den Text der einzelnen Fundstellen.[2]
  • Das Attribut name="" muss gleichzeitig definiert sein und identifiziert das Element, in dem die vollständigen bibliografischen Angaben hinterlegt sind. Ob diese Form der Referenzierung genutzt wird, entscheidet jedoch die maßgeblich am Artikel beteiligte Person.
  • Der in details="" angegebene Text soll sehr kurz sein und ausschließlich die Fundstelle bezeichnen.
  • Der in details="" angegebene Text sollte keine komplexe Wikisyntax enthalten.

Beispiel für die Anwendung im allgemeinen Text:

Beobachtungen des Weltraumteleskops Hubble ergaben, dass sich die Monde des Uranus dem Planeten nähern.<ref name="Uranus12" details="S. 35." /> Diese Beobachtung führte zu der als „Big Bang“-Theorie bezeichneten Voraussage über das weitere Schicksal des Planeten.<ref name="Uranus12" details="S. 37." />

Eine Spezifikation der Publikation mit bibliografischen Angaben könnte wie folgt aussehen:

<references>
<ref name="Uranus12">
Musterautor: ''Neue Uranus-Monde''. In: ''Populäre Wissenschaft'', 2005, Nr. 12, S. 31–38.
</ref>
</references>

In der Auflistung wird dann dargestellt:

Simulation

1. ↑ Musterautor: Neue Uranus-Monde. In: Populäre Wissenschaft, 2005, Nr. 12, S. 31–38.

1.1. S. 35.
1.2. S. 37.

Der allgemeine Text wird wie folgt mit Verweisen versehen:

Simulation Beobachtungen des Weltraumteleskops Hubble ergaben, dass sich die Monde des Uranus dem Planeten nähern.[1.1] Diese Beobachtung führte zu der als „Big Bang“-Theorie bezeichneten Voraussage über das weitere Schicksal des Planeten.[1.2]

Begrenzte Wikisyntax

Zu einem bestimmten Zeitpunkt der Verarbeitung der Wikisyntax wird der Inhalt der <ref> dem Wikitext entnommen, und danach auf einem getrennten Pfad weiterverdaut.

  • Dabei wird sich darauf verlassen, dass diejenigen Interpretationen bereits erfolgt sind, die in diesem Moment für die gesamte Seite schon erfolgt sein müssen.
  • Deshalb ist auch eine Verschachtelung problematisch, weil sie bereits abgearbeitet wurde, nachdem ein äußeres <ref> aufgelöst wurde, und eine folgende innere Abarbeitung durch die Wiki-Software nicht zugesichert wird.
  • Eine Reihe von Syntax-Aktivitäten sind innerhalb der <ref>-Bereiche nicht mehr möglich, weil dieser Textbereich jeweils losgelöst von der restlichen Seite verarbeitet wird.
  • Andere Auflösung von Wikisyntax erfolgt erst in der restlichen Seite, nachdem die <ref> bereits herausgeschnitten wurden, und kann auf diese nicht mehr angewendet werden.
  • Weil dieses Verhalten seit zwei Jahrzehnten unverändert wirkt, kann daran nachträglich nichts mehr geändert werden, weil sonst alle Seiten im Bestand Gefahr laufen, zu unerwünschten Resultaten zu führen.
  • Konzeptionell ist der Inhaltsbereich der <ref> nur für kurze Anmerkungen vorgesehen. Komplex strukturierte Darstellungen mit besonderem Layout sind hier teilweise schlicht unmöglich.

Verschachtelung

Die Wiki-Software versucht nach Möglichkeit zu verhindern, dass innerhalb von <ref> andere <ref> wirksam werden.

  • Auch in den (professionellen) Papier-Druckwerken gibt es nirgendwo den Fall, dass innerhalb einer Anmerkung zu einer Seite auf irgendeine andere Anmerkung mittels Anmerkungszeichen verwiesen würde.
  • Es kann zu einem Zirkelschluss kommen, weshalb die Beziehungen nicht mehr auflösbar sind.

In der deutschsprachigen Wikipedia ist es unerwünscht, diese Begrenzung durch Hacks zu umgehen.

  • Es ist auch für das Publikum verwirrend, anschließend zur ursprünglichen Stelle zurückzufinden.
  • Auch im Direktanzeige-Popup ist unklar, ob die Software dies vertragen würde.
  • <references> innerhalb von <ref> sind völlig ausgeschlossen.

Hilfsmittel

Seiten mit Problemen usw. werden gelistet:

Die neu eingeführten details= werden beobachtet:

Anmerkungen

(nachstehend echte Beispiele für <references> – auch mit mehrfach genutztem Einzelbezeichner)

  1. Eine Webseite im Browser besteht (anders als ein Buch) immer nur aus einer einzigen Seite. Deshalb fallen „Fußnote“ und „Endnote“ zusammen. Wegen des Umfangs von Wikipedia-Seiten, an deren Ende meist die Auflistungen stehen, sind es eher Endnoten. Druckt man allerdings eine Wiki-Seite aus (PDF-Funktion), dann merkt man, dass es tatsächlich in aller Regel Endnoten sind.
  2. 2,0 2,1 2,2 Wie für alle Attribute gilt:
    • Sie sollen in Anführungszeichen " eingeschlossen sein.
    • Sie düfen keines der Zeichen <>" oder Zeilenumbruch enthalten.
    • Sie sollen weder mit Leerzeichen beginnen noch enden.
  3. CowboysWiki:Technische Wünsche/Topwünsche/Subreferenzierung durch WMDE.