Phabricator Projekt: #cite

Erweiterung:Cite

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Extension:Cite and the translation is 100% complete.

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎magyar • ‎italiano • ‎日本語 • ‎한국어 • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文
Diese Seite beschreibt diese Erweiterung. Zur Verwendung siehe auch Hilfe zu Fußnoten (englisch!) und Hilfe zur Erweiterung.
Erweiterung ist üblicherweise in MediaWiki 1.21 und darüber enthalten. Daher entfällt ein erneutes herunterladen. Allerdings müssen Sie ggf. trotzdem weiteren gegebenen Anleitungen folgen.
Ab MediaWiki 1.25 gehört die „Spezial:Zitieren“-Funktion die hier ebenfalls dokumentiert war nicht mehr zur „Cite“-Erweiterung. Wenn ein Upgrade von MediaWiki 1.24 durchgeführt wird, muss die folgende Zeile aus der „LocalSettings.php“-Datei entfernt werden.
require_once "$IP/extensions/Cite/SpecialCite.php";
Die „Spezial:Zitieren“-Erweiterung ist jetzt unter der Erweiterung Zitierhilfe bekannt und kann separat installiert werden.
MediaWiki-ErweiterungenManual:Extensions
Crystal Clear action run.png
Cite

Erscheinungsstatus:Extension status stable

Cite extension screenshot.png
EinbindungTemplate:Extension#type Tag
BeschreibungTemplate:Extension#description Ergänzt Fußnoten-Funktionalität und erlaubt so diese Art der Quellenangaben für Zitate
Autor(en)Template:Extension#username Ævar Arnfjörð Bjarmasontalk
Letzte VersionTemplate:Extension#version Laufende Aktualisierungen
MediaWikiTemplate:Extension#mediawiki 1.25+
PHPTemplate:Extension#php 5.3+
DatenbankänderungenTemplate:Extension#needs-updatephp No
LizenzTemplate:Extension#license GNU General Public License 2.0 or later
Download
BeispielTemplate:Extension#example Wikipedia:Footnotes
Verwendete HooksTemplate:Extension#hook
BeforePageDisplayManual:Hooks/BeforePageDisplay
DebugManual:Hooks/Debug
ParserBeforeTidyManual:Hooks/ParserBeforeTidy
ParserClearStateManual:Hooks/ParserClearState
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
ParserGetVariableValueTsManual:Hooks/ParserGetVariableValueTs
ParserGetVariableValueVarCacheManual:Hooks/ParserGetVariableValueVarCache
SkinTemplateBuildNavUrlsNav_urlsAfterPermalinkManual:Hooks/SkinTemplateBuildNavUrlsNav_urlsAfterPermalink
SkinTemplateToolboxEndManual:Hooks/SkinTemplateToolboxEnd
User

Translate the Cite extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

Die Cite-Erweiterung erlaubt es Nutzern Verweise als Fußnoten auf einer Seite einzusetzen. Es ergänzt zwei Parser-Hooks zum MediaWiki, <ref> und <references />; diese funktionieren zusammen, um Fußnoten (und so auch Quellenangaben für Zitate) für eine Seite zu ermöglichen.

Herunterladen[edit]

Die Erweiterung kann man direkt von Git erhalten [?]:

  • Den Code ansehen
  • Einige Erweiterungen haben Hinweise für stabile Releases.
  • Jeder Zweig ist mit einem vergangenen MediaWiki Release assoziiert. Es gibt außerdem einen „Master“-Zweig, der die aktuellste Alpha-Version enthält (dies könnte eine Alpha von MediaWiki erfordern).

Extrahiere den Snapshot und kopiere ihn in das extensions/Cite/-Verzeichnis der MediaWiki-Installation.

Falls man sich mit git auskennt und einen Konsolen-Zugang zum Server hat, kann man die Erweiterung auch so bekommen:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Cite.git

Installation[edit]

