Extension:Cite

This page is about the extension. See also the help on footnotes and the help on citing for how to use it.

This extension comes with MediaWiki 1.21 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

Starting with MediaWiki 1.25 the "Special:Cite" functionality that used to be documented on this page too is no longer part of the "Cite" extension. When upgrading from MediaWiki 1.24 the following line will have to be removed from your "LocalSettings.php" file:

require_once "$IP/extensions/Cite/SpecialCite.php";

The "Special:Cite" extension is now known as the CiteThisPage extension and may be installed separately.

Podręcznik rozszerzeń MediaWiki

Cite Status wydania: stabilne
Realizacja	Tag
Opis	Allows footnotes for citing sources and helps for correctly citing content in offline media
Autor(zy)	Ævar Arnfjörð Bjarmasontalk
Ostatnia wersja	continuous updates
MediaWiki	1.25+
PHP	5.4+
Zmiany w bazie danych	Nie
Licencja	GNU General Public License 2.0 or later
Pobieranie	Pobierz snapshot Git [?]: Pobierz Git master przeglądaj repozytorium (GitHub) historia wprowadzeń ocena kodu
Przykład	Wikipedia:Footnotes
Użyte haki BeforePageDisplay Debug ParserBeforeTidy ParserClearState ParserFirstCallInit ParserGetVariableValueTs ParserGetVariableValueVarCache SkinTemplateBuildNavUrlsNav_urlsAfterPermalink SkinTemplateToolboxEnd User
Przetłumacz rozszerzenie Cite jeżeli jest dostępne na translatewiki.net
Sprawdź wykorzystywanie i matrycę wersji.
Problemy	Otwarte zadania · Zgłoś błąd

The Cite extension allows a user to create references as footnotes on a page. It adds two parser hooks to MediaWiki, <ref> and <references />; these operate together to add citations to pages.

Pobieranie

The extension can be retrieved directly from Git ^[?]:

• Browse code
• Some extensions have tags for stable releases.
  • Browse tags
  • Select the tag
  • Click "snapshot"
• Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
  • Browse branches
  • Select a branch name
  • Click "Continue"

Extract the snapshot and place it in the extensions/Cite/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

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

Instalacja

• Jeżeli korzystasz z Vagrant , zainstaluj poprzez vagrant roles enable cite --provision

Ręczna instalacja

• Pobierz i umieść plik(i) w katalogu o nazwie Cite w swoim katalogu extensions/.

• Dodaj poniższy kod na dole swojego pliku LocalSettings.php:

  wfLoadExtension( 'Cite' );
  

•  Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Użycie

The basic concept of the <ref> tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section, which you indicate with the placeholder tag <references />. This format cannot be used interchangeably with the older format — you must pick one or the other.

Additional placeholder tags <references /> can be inserted in the text, and all <ref> tags up to that point will be inserted there.

If you forget to include <references /> in the article, the footnotes will not disappear, but the references will be displayed at the end of the page.

This page itself uses footnotes, such as the one at the end of this sentence. If you view the source of this page by clicking "Edit this page", you can see a working example of footnotes.

Wikitekst	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> ==Notes== <references />	The Sun is pretty big. The Moon, however, is not so big. Notes

Multiple uses of the same footnote

To give a footnote a unique identifier, use <ref name="name">. You can then refer to the same footnote again by using a ref tag with the same name. The text inside the second tag doesn't matter, because the text already exists in the first reference. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: <ref name="name" />.

In the following example, the same source is cited three times.

Wikitekst

Wynik

This is an example of multiple references to the same footnote.<ref name="multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.</ref> Such references are particularly useful when citing sources, if different statements come from the same source.<ref name="multiple" /> Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role. A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags.<ref name="multiple" /> ==Notes== <references />

This is an example of multiple references to the same footnote. Such references are particularly useful when citing sources, if different statements come from the same source. Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role. A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags. Notes

Note that identifiers used in the name attribute require alphabetic characters; solely relying on numerals will generate an error message.

Merging two texts into a single reference

A typical wikisource issue is, how to merge into one reference texts split into different pages. This can be done using a <ref name="name"> tag for the first part of the reference, and tagging the following parts into different pages with a tag <ref follow="name">.

Here an example, deriving the text used into previous section:

Wikitekst

Rendering

This is an example of merging multiple texts into the same footnote.<ref name="main">Remember that all the texts will be included into the reference containing the ''name='' attribute.<br /></ref> <ref follow="main">Simply include the text to be merged into the first <ref name="main"> reference with a tag <ref follow="name"><br />This paragraph is included into a similar tag and it will be merged into the reference in former paragraph.</ref> == Przypisy == <references/>

This is an example of merging multiple texts into the same footnote. Przypisy

When using this syntax into Page: namespace, take care that the ref follow part of the footnote is transcluded too into the same ns0 page, where the first part of footnote is transcluded. Use appropriately section tags to get this result. To also remind users that reference names should not solely be numbers, eg. <ref name="p32"> and <ref follow="p32">.