Manuelle Installation

  • Lade die Erweiterung herunter und lege die Datei(en) in ein Verzeichnis namens Cite in deinem Ordner extensions/ ab.
  • Füge folgenden Code am Ende deiner LocalSettings.php hinzu:
    wfLoadExtension( 'Cite' );
    
  • YesY Erledigt - Navigiere zu Special:Version in deinem Wiki (bei Einstellung auf deutsch nach Spezial:Version), um zu prüfen, dass die Erweiterung erfolgreich installiert ist.

Verwendung[edit]

Das Grundkonzept des <ref>-Tags besteht darin den eingeschlossenen Text als Fußnote in einem bestimmten Abschnitt – ausgezeichnet durch den <references />-Tag – einzufügen. Dieses Format kann nicht mit dem älteren Format zusammen benutzt werden – es muss das eine oder das andere gewählt werden.

Zusätzliche <references />-Tags können in den Text eingefügt werden. Alle <ref>-Tags bis zu dieser Stelle werden dann dort dargestellt.

Falls das Einfügen des <references />-Tags vergessen wird, werden die Fußnoten trotzdem alle am Ende der Seite dargestellt.

Diese Seite selbst benutzt Fußnoten, wie die am Ende dieses Satzes.[note 1] Im Wiki-Quelltext der Seite kann also eine funktionierende Verwendung für Fußnoten angesehen werden.

Wikitext Ausgabe im Browser (Rendering)
„The Sun is pretty big.“<ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> „The Moon, however, is not so big.“<ref>''R. Smith, "Size of the Moon", ''Scientific American'', 46 (April 1978): 44-6.</ref>

== Nachweise ==
<references />

„The Sun is pretty big.“[1] „The Moon, however, is not so big.“[2]

Nachweise
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.
  2. R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.

Die gleiche Fußnote mehrmals benutzen[edit]

Um einer Fußnote einen eindeutigen Namen zu geben wird <ref name="name"> benutzt. Man kann sich dann immer wieder auf diese Fußnote beziehen, indem man den gleichen Namen wieder verwendet. Der Text im zweiten Tag spielt keine Rolle, weil dieser mit der ersten Verwendung bereits festgelegt wurde. Man kann entweder die gesamte Fußnote kopieren oder einen beendeten leeren ref-Tag benutzen, z. B. so: <ref name="name" />. Die Schreibmaschinen-Anführungszeichen sind nicht erforderlich (aber korrekt), falls der Name keine Leerzeichen enthält. Das Leerzeichen vor dem schließenden „/“ darf weggelassen werden.

Im folgenden Beispiel wird dieselbe Fußnote dreimal referenziert.

Wikitext Ergebnis
Dies ist ein Beispiel für eine mehrfache Referenzierung derselben Fußnote.<ref name="multiple">Bedenke, wenn man mehrmals auf dieselbe Fußnote Bezug nimmt, wird immer der Text der ersten Nutzung angezeigt!</ref>

Solche Referenzierungen sind besonders nützlich, wenn Quellen zitiert werden und mehrere Angaben von dort stammen.<ref name="multiple" /> Jede zusätzlich benutzte Referenzierung sollte keinen zusätzlichen Inhalt haben, sonst wird ein Fehler angezeigt. Nutze nur leere ''Tags'' für diesen Zweck.

Die Nutzung leerer ''ref-Tags'', die einen Schrägstrich am Ende haben, ist eine kurze Möglichkeit mehrere Fußnoten einzusetzen. Obwohl dies redundante Arbeit reduziert, führt es dazu, dass alle Fußnoten nicht mehr angezeigt werden, die leere ''Tags'' benutzen, falls die erste Angabe entfernt wird!<ref name="multiple" />

== Fußnoten ==
<references />
Dies ist ein Beispiel für eine mehrfache Referenzierung derselben Fußnote.[1]

Solche Referenzierungen sind besonders nützlich, wenn Quellen zitiert werden und mehrere Angaben von dort stammen.[1] Jede zusätzlich benutzte Referenzierung sollte keinen zusätzlichen Inhalt haben, sonst wird ein Fehler angezeigt. Nutze nur leere Tags für diesen Zweck.

Die Nutzung leerer ref-Tags, die einen Schrägstrich am Ende haben, ist eine kurze Möglichkeit mehrere Fußnoten einzusetzen. Obwohl dies redundante Arbeit reduziert, führt es dazu, dass alle Fußnoten nicht mehr angezeigt werden, die leere Tags benutzen, falls die erste Angabe entfernt wird![1]

Fußnoten
  1. 1.0 1.1 1.2 Bedenke, wenn man mehrmals auf dieselbe Fußnote Bezug nimmt, wird immer der Text der ersten Nutzung angezeigt!
Bedenke, dass „Namen“ Buchstaben erfordern; Nur Zahlen zu benutzen gibt eine Fehlermeldung aus.

Zwei Texte in eine Fußnote fassen[edit]

Ein typischer Fall bei Wikisource ist, wie der Fußnotentext von unterschiedlichen Seiten in einer Fußnote angezeigt werden kann. Dies kann mit dem <ref name="name">-Tag für den ersten Teil der Fußnote und mit der Nutzung von <ref follow="name"> für alle folgenden Teile erreicht werden.

Es folgt ein Beispiel:

Wikitext Ausgabe im Browser (Rendering)
Dies ist ein Beispiel, wie mehrere Fußnoten mit unterschiedlichen Texten als eine Fußnote angezeigt werden können.<ref name="main">Bedenke, dass alle Texte in die Fußnote integriert werden, die das ''name=''-Attribut tragen.<br /></ref>

Ergänze Text, der zur ersten Fußnote (<nowiki><ref name="main"></nowiki>) angefügt werden soll mit einem <nowiki><ref follow="name"></nowiki>-''Tag''.<ref follow="main">Dieser Absatz ist in einen ähnlichen ''Tag'' eingeschlossen und wird der ersten Fußnote des obigen Absatzes beigefügt.</ref>

== Fußnoten ==
<references/>

Dies ist ein Beispiel, wie mehrere Fußnoten mit unterschiedlichen Texten als eine Fußnote angezeigt werden können.[1]

Ergänze Text, der zur ersten Fußnote (<ref name="main">) angefügt werden soll mit einem <ref follow="name">-Tag.

Fußnoten
  1. Bedenke, dass alle Texte in die Fußnote integriert werden, die das name=-Attribut tragen.
    Dieser Absatz ist in einen ähnlichen Tag eingeschlossen und wird der ersten Fußnote des obigen Absatzes beigefügt.

Wenn diese Syntax im Hauptnamensraum („ns0“, „:“ oder auch „Main“) verwendet wird, ist zu beachten, dass der ref follow-Teil der Fußnote in dieselbe ns0-Seite eingebunden wird, in der auch der erste Teil der Fußnote eingebunden ist. Dafür können angemessene Section-Tags benutzt werden. Außerdem erneut die Erinnerung, dass „Namen“ nie nur aus Nummern bestehen sollten, z. B. <ref name="p32"> und <ref follow="p32">.

Der <references />-Tag[edit]

Der <references />-Tag fügt den Text aller vorher in <ref>-Tags angegebenen Fußnoten an einer definierten Stelle ein. Zum Beispiel, mit der oben benutzten Fußnote, gibt es eine Referenzierung für die Gruppe note.

Wikitext Ergebnis
<references group="note"/>
  1. Diese Fußnote ist ein Beispiel im Abschnitt „Verwendung“.

Bei einigen Sprachversionen der Wikipedia werden lange Fußnotenlisten mit der Vorlage{{Reflist}} gesetzt, die <references /> enthält. Diese Vorlage bietet einen optionalen Parameter, um die Fußnoten in mehreren Spalten anzuzeigen. Zum Beispiel kann in der englischen, der Hindi und der Interlingua Wikipedia der css-selector references-small benutzt werden, um die Ausgabe der Fußnoten kleiner als normalen Text zu gestalten.