The <references /> tag

The <references /> tag inserts the text of all the citations which have defined in <ref> tags up to that point in the page. For example, based on the citations above, there should be reference for the note group.

Wikitekst	Wynik
<references group="note"/>

In some language editions of Wikipedia, long reference lists may be placed using the template {{Reflist}}, which incorporates <references />. It provides an optional parameter to display the reference list in multiple columns. For instance, the English, Hindi and Interlingua Wikipedias use the CSS selector references-small to make the reference text smaller than normal text.

If a page includes more than one <references /> list, each list includes the <ref> tags defined after the previous references list. If these references lists are produced by templates, each one lists the ref tags defined before the first references list, and there is an error message saying that there is a ref tag but not a references list.

Grouped references

This may be disabled by $wgAllowCiteGroups = false; if desired.

The following example generates separate reference lists for citations and miscellaneous footnotes:

Wikitekst	Wynik
According to scientists, the Sun is pretty big <ref>E. Miller, ''The Sun'', (New York: Academic Press, 2005), 23-5.</ref> In fact, it is very big <ref group="footnotes"> Take their word for it. Don't look directly at the sun!</ref> ==Notes== <references group="footnotes" /> == Przypisy == <references />	According to scientists, the Sun is pretty big In fact, it is very big Notes Przypisy

The anonymous group works as before, while references destined for the named group will only show up in the designated <references /> element.

Separating references from text

In-text references make it easy to copy the text to another page; on the other hand, they make it hard to read. References containing a lot of data, quotes or elaborate citation templates can make up a significantly larger fraction of the source than the text that will actually be visible. To avoid this, recent versions of the extension allow moving some or all of the references into the <references /> section, to the place where they will actually appear to the reader.

Wikitekst	Wynik
According to scientists, the Sun is pretty big.<ref name="miller" /> The Moon, however, is not so big.<ref name="smith" /> ==Notes== <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>	According to scientists, the Sun is pretty big. The Moon, however, is not so big. Notes

Thus, the code above will have the same output as the first example above, although the numbering and order of the references will not in general be the same.

Substitution and embedded parser functions

Since Cite's <ref> tag is parsed before MediaWiki's parser functions (e.g. {{#ifexpr:…}}) or variables (e.g. {{PAGENAME}}) or before subst:, these will not work inside of citation references. Instead, you have to use the magic word {{#tag:…}}.

Wikitekst	Wynik
Foo <ref>This is not working, see {{cite journal|url=https://www.google.com |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}</ref> bar baz… Foo{{#tag:ref| Whereas this does, see {{cite journal|url=https://www.google.com |title=Search |author= |date= |accessdate={{subst:#time:Y-m-d|now}}}}}} bar baz… <references />	Foo bar baz… Foo bar baz…

Dostosowywanie

The format of the output of <ref> and <references> is almost completely customizable through MediaWiki messages, that can be modified, for example, through the MediaWiki namespace depending on the configuration of the wiki.

For a list of messages that control the output of <ref> and <references> and the values, if any, that are passed to them ($1, $2, $3 ...), see here for an up-to-date listing of their default contents.

Incomplete list

• 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

Set references to use ^ and letters

To replace the default uparrow (↑) with caret (^), modify the following system messages. All of these pages can be found on Special:Allmessages.

MediaWiki:Cite references link one

Z	Na
<li id="$1">[[#$2|↑]] $3</li>	<li id="$1">[[#$2|^]] $3</li>

MediaWiki:Cite references link many

Z	Na
<li id="$1">↑ $2 $3</li>	<li id="$1">^ $2 $3</li>

MediaWiki:Cite references link many format

Putting $3 between the  tags changes the links from 1.0, 1.1, 1.2 to a, b, c etc…

Z	Na
[[#$1|<sup>$2</sup>]]	[[#$1|<sup>$3</sup>]]

Searching for these 3 pages for the first time will result in no matches. Simply click "Create this page" to edit the code. The changes will not show up until a page with references is rebuilt.

Set reference and reference number highlighting

Starting with MW 1.26 the selectors for highlighting are now incorporated into Cite/modules/ext.cite.css. Thus the CSS code below no longer needs to be added manually.

Add the following code to the MediaWiki:Common.css page.

/* 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; }

API

An API is available when correctly configured by the following.

$wgCiteCacheRawReferencesOnParse = true;
$wgCiteStoreReferencesData = true;

a Raw JSON for a given page will now be accessible via: /wiki/Special:ApiSandbox?useformat=desktop#action=query&format=json&prop=references&titles=Doctor+Who

You will need to purge existing pages for this to become available.

Zobacz też

• Help:Extension:Cite
• Extension:HarvardReferences (compatible)
• Extension:Semantic Cite