Wenn eine Seite mehr als einen <references />-Tag enthält, listet jeder die vorhergehenden <ref>-Tags bis zum vorhergehenden <references />-Tag auf. Falls diese Listen durch eine Vorlage erzeugt werden, listet jede die Fußnoten vor der ersten Liste auf und es wird ein Fehler angezeigt, der sagt, es gebe einen ref-Tag aber keine references-Liste.

Gruppierte Fußnoten[edit]

Diese Funktion kann bei Bedarf durch $wgAllowCiteGroups = false; abgeschaltet werden.

Das folgende Beispiel erzeugt getrennte Listen für Quellen und generelle Fußnoten:

Wikitext Ergebnis
Wissenschaftler sagen, die Sonne sei ziemlich groß<ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> Tatsächlich ist sie extrem groß. <ref group="footnotes"> Nehmt sie beim Wort. Schauen Sie niemals direkt in die Sonne!</ref>

== Fußnoten ==
<references group="footnotes" />

== Nachweise ==
<references />
Wissenschaftler sagen, die Sonne sei ziemlich groß[1] Tatsächlich ist sie extrem groß. [footnotes 1]
Fußnoten
  1. Nehmt sie beim Wort. Schauen Sie niemals direkt in die Sonne!
Nachweise
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.

Die Gruppe ohne Namen funktioniert wie bekannt, während die Fußnoten der benannten Gruppe nur im betreffenden <references /> Element auftauchen.

Fußnoten an anderen Stellen im Quelltext[edit]

In-Text Fußnoten machen es einfach den Text auf eine andere Seite zu kopieren; auf der anderen Seite machen sie es schwieriger den Quelltext zu lesen. Fußnoten, die eine große Menge Information enthalten, z. B. lange Zitate oder Quellenvorlagen, können einen deutlich größeren Anteil des Quelltextes einnehmen, als der Text, der eigentlich angezeigt werden soll. Um dies zu vermeiden, wurde in den neueren Versionen der Erweiterung die Möglichkeit eingeführt einen Teil oder den ganzen Text der Fußnote in den <references /> Abschnitt zu verschieben; also dorthin, wo er auch normalerweise angezeigt wird.

Wikitext Ergebnis
Wissenschaftler sagen, die Sonne sei ziemlich groß.<ref name="miller" /> Tatsächlich ist sie extrem groß.<ref name="smith" />

== Nachweise ==
<references>
<ref name="miller">E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref>
<ref name="smith">R. Smith, "Size of the Moon", ''Scientific American'', 46 (April 1978): 44-6.</ref>
</references>
Wissenschaftler sagen, die Sonne sei ziemlich groß.[1] Tatsächlich ist sie extrem groß.[2]
Nachweise
  1. E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.
  2. R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.

So hat der Quelltext die gleiche Ausgabe wie das erste Beispiel oben, auch wenn die Nummerierung und Reihenfolge nicht zwingend gleich sein muss.

Andere Anwendungsarten und Parser-Funktionen[edit]

Da das <ref>-Tag vor den Parser Funktionen von MediaWiki (wie z. B. {{#ifexpr:…}}), Variablen (z. B. {{PAGENAME}}) oder vor subst: ausgewertet wird, funktionieren diese nicht innerhalb von Fußnoten. Stattdessen muss das magische Wort {{#tag:…}} benutzt werden. Achtung! Es wird im folgenden Beispiel die nicht-übersetzbare Vorlage {{cite journal}} benutzt. Der Effekt kann aber auch in der englischen Sprache beobachtet werden.

Wikitext Ergebnis
Foo <ref>Das funktioniert nicht, siehe{{cite journal|url="www.google.com" |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}</ref> bar baz… 
Foo{{#tag:ref| Wohingegen dies funktioniert, siehe {{cite journal|url="www.google.com" |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}}} bar baz…
<references />

Foo [1] bar baz… Foo[2] bar baz…

  1. Das funktioniert nicht, siehe"["www.google.com" Search]" . Retrieved on [[{{subst:#time:Y-m-d|now}}]]. 
  2. Wohingegen dies funktioniert, siehe "["www.google.com" Search]" . Retrieved on 2017-01-27. 

Anpassung[edit]

Das Format der Ausgabe von <ref> und <references> ist nahezu vollständig anpassbar. Dies geschieht durch MediaWiki Nachrichten, die modifiziert werden können; zum Beispiel durch den MediaWiki-Namensraum, abhängig von der Konfiguration des Wikis.

Für eine Liste von Nachrichte, die die Ausgabe von <ref> und <references> steuern und deren Übergabe-Werte ($1, $2, $3 ...), falls vorhanden, siehe hier. Dort erhält man eine aktuelle Liste der Standards.

Nachfolgend eine unvollständige Liste
  • cite_reference_link_key_with_num
    1. key
    2. num
  • cite_reference_link_prefix
  • cite_reference_link_suffix
  • cite_references_link_prefix
  • cite_references_link_suffix
  • cite_reference_link
    1. ref ID
    2. backlink ID
    3. count to display
  • cite_references_link_one
    • Used to format the source list that <references /> outputs, it configures 3 things: the backlink ID, the ref ID, and text of note.
    1. backlink ID - used for creating the number order of the source list.
    2. ref ID - used to link back to the actual reference in the text, this is where you can configure the <bold>^</bold> symbol
    3. text of note - text used above describing the source info
  • cite_references_link_many
    1. backlink ID
    2. list of links
    3. text of note
  • cite_references_link_many_format
    1. ref ID
    2. numeric value to use as a backlink
    3. custom value (as defined in cite_references_link_many_format_backlink_labels to use as a backlink)
  • cite_references_link_many_format_backlink_labels
  • cite_references_link_many_sep
  • cite_references_link_many_and
  • cite_references_prefix
  • cite_references_suffix

Änderung der Voreinstellungen zur Nutzung von ^ und Buchstaben[edit]

Um den Standard Aufwärtspfeil (↑) durch ein Caret Zeichen (^) zu ersetzen, müssen folgende Systemnachrichten geändert werden. Alle diese Seiten können durch Spezial:MediaWiki-Systemnachrichten aufgefunden werden.

MediaWiki:Cite references link one
Änderung von zu
<li id="$1">[[#$2|↑]] $3</li>
<li id="$1">[[#$2|^]] $3</li>
MediaWiki:Cite references link many
Änderung von zu
<li id="$1">↑ $2 $3</li>
<li id="$1">^ $2 $3</li>
MediaWiki:Cite references link many format

Wird $3 zwischen die <sup> </sup>-Tags gesetzt, ändert dies die Links von 1.0, 1.1, 1.2 zu a, b, c etc…

Änderung von zu
[[#$1|<sup>$2</sup>]]
[[#$1|<sup>$3</sup>]]

Sucht man diese drei Seiten das erste Mal auf, sind sie noch nicht vorhanden. In diesem Fall erzeugt man sie durch einen Klick auf „Erstellen“. Die Änderungen werden jedoch vorerst nicht angezeigt, erst wenn eine Seite mit Fußnoten erneut gerendert wird.

Erzeugen von Hervorhebungen für Fußnoten[edit]

Seit MW 1.26MediaWiki 1.25/wmf22 sind die Selektoren für das Hervorheben in Cite/modules/ext.cite.css integriert. Daher muss der CSS-Code unten nicht länger von Hand eingefügt werden.

Füge folgendes zur MediaWiki:Common.css hinzu:

/* make the Cite extension list of references look smaller and highlight clicked reference in blue */
ol.references { font-size: 90%; }
ol.references li:target { background-color: #ddeeff; }
sup.reference:target { background-color: #ddeeff; }

Programmierschnittstelle – API[edit]

Eine API ist verfügbar, falls wie folgt korrekt konfiguriert:

$wgCiteCacheRawReferencesOnParse = true;
$wgCiteStoreReferencesData = true;

Eine Raw JSON für eine bestimmte Seite wird dann zugreifbar über: /wiki/Special:ApiSandbox?useformat=desktop#action=query&format=json&prop=references&titles=Doctor+Who

Ein Purge für bereits bestehende Seiten ist erforderlich, damit dies funktioniert.

Siehe auch[edit